public interface IUserMechanics extends IPrincipalMechanics
COMMENTS_LINK_TYPE, CONTENT_LINK_TYPE, DEFAULT_ORDER, DEFAULT_PAGE_SIZE, DEFAULT_SORT, DETAILS_LINK_TYPE, LARGE_ICON_TYPE, LINK_TYPE, LINK_TYPE_COMMENTS, LINK_TYPE_CONTENT, LINK_TYPE_DETAILS, LINK_TYPE_EDIT, LINK_TYPE_HELP, LINK_TYPE_HELP_MAXIMIZED, LINK_TYPE_MAXIMIZED, LINK_TYPE_MINIMIZED, LINK_TYPE_PERMISSIONS, LINK_TYPE_PORTAL_CONTENT, LINK_TYPE_PORTLET_STANDALONE, LINK_TYPE_PROPERTIES, LINK_TYPE_RESTORED, LINK_TYPE_SUBSCRIPTIONS, LINK_TYPE_THUMBNAILS, LINK_TYPE_VERSIONS, PERMISSIONS_LINK_TYPE, PORTAL_CONTENT_LINK_TYPE, PROPERTIES_LINK_TYPE, PROPERTY_LINK_TARGET, PROPERTY_OWNER_NAME, PROPERTY_PARENT_NAME, PROPERTY_TOOLTIP, REFERENCE_ICON_TYPE, SUBSCRIPTIONS_LINK_TYPE, THUMBNAIL_ICON_TYPE, THUMBNAILS_LINK_TYPE, VERSIONS_LINK_TYPE
Modifier and Type | Method and Description |
---|---|
void |
fireUserLoginEvent(IThingID userID,
int action)
Fire a user login event.
|
void |
fireUserLoginEvent(IThingID userID,
int action,
String remoteAddr)
Fire a user login event.
|
int |
getPageSize(IThingID userID)
Number of items displayed per page in a standard listing preferred by the user.
|
IThingID |
getUserFavoritesFolder(IThingID userID)
User's My Favorites folder.
|
IThingID |
getUserHomeFolder(IThingID userID)
Root folder of user's visible private folder hierarchy (ie My Stuff).
|
IThingID |
getUserPrivateFolder(IThingID userID)
User's Private folder.
|
IThingID |
getUserRootFolder(IThingID userID)
Root folder of user's private folder hierarchy
(ie parent of My Stuff and Scrapbook).
|
IThingID |
getUserSearchesFolder(IThingID userID)
User's Saved Searches folder.
|
IThingID |
getUserSkin(IThingID userID)
Portal skin preferred by the user.
|
IThingID |
getUserStartPage(IThingID userID)
User's home page.
|
void |
setPageSize(IThingID userID,
int pageSize)
Number of items displayed per page in a standard listing preferred by the user.
|
void |
setUserSkin(IThingID userID,
IThingID skinID)
Portal style preferred by the user.
|
void |
setUserStartPage(IThingID userID,
IThingID startPageID)
User's home page.
|
checkAccess, fireDNUpdationEventEvent, fireRoleMembershipEvent, fireRoleMembershipEvent, getGroupMembership, getMembers, getPrincipalThingID, getPrincipalURI, getRoleMembership, hasAccess
createPagingCookie
canView, checkView, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, isEnabled, view, view
getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider
init, shutdown
int getPageSize(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
void setPageSize(IThingID userID, int pageSize) throws PortalException
userID
- User to whom the setting applies.pageSize
- Number of items displayed per page. Zero to indicate default.PortalException
IThingID getUserSkin(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
void setUserSkin(IThingID userID, IThingID skinID) throws PortalException
userID
- User to whom the setting applies.skinID
- Portal skin. Null to indicate default.PortalException
IThingID getUserStartPage(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
void setUserStartPage(IThingID userID, IThingID startPageID) throws PortalException
userID
- User to whom the setting appliesstartPageID
- User's home page. Null to indicate default.PortalException
IThingID getUserRootFolder(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
IThingID getUserHomeFolder(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
IThingID getUserFavoritesFolder(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
IThingID getUserSearchesFolder(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
IThingID getUserPrivateFolder(IThingID userID) throws PortalException
userID
- User to whom the setting applies.PortalException
void fireUserLoginEvent(IThingID userID, int action) throws PortalException
userID
- the userIDaction
- the action, taken from ILoginEvent
PortalException
void fireUserLoginEvent(IThingID userID, int action, String remoteAddr) throws PortalException
userID
- the userIDaction
- the action, taken from ILoginEvent
remoteAddr
- the IP address of the client that sent the requestPortalException