com.sssw.portal.api
Interface EbiSharedPageInfo

All Superinterfaces:

EbiPageLayoutInfo

public interface EbiSharedPageInfo

extends EbiPageLayoutInfo

This interface is used to manage the Shared Page page information of a specific portal app.

Field Summary

static String

EL_PORTAL_SHARED_PAGE Portal Shared Page element type

Method Summary

String	getParentPageName() Gets the name of this page's parent (if any).
int	getPriority() Gets the priority of the page - typically used for display purposes.
String	getSharedPageUUID() Gets the Shared Page UUID.
String	getStyleID() Gets the ID of the stylesheet used to render this page (if any).
boolean	isPageHidden() Sets the name of the parent page.
void	setIsPageHidden(boolean hidden) Sets the page to be hidden.
void	setParentPageName(String pageName) Sets the name of the parent page.
void	setPriority(int priority) Sets the priority of the page - typically used for display purposes Note: the priority should be a non-negative number
void	setStyleID(String styleID) Sets the style to be used to render this page.

Methods implemented from interface com.sssw.portal.api.EbiPageLayoutInfo

addComponent, addComponent, cloneCopy, cloneCopy, getAllowedSectionIDs, getComponentsBySection, getDescription, getDisplayName, getPageLayoutType, getPageName, getPortalID, getPortalLayoutID, getSectionIDs, getSelectedComponentsXML, removeComponent, removeComponent, setDescription, setDisplayName, setPageName, setPortalID, setPortalLayoutID, setPortalLayoutID, updateSectionComponents, validateLayout

Field Detail

EL_PORTAL_SHARED_PAGE

public static final String EL_PORTAL_SHARED_PAGE

Portal Shared Page element type

Method Detail

getSharedPageUUID

public String getSharedPageUUID()

Gets the Shared Page UUID.

Returns:

the Shared Page UUID.

getParentPageName

public String getParentPageName()

Gets the name of this page's parent (if any).

Returns:

the parent page name.

setParentPageName

public void setParentPageName(String pageName)

Sets the name of the parent page.

Parameters:

pageName - a page name.

setIsPageHidden

public void setIsPageHidden(boolean hidden)

Sets the page to be hidden. Note: Not automatically hidden - the UI needs to take advantage of this property to hide the page in any list.

Parameters:

hidden - the page is hidden

isPageHidden

public boolean isPageHidden()

Sets the name of the parent page.

Returns:

the hidden property of the page

getStyleID

public String getStyleID()

Gets the ID of the stylesheet used to render this page (if any).

Specified by:

getStyleID in interface EbiPageLayoutInfo

Returns:

the stylesheet ID

setStyleID

public void setStyleID(String styleID)

Sets the style to be used to render this page.

Parameters:

styleID -

getPriority

public int getPriority()

Gets the priority of the page - typically used for display purposes. Note: If no priority has been set on this page, -1 will be returned

Returns:

the priority

setPriority

public void setPriority(int priority)

Sets the priority of the page - typically used for display purposes Note: the priority should be a non-negative number

Parameters:

priority - any number (e.g. 0, 10, 20)