Package com.webmethods.portal.mech.dir

Interface IUserMechanics

All Superinterfaces:

IComponent, IInitializable, IMechanics, IPrincipalMechanics, ISystemHandler, IViewableContainerMechanics, IViewableMechanics

public interface IUserMechanics
extends IPrincipalMechanics

Handles user specific operations for both IUser and IDirUser

Field Summary

Fields inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

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

Method Summary

Modifier and Type	Method	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.

Methods inherited from interface com.webmethods.portal.system.IComponent

getComponentData, getComponentName, getComponentProvider, getURI, isInitialized, setComponentData, setComponentProvider

Methods inherited from interface com.webmethods.portal.system.init.IInitializable

init, shutdown

Methods inherited from interface com.webmethods.portal.mech.dir.IPrincipalMechanics

checkAccess, fireDNUpdationEventEvent, fireGroupMembershipEvent, fireGroupMembershipEvent, fireRoleMembershipEvent, fireRoleMembershipEvent, getGroupMembership, getMembers, getPrincipalThingID, getPrincipalURI, getRoleMembership, hasAccess

Methods inherited from interface com.webmethods.portal.mech.view.IViewableContainerMechanics

createPagingCookie

Methods inherited from interface com.webmethods.portal.mech.view.IViewableMechanics

canView, checkView, fireViewEvent, getCss, getCss, getDefaultLinkType, getFormattedProperty, getHierachicalUri, getIcon, getIcon, getLink, getLink, getListProperty, getListPropertyHTML, getListPropertyJS, isEnabled, view, view

Method Details

getPageSize

int getPageSize(IThingID userID)
         throws PortalException

Number of items displayed per page in a standard listing preferred by the user. Returns zero to indicate the default (ie no preference).

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

setPageSize

void setPageSize(IThingID userID,
 int pageSize)
          throws PortalException

Number of items displayed per page in a standard listing preferred by the user.

Parameters:

userID - User to whom the setting applies.

pageSize - Number of items displayed per page. Zero to indicate default.

Throws:

PortalException

getUserSkin

IThingID getUserSkin(IThingID userID)
              throws PortalException

Portal skin preferred by the user. Returns the default skin if user has no preference.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

setUserSkin

void setUserSkin(IThingID userID,
 IThingID skinID)
          throws PortalException

Portal style preferred by the user.

Parameters:

userID - User to whom the setting applies.

skinID - Portal skin. Null to indicate default.

Throws:

PortalException

getUserStartPage

IThingID getUserStartPage(IThingID userID)
                   throws PortalException

User's home page. Returns null to indicate the default (ie no home page).

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

setUserStartPage

void setUserStartPage(IThingID userID,
 IThingID startPageID)
               throws PortalException

User's home page.

Parameters:

userID - User to whom the setting applies

startPageID - User's home page. Null to indicate default.

Throws:

PortalException

getUserRootFolder

IThingID getUserRootFolder(IThingID userID)
                    throws PortalException

Root folder of user's private folder hierarchy (ie parent of My Stuff and Scrapbook). Returns null if it does not exist.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

getUserHomeFolder

IThingID getUserHomeFolder(IThingID userID)
                    throws PortalException

Root folder of user's visible private folder hierarchy (ie My Stuff). Returns null if it does not exist.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

getUserFavoritesFolder

IThingID getUserFavoritesFolder(IThingID userID)
                         throws PortalException

User's My Favorites folder. Returns null if it does not exist.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

getUserSearchesFolder

IThingID getUserSearchesFolder(IThingID userID)
                        throws PortalException

User's Saved Searches folder. Returns null if it does not exist.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

getUserPrivateFolder

IThingID getUserPrivateFolder(IThingID userID)
                       throws PortalException

User's Private folder. Returns null if it does not exist.

Parameters:

userID - User to whom the setting applies.

Throws:

PortalException

fireUserLoginEvent

void fireUserLoginEvent(IThingID userID,
 int action)
                 throws PortalException

Fire a user login event.

Parameters:

userID - the userID

action - the action, taken from ILoginEvent

Throws:

PortalException

fireUserLoginEvent

void fireUserLoginEvent(IThingID userID,
 int action,
 String remoteAddr)
                 throws PortalException

Fire a user login event.

Parameters:

userID - the userID

action - the action, taken from ILoginEvent

remoteAddr - the IP address of the client that sent the request

Throws:

PortalException