com.sssw.portal.api
Interface EbiUserPortalInfo

public interface EbiUserPortalInfo

This interface manages portal settings for a portal application related to a user.

Field Summary

static String	EL_PORTAL_USER_PORTAL user portal info element type
static String	NO_GROUP_PAGE this definition is used to be set in the group page property to indicate that no group page is to be associated with the user page.

Method Summary

String	getDefaultContainerPageName() Gets the user's default container page name for the portal.
String	getDefaultPageName() Gets the user's default page (user or shared).
String	getDefaultUserPageName() Gets the default user page name for the portal app for the user.
String	getGroupPageName() Gets the group page name for the portal app that will always be shown with a user page.
String	getPortalID() Gets Portal ID for the portal app.
String	getThemeID() Gets the theme ID selected for the portal app for the user.
String	getUserUUID() Gets User UUID.
void	setDefaultContainerPageName(String containerPageName) Sets the user's default container page.
void	setDefaultPageName(String pageName) Sets the user's default page (Shared page).
void	setDefaultPageName(String pageName, boolean isUserPage) Sets the user's default page (Shared or User page).
void	setDefaultUserPageName(String userPageName) Sets the default user page.
void	setGroupPageName(String groupPageName) Sets the group page that is always shown with a user page.
void	setPortalID(String portalID) Sets the Portal ID for the portal app.
void	setThemeID(String themeID) Sets the theme ID selected for the portal app for the user.
void	setUserUUID(String userIID) Sets User UUID.

Field Detail

EL_PORTAL_USER_PORTAL

public static final String EL_PORTAL_USER_PORTAL

user portal info element type

NO_GROUP_PAGE

public static final String NO_GROUP_PAGE

this definition is used to be set in the group page property to indicate that no group page is to be associated with the user page.

Method Detail

getUserUUID

public String getUserUUID()

Gets User UUID.

Returns:

a user UUID.

getPortalID

public String getPortalID()

Gets Portal ID for the portal app.

Returns:

a portal ID

getThemeID

public String getThemeID()

Gets the theme ID selected for the portal app for the user.

Returns:

a theme identifier

getDefaultContainerPageName

public String getDefaultContainerPageName()

Gets the user's default container page name for the portal.

Returns:

the container page name.

getDefaultPageName

public String getDefaultPageName()

Gets the user's default page (user or shared).

Returns:

the page name.

setDefaultPageName

public void setDefaultPageName(String pageName)

Sets the user's default page (Shared page). Note: Use setDefaultPageName(String pageName, boolean isUserPage) to set the default page as a User Page.

Parameters:

pageName - the name of the shared page

setDefaultPageName

public void setDefaultPageName(String pageName,
                               boolean isUserPage)

Sets the user's default page (Shared or User page).

Parameters:

pageName - the name of the page

isUserPage - true: the page is a user page else its a shared page

getGroupPageName

public String getGroupPageName()

Gets the group page name for the portal app that will always be shown with a user page. This method may return NO_GROUP_PAGE which indicate that there will be no group page shown with the a user page.

Returns:

the group page name.

getDefaultUserPageName

public String getDefaultUserPageName()

Gets the default user page name for the portal app for the user.

Returns:

the default user page name.

setUserUUID

public void setUserUUID(String userIID)

Sets User UUID.

Parameters:

userIID - a user UUID.

setPortalID

public void setPortalID(String portalID)

Sets the Portal ID for the portal app.

Parameters:

portalID - a portal ID

setThemeID

public void setThemeID(String themeID)

Sets the theme ID selected for the portal app for the user.

Parameters:

themeID - a theme ID.

setDefaultUserPageName

public void setDefaultUserPageName(String userPageName)

Sets the default user page.

Parameters:

userPageName - a user page name.

setDefaultContainerPageName

public void setDefaultContainerPageName(String containerPageName)

Sets the user's default container page.

Parameters:

containerPageName - a container page name.

setGroupPageName

public void setGroupPageName(String groupPageName)

Sets the group page that is always shown with a user page. If NO_GROUP_PAGE is passed in, the presentation manager will not combine any group page with the specified user page.

Parameters:

groupPageName - a group page name.