com.sssw.portal.api
Interface EbiPortalManager

public interface EbiPortalManager

This provides an interface for the portal manager. This portal manager provides portal default settings and manages user/group related portal page and user component preference information.

Method Summary

void	addContainerPageInfo(EbiPortalContext context, EbiContainerPageInfo info) Adds a container page to the datastore
void	addContainerPageToCategory(EbiPortalContext context, String pageName, String categoryID) Adds a container page to a page category.
void	addGroupPageInfo(EbiPortalContext context, EbiGroupPageInfo info) Deprecated.
void	addPageLayoutInfo(EbiPortalContext context, EbiPageLayoutInfo pageInfo) Adds a new page layout info.
void	addSharedPageInfo(EbiPortalContext context, EbiSharedPageInfo info) Adds a shared page info.
void	addSharedPageToCategory(EbiPortalContext context, String pageName, String categoryID) Adds a shared page to a page category.
void	addUserComponentInfo(EbiPortalContext context, EbiUserComponentInfo userCompInfo) Adds a user component info for a specified user and component instance.
void	addUserPageInfo(EbiPortalContext context, EbiUserPageInfo pageInfo) Adds a user page info.
void	addUserPortalInfo(EbiPortalContext context, EbiUserPortalInfo portalInfo) Adds a user portal info.
EbiContainerPageInfo	createContainerPageInfo(EbiPortalContext context) Creates a new container page info object.
EbiGroupPageInfo	createGroupPageInfo(EbiPortalContext context) Deprecated.
EbiPageLayoutInfo	createPageLayoutInfo(EbiPortalContext context, String elemType) Creates a new page layout info.
EbiSharedPageInfo	createSharedPageInfo(EbiPortalContext context) Creates a new shared page info object.
EbiUserComponentInfo	createUserComponentInfo() Creates a new user component info object.
EbiUserComponentInfo	createUserComponentInfo(EbiPortalContext context) Creates a new user component info object.
EbiUserPageInfo	createUserPageInfo() Creates a new user page info object.
EbiUserPageInfo	createUserPageInfo(EbiPortalContext context) Creates a new user page info object.
EbiUserPortalInfo	createUserPortalInfo(EbiPortalContext context) Creates a new user portal info object.
EbiCategoryInfo	getContainerPageCategoryInfo(EbiPortalContext context, String category) Gets a container page category info.
EbiCategoryInfo	getContainerPageCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) Gets a container page category info.
EbiCategoryInfo[]	getContainerPageCategoryInfoList(EbiPortalContext context) Gets a list of container page category infos.
EbiContainerPageInfo	getContainerPageInfo(EbiPortalContext context, String pageName) Gets a particular Container Page defined for a web application for the authenticated user of the current portal context.
EbiContainerPageInfo[]	getContainerPageInfoList(EbiPortalContext context) Gets a list of Container Pages defined for a web application for the authenticated user of the current portal context.
EbiContainerPageInfo[]	getContainerPageInfoListByCategory(EbiPortalContext context, String categoryID) Gets a list of EbiContainerPageInfo objects for container pages by category ID that the authenticated user from EbiPortalContext is allowed to access.
EbiContainerPageInfo[]	getContainerPageInfoListByCategory(EbiPortalContext context, String userID, String categoryID) Gets a list of EbiContainerPageInfo objects for container pages by category ID that the user, 'userID' is allowed to access.
EbiContainerPageInfo[]	getContainerPageInfoListByOwner(EbiPortalContext context, String userIID) Returns the list of container pages that the current user has WRITE permission to.
EbiContainerPageInfo[]	getContainerPageInfoListByUser(EbiPortalContext context, String userIID) Gets a container page info list for the container pages that are readable by a specified user.
EbiGroupPageInfo	getGroupPageInfo(EbiPortalContext context, String groupPageName) Deprecated.
EbiGroupPageInfo[]	getGroupPageInfoList(EbiPortalContext context) Deprecated.
EbiGroupPageInfo[]	getGroupPageInfoListByUser(EbiPortalContext context, String userIID) Deprecated.
String	getLoginPage(EbiPortalContext context) Gets the value of the portal login page from the context param "PortalLoginPage"
String	getLoginPageURL(EbiPortalContext context) Gets the URL of the portal login page
int	getMaxTimeOut(EbiPortalContext context) Gets the maximum time in milliseconds that the portal should wait for any portlet to complete its request.
String	getNewUserPage(EbiPortalContext context) Gets the value of the portal user page from the context param "NewUserPage"
String	getNewUserPageURL(EbiPortalContext context) Gets the URL of the portal new user page
EbiPageLayoutInfo	getPageLayoutInfo(EbiPortalContext context, String pageName, String elemType) Gets a page layout info object.
String	getPageType(EbiPageLayoutInfo pageInfo) Get's the page type (User or Shared) of a particular page.
String	getPageType(String pageName) Get's the page type (User or Shared) of a particular page.
String	getPortalControllerServletPath(EbiPortalContext context) Gets the portal controller's servlet path.
String	getPortalDecoratorStyle(EbiPortalContext context) Gets the portal decorator stylesheet used to decorate portlets (i.e.
String	getPortalDefaultContainerPage(EbiPortalContext context) Gets the portal's default container page name.
String	getPortalDefaultGroupPage(EbiPortalContext context) Deprecated.
String	getPortalDefaultLayout(EbiPortalContext context) Gets the portal default layout.
String	getPortalDefaultSharedPage(EbiPortalContext context) Gets the portal's default shared page name.
String	getPortalDefaultStyle(EbiPortalContext context) Gets the portal default style ID.
String	getPortalDefaultTheme(EbiPortalContext context) Gets the portal default theme.
String	getPortalHomePage(EbiPortalContext context) Gets the value of the portal home page from the context param "PortalHomePage"
String	getPortalHomePageURL(EbiPortalContext context) Gets the URL of the portal home page
String	getPortalID() Gets the portal ID for this portal manager instance.
String	getPortalPageXSLT(EbiPortalContext context) Gets the ID of the style sheet which is used to render the base portal page.
String	getPortalPathCompKey(EbiPortalContext context) Gets the component key that is used in portal path for components.
String	getPortalPathComponentKey(EbiPortalContext context) Gets the component key that is used in portal path for components.
String	getPortalPathContainerPageKey(EbiPortalContext context) Gets the container page key that is used in portal path to serve up container pages.
String	getPortalPathEntryPointKey(EbiPortalContext context) Gets the key used as the entry point into the portal.
String	getPortalPathMyPortalKey(EbiPortalContext context) Gets the myportal key that is used in the portal path for mypage. Example: ...\main\MyPortal\MyFinancePage
String	getPortalPathPageContainerKey(EbiPortalContext context) Gets the key used to server up a specific portal page with the user's current container page.
String	getPortalPathPageKey(EbiPortalContext context) Gets the page key that is used in portal path to serve up user and shared pages.
String	getPortalPathPagesKey(EbiPortalContext context) Gets the pages key that is used in the portal path for portal PIDs (static pages from the resource set). Example: ...\main\page\DevHome.html
String	getPortalPathPortletKey(EbiPortalContext context) Gets the portlet key that is used in portal path for portlets.
String	getPortalResourcePath(EbiPortalContext context) Gets the value of the portal user page from the context param "PortalResourcePath"
String	getPortalResourceURL(EbiPortalContext context) Gets the URL of the portal resource servlet
EbiCategoryInfo	getSharedPageCategoryInfo(EbiPortalContext context, String category) Gets a Shared page category info.
EbiCategoryInfo	getSharedPageCategoryInfo(EbiPortalContext context, String categoryName, boolean flush) Gets a Shared page category info.
EbiCategoryInfo[]	getSharedPageCategoryInfoList(EbiPortalContext context) Gets a list of Shared page category infos.
EbiSharedPageInfo	getSharedPageInfo(EbiPortalContext context, String sharedPageName) Gets a shared page info for the authenticated user from the current portal context.
EbiSharedPageInfo[]	getSharedPageInfoList(EbiPortalContext context) Gets a list of Shared Pages defined for a web application for the authenticated user of the current portal context.
EbiSharedPageInfo[]	getSharedPageInfoListByCategory(EbiPortalContext context, String categoryID) Gets a list of EbiSharedPageInfo objects for shared pages by category ID that the authenticated user from EbiPortalContext is allowed to access.
EbiSharedPageInfo[]	getSharedPageInfoListByCategory(EbiPortalContext context, String userID, String categoryID) Gets a list of EbiSharedPageInfo objects for shared pages by category ID that the user, 'userID' is allowed to access.
EbiSharedPageInfo[]	getSharedPageInfoListByOwner(EbiPortalContext context, String userIID) Gets a shared page info list for the shared pages that are writeable by a specified user.
EbiSharedPageInfo[]	getSharedPageInfoListByUser(EbiPortalContext context, String userIID) Gets a shared page info list for the shared pages that are readable by a specified user.
EbiUserComponentInfo	getUserComponentInfo(EbiPortalContext context, String componentName) Gets a user component info object that provides info regarding portal component preferences of a specified component instance for the authenticated user.
EbiUserComponentInfo	getUserComponentInfo(EbiPortalContext context, String userIID, String componentName) Gets a user component info object that provides info regarding portal component preferences of a specified component instance for a specified user.
EbiUserComponentInfo[]	getUserComponentInfoList(EbiPortalContext context) Gets the user component info list for the current authenticated user.
EbiUserComponentInfo[]	getUserComponentInfoList(EbiPortalContext context, String userIID) Gets the user component info list for a specified user.
EbiUserPageInfo	getUserPageInfo(EbiPortalContext context, String userPageName) Gets a user page info object that provides portal page information of a specified user page for the current authenticated user.
EbiUserPageInfo	getUserPageInfo(EbiPortalContext context, String userIID, String userPageName) Gets a user page info object that provides portal page information of a specified user page for a specified user.
EbiUserPageInfo[]	getUserPageInfoList(EbiPortalContext context) Gets user page info list for the authenticated user from the current security context.
EbiUserPageInfo[]	getUserPageInfoList(EbiPortalContext context, String userIID) Gets user page info list for a specified user.
EbiUserPortalInfo	getUserPortalInfo(EbiPortalContext context) Gets a user portal info object that provides info regarding portal settings for the authenticated user in the current context.
EbiUserPortalInfo	getUserPortalInfo(EbiPortalContext context, String userIID) Gets user portal info for a specified user.
String	getWirelessPageName(EbiPortalContext context) Gets the name of the personal page for wireless devices.
boolean	isValidContainerPage(EbiPortalContext context, String containerPageName) Checks if the specified container page is a valid container page for the authenticated user from the current portal context.
boolean	isValidGroupPage(EbiPortalContext context, String groupPageName) Deprecated.
boolean	isValidPageLayout(EbiPortalContext context, String pageName, String elemType) Check if the page name provided is a valid page layout.
boolean	isValidSharedPage(EbiPortalContext context, String sharedPageName) Checks if the specified shared page is valid for the authenticated user from the current portal context.
boolean	isValidUserPage(EbiPortalContext context, String userPageName) Check if the user page name provided is a valid user page for the current authenticated user.
boolean	isWSRPContainerEnabled(EbiPortalContext context) Indicates whether or not the container that handles WSRP Portlet requests should be enabled.
void	modifyContainerPageInfo(EbiPortalContext context, EbiContainerPageInfo pageInfo) Modifies a container page info.
void	modifyGroupPageInfo(EbiPortalContext context, EbiGroupPageInfo pageInfo) Deprecated.
void	modifyPageLayoutInfo(EbiPortalContext context, EbiPageLayoutInfo pageInfo) Modifies a page layout info.
void	modifySharedPageInfo(EbiPortalContext context, EbiSharedPageInfo pageInfo) Modifies a shared page info.
void	modifyUserComponentInfo(EbiPortalContext context, EbiUserComponentInfo userCompInfo) Modifies a user component info for a specified user and component instance.
void	modifyUserPageInfo(EbiPortalContext context, EbiUserPageInfo pageInfo) Modifies a user page info.
void	modifyUserPortalInfo(EbiPortalContext context, EbiUserPortalInfo portalInfo) Modifies a user portal info.
void	removeAllUserComponentInfos(EbiPortalContext context) Removes all user component info for the authenticated user from the current portal context.
void	removeAllUserComponentInfos(EbiPortalContext context, String userIID) Removes all user component info for a specified user.
void	removeAllUserPageInfos(EbiPortalContext context) Removes all user page info objects for the authenticated user from the current portal context.
void	removeAllUserPageInfos(EbiPortalContext context, String userIID) Removes all user page info objects for a specified user.
void	removeContainerPageFromCategory(EbiPortalContext context, String pageName, String categoryID) Removes a container page from a page category.
void	removeContainerPageInfo(EbiPortalContext context, String containerPageName) Removes a container page info.
void	removeGroupPageInfo(EbiPortalContext context, String groupPageName) Deprecated.
void	removePageLayoutInfo(EbiPortalContext context, String pageName, String elemType) Removes a page layout info.
void	removeSharedPageFromCategory(EbiPortalContext context, String pageName, String categoryID) Removes a shared page from a page category.
void	removeSharedPageInfo(EbiPortalContext context, String sharedPageName) Removes a shared page info.
void	removeUserComponentInfo(EbiPortalContext context, String componentName) Removes a user component info for the authenticated user from the current portal context.
void	removeUserComponentInfo(EbiPortalContext context, String userIID, String componentName) Removes a user component info for a specified user.
void	removeUserPageInfo(EbiPortalContext context, String userPageName) Removes a user page info for the authenticated user from the current portal context.
void	removeUserPageInfo(EbiPortalContext context, String userIID, String userPageName) Removes a user page info for a specified user.
void	removeUserPortalInfo(EbiPortalContext context, String userIID) Removes the user portal info for the specified user.

Method Detail

getPortalID

public String getPortalID()

Gets the portal ID for this portal manager instance.

Returns:

the portal ID for this portal manager instance.

getPortalDefaultTheme

public String getPortalDefaultTheme(EbiPortalContext context)

Gets the portal default theme. This is defined in the web.xml of the portal war.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal default theme.

getPortalDecoratorStyle

public String getPortalDecoratorStyle(EbiPortalContext context)

Gets the portal decorator stylesheet used to decorate portlets (i.e. titlebar, border, options, etc) the portal war.

Parameters:

context - an EbiPortalContext object.

Returns:

the stylesheet used to decorate portlets

getPortalDefaultLayout

public String getPortalDefaultLayout(EbiPortalContext context)

Gets the portal default layout. This is defined in the web.xml of the portal war.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal default layout ID.

getPortalDefaultContainerPage

public String getPortalDefaultContainerPage(EbiPortalContext context)

Gets the portal's default container page name.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal's default container page name.

getPortalDefaultSharedPage

public String getPortalDefaultSharedPage(EbiPortalContext context)

Gets the portal's default shared page name.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal's default shared page name.

getPortalDefaultGroupPage

public String getPortalDefaultGroupPage(EbiPortalContext context)

Deprecated.

Gets the portal default group page name.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal default group page name.

getLoginPageURL

public String getLoginPageURL(EbiPortalContext context)

Gets the URL of the portal login page

Constructed by doing a runtime replacement on the value of the "PortalLoginPage" context param value

Parameters:

context - an EbiPortalContext object.

Returns:

the URL of the portal login page.

getLoginPage

public String getLoginPage(EbiPortalContext context)

Gets the value of the portal login page from the context param "PortalLoginPage"

Parameters:

context - an EbiPortalContext object.

Returns:

the value of the portal login page context param.

getNewUserPageURL

public String getNewUserPageURL(EbiPortalContext context)

Gets the URL of the portal new user page

Constructed by doing a runtime replacement on the value of the "NewUserPage" context param value

Parameters:

context - an EbiPortalContext object.

Returns:

the URL of the portal new user page.

getNewUserPage

public String getNewUserPage(EbiPortalContext context)

Gets the value of the portal user page from the context param "NewUserPage"

Parameters:

context - an EbiPortalContext object.

Returns:

the value of the portal new user page context param.

getWirelessPageName

public String getWirelessPageName(EbiPortalContext context)

Gets the name of the personal page for wireless devices. Note: This name will be encode ti the personal page prefix (e.g. up_YouPageName)

Parameters:

context - an EbiPortalContext object.

Returns:

the value of the PortalWirelessPage web.xml context param.

getPortalHomePageURL

public String getPortalHomePageURL(EbiPortalContext context)

Gets the URL of the portal home page

Constructed by doing a runtime replacement on the value of the "PortalHomePage" context param value

Parameters:

context - an EbiPortalContext object.

Returns:

the URL of the portal new user page.

getPortalHomePage

public String getPortalHomePage(EbiPortalContext context)

Gets the value of the portal home page from the context param "PortalHomePage"

Parameters:

context - an EbiPortalContext object.

Returns:

the value of the portal home page context param.

getPortalDefaultStyle

public String getPortalDefaultStyle(EbiPortalContext context)

Gets the portal default style ID.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal default style ID.

getPortalPathEntryPointKey

public String getPortalPathEntryPointKey(EbiPortalContext context)

Gets the key used as the entry point into the portal. This is the key used in the URL for all portal requests to such things as shared pages, user pages, etc.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path entry point key.

getPortalPathPageKey

public String getPortalPathPageKey(EbiPortalContext context)

Gets the page key that is used in portal path to serve up user and shared pages.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path page key.

getPortalPathContainerPageKey

public String getPortalPathContainerPageKey(EbiPortalContext context)

Gets the container page key that is used in portal path to serve up container pages.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path container page key.

getPortalPathPageContainerKey

public String getPortalPathPageContainerKey(EbiPortalContext context)

Gets the key used to server up a specific portal page with the user's current container page.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path page with container key.

getPortalPathPortletKey

public String getPortalPathPortletKey(EbiPortalContext context)

Gets the portlet key that is used in portal path for portlets.

Example: ...\main\portlet\PhoneListPortlet Note: The data returned is the raw data from the component (no decorations, titlebar, etc)

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path portlet key.

getPortalPathCompKey

public String getPortalPathCompKey(EbiPortalContext context)

Gets the component key that is used in portal path for components.

Example: ...\main\comp\PhoneListComponent Note: The data returned is the raw data from the component (no decorations, titlebar, etc)

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path component key.

getPortalPathComponentKey

public String getPortalPathComponentKey(EbiPortalContext context)

Gets the component key that is used in portal path for components.

Example: ...\main\component\PhoneListComponent Note: The data returned is the component's data decorated with a possible titlebar. The page will have the appropriate markeup for the device (HTML, HEAD, etc).

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path component key.

getPortalPathPagesKey

public String getPortalPathPagesKey(EbiPortalContext context)

Gets the pages key that is used in the portal path for portal PIDs (static pages from the resource set).
Example: ...\main\page\DevHome.html

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path pages key.

getPortalPathMyPortalKey

public String getPortalPathMyPortalKey(EbiPortalContext context)

Gets the myportal key that is used in the portal path for mypage.
Example: ...\main\MyPortal\MyFinancePage

Parameters:

context - an EbiPortalContext object.

Returns:

the portal path my portal key.

getPortalPageXSLT

public String getPortalPageXSLT(EbiPortalContext context)

Gets the ID of the style sheet which is used to render the base portal page. See the style PortalPage.xsl in the resourceset/data/portal-style for details.

Parameters:

context - an EbiPortalContext object.

Returns:

the ID pf the style sheet.

getPortalResourceURL

public String getPortalResourceURL(EbiPortalContext context)

Gets the URL of the portal resource servlet

Constructed by doing a runtime replacement on the value of the "PortalResourcePath" context param value

Parameters:

context - an EbiPortalContext object.

Returns:

the URL of the portal resource servlet

getPortalResourcePath

public String getPortalResourcePath(EbiPortalContext context)

Gets the value of the portal user page from the context param "PortalResourcePath"

Parameters:

context - an EbiPortalContext object.

Returns:

the value of the portal resource path context param.

getPortalControllerServletPath

public String getPortalControllerServletPath(EbiPortalContext context)

Gets the portal controller's servlet path.

Parameters:

context - an EbiPortalContext object.

Returns:

the portal controller's servlet path.

getMaxTimeOut

public int getMaxTimeOut(EbiPortalContext context)

Gets the maximum time in milliseconds that the portal should wait for any portlet to complete its request.

Parameters:

context - an EbiPortalContext object.

Returns:

int number of milliseconds the portal should wait for any portlet to complete its request. Defaults to 0 to mean that no timeout will be applied.

isWSRPContainerEnabled

public boolean isWSRPContainerEnabled(EbiPortalContext context)

Indicates whether or not the container that handles WSRP Portlet requests should be enabled. This is a configuration flag that indicates to the portal that is should run the container. It does not actually indicate the status of the container, that is, that the container is indeed functional and running.

Parameters:

context - an EbiPortalContext object.

Returns:

boolean true if the WSRP Portlet container is configured to be enabled. Defaults to true if no configuration value was specified.

getUserPortalInfo

public EbiUserPortalInfo getUserPortalInfo(EbiPortalContext context)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Gets a user portal info object that provides info regarding portal settings for the authenticated user in the current context.

Parameters:

context - a context object that contains session/user info.

Returns:

an EbiUserPortalInfo object.

getUserPortalInfo

public EbiUserPortalInfo getUserPortalInfo(EbiPortalContext context,
                                           String userIID)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Gets user portal info for a specified user. Acl based security is enforced to allow user to access the user portal info that belong to him/herself, and allow only user administrators to access any user portal info objects.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID.

Returns:

an EbiUserPortalInfo object.

createUserPortalInfo

public EbiUserPortalInfo createUserPortalInfo(EbiPortalContext context)

Creates a new user portal info object. It sets the portalID and the authenticated user from the context.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiUserPortalInfo object.

addUserPortalInfo

public void addUserPortalInfo(EbiPortalContext context,
                              EbiUserPortalInfo portalInfo)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Adds a user portal info.

Parameters:

context - a portal context object that contains session/user info.

portalInfo - an EbiUserPortalInfo object.

modifyUserPortalInfo

public void modifyUserPortalInfo(EbiPortalContext context,
                                 EbiUserPortalInfo portalInfo)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Modifies a user portal info. Acl based security is enforced to allow user to modify the user portal info that belong to him/herself, and allow only user administrators to modify any user portal info objects.

Parameters:

context - a portal context object that contains session/user info.

portalInfo - an EbiUserPortalInfo object.

removeUserPortalInfo

public void removeUserPortalInfo(EbiPortalContext context,
                                 String userIID)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Removes the user portal info for the specified user. Acl based security is enforced to allow user to remove the user portal info that belong to him/herself, and allow only user administrators to remove any user portal info objects.

Parameters:

context - a portal context object that contains session/user info.

userIID - a user UUID.

isValidPageLayout

public boolean isValidPageLayout(EbiPortalContext context,
                                 String pageName,
                                 String elemType)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Check if the page name provided is a valid page layout.

Parameters:

context - a context object that contains session/user info.

pageName - a page name for a page layout (either user or group).

elemType - an element type indicating either user or group page

Returns:

true if the page name is a valid layout page, false otherwise.

getPageLayoutInfo

public EbiPageLayoutInfo getPageLayoutInfo(EbiPortalContext context,
                                           String pageName,
                                           String elemType)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Gets a page layout info object.

Parameters:

context - a context object that contains session/user info.

pageName - a page name for a page layout.

elemType - an element type indicating either user or group page

Returns:

an EbiPageLayoutInfo object.

createPageLayoutInfo

public EbiPageLayoutInfo createPageLayoutInfo(EbiPortalContext context,
                                              String elemType)

Creates a new page layout info.

Parameters:

context - an EbiPortalContext object.

elemType - an element type indicating either user or group page

Returns:

a newly created EbiPageLayoutInfo object.

addPageLayoutInfo

public void addPageLayoutInfo(EbiPortalContext context,
                              EbiPageLayoutInfo pageInfo)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Adds a new page layout info.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiPageLayoutInfo object.

modifyPageLayoutInfo

public void modifyPageLayoutInfo(EbiPortalContext context,
                                 EbiPageLayoutInfo pageInfo)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Modifies a page layout info.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiPageLayoutInfo object.

removePageLayoutInfo

public void removePageLayoutInfo(EbiPortalContext context,
                                 String pageName,
                                 String elemType)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Removes a page layout info.

Parameters:

context - a portal context object that contains session/user info.

pageName - a page name of a page layout.

elemType - an element type for either EbiUserPageInfo or EbiGroupPageInfo.

isValidUserPage

public boolean isValidUserPage(EbiPortalContext context,
                               String userPageName)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Check if the user page name provided is a valid user page for the current authenticated user.

Parameters:

context - a context object that contains session/user info.

userPageName - a user page name.

Returns:

true if the user page name is a valid user page, false otherwise.

getUserPageInfo

public EbiUserPageInfo getUserPageInfo(EbiPortalContext context,
                                       String userPageName)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a user page info object that provides portal page information of a specified user page for the current authenticated user.

Parameters:

context - a context object that contains session/user info.

userPageName - a user page name.

Returns:

an EbiUserPageInfo object.

getUserPageInfo

public EbiUserPageInfo getUserPageInfo(EbiPortalContext context,
                                       String userIID,
                                       String userPageName)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException

Gets a user page info object that provides portal page information of a specified user page for a specified user. Acl based security is enforced to allow user to access the user page info object that belong to him/herself, and allow only user administrators to access the specified user page info object.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID.

userPageName - a user page name.

Returns:

an EbiUserPageInfo object.

getUserPageInfoList

public EbiUserPageInfo[] getUserPageInfoList(EbiPortalContext context)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets user page info list for the authenticated user from the current security context.

Parameters:

context - a context object that contains session/user info.

Returns:

an array of EbiUserPageInfo objects.

getUserPageInfoList

public EbiUserPageInfo[] getUserPageInfoList(EbiPortalContext context,
                                             String userIID)
                                      throws EboUnrecoverableSystemException,
                                             EboSecurityException

Gets user page info list for a specified user. Acl based security is enforced to allow user to access the user page info objects that belong to him/herself, and allow only user administrators to access any user page info objects.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID.

Returns:

an array of EbiUserPageInfo objects.

createUserPageInfo

public EbiUserPageInfo createUserPageInfo()

Creates a new user page info object.

Returns:

a newly created blank EbiUserPageInfo object.

createUserPageInfo

public EbiUserPageInfo createUserPageInfo(EbiPortalContext context)

Creates a new user page info object.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiUserPageInfo object which sets the portalID and userIID retrieved from the current portal context and sets the layoutID to be the portal default layoutID.

addUserPageInfo

public void addUserPageInfo(EbiPortalContext context,
                            EbiUserPageInfo pageInfo)
                     throws EboUnrecoverableSystemException,
                            EboSecurityException

Adds a user page info.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiUserPageInfo object.

modifyUserPageInfo

public void modifyUserPageInfo(EbiPortalContext context,
                               EbiUserPageInfo pageInfo)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Modifies a user page info. Acl based security is enforced to allow user to modify the user page info objects that belong to him/herself, and allow only user administrators to modify any user page info objects.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiUserPageInfo object.

removeAllUserPageInfos

public void removeAllUserPageInfos(EbiPortalContext context,
                                   String userIID)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Removes all user page info objects for a specified user. Acl based security is enforced to allow user to remove all user page info objects that belong to him/herself, and allow only user administrators to remove user page info objects for any user.

Parameters:

context - a portal context object that contains session/user info.

userIID - a user UUID.

removeAllUserPageInfos

public void removeAllUserPageInfos(EbiPortalContext context)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Removes all user page info objects for the authenticated user from the current portal context.

Parameters:

context - a portal context object that contains session/user info.

removeUserPageInfo

public void removeUserPageInfo(EbiPortalContext context,
                               String userIID,
                               String userPageName)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Removes a user page info for a specified user. Acl based security is enforced to allow user to remove any user page info objects that belong to him/herself, and allow only user administrators to remove any user page info objects for any user.

Parameters:

context - a portal context object that contains session/user info.

userIID - a user IID.

userPageName - a user page name.

removeUserPageInfo

public void removeUserPageInfo(EbiPortalContext context,
                               String userPageName)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Removes a user page info for the authenticated user from the current portal context.

Parameters:

context - a portal context object that contains session/user info.

userPageName - a user page name.

getUserComponentInfo

public EbiUserComponentInfo getUserComponentInfo(EbiPortalContext context,
                                                 String componentName)
                                          throws EboUnrecoverableSystemException,
                                                 EboSecurityException

Gets a user component info object that provides info regarding portal component preferences of a specified component instance for the authenticated user.

Parameters:

context - a context object that contains session/user info.

componentName - a component name

Returns:

an EbiUserComponentInfo object.

getUserComponentInfo

public EbiUserComponentInfo getUserComponentInfo(EbiPortalContext context,
                                                 String userIID,
                                                 String componentName)
                                          throws EboUnrecoverableSystemException,
                                                 EboSecurityException

Gets a user component info object that provides info regarding portal component preferences of a specified component instance for a specified user. Acl based security is enforced to allow user to access the user component info object that belong to him/herself, and allow only user administrators to access any user component info objects.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID.

componentName - a component name

Returns:

an EbiUserComponentInfo object.

getUserComponentInfoList

public EbiUserComponentInfo[] getUserComponentInfoList(EbiPortalContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets the user component info list for the current authenticated user.

Parameters:

context - a context object that contains session/user info.

Returns:

an array of EbiUserComponentInfo objects.

getUserComponentInfoList

public EbiUserComponentInfo[] getUserComponentInfoList(EbiPortalContext context,
                                                       String userIID)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets the user component info list for a specified user. Acl based security is enforced to allow user to access the user component info objects that belong to him/herself, and allow only user administrators to access user component info objects for any user.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID.

Returns:

an array of EbiUserComponentInfo objects.

createUserComponentInfo

public EbiUserComponentInfo createUserComponentInfo()

Creates a new user component info object.

Returns:

a newly created blank EbiUserComponentInfo object.

createUserComponentInfo

public EbiUserComponentInfo createUserComponentInfo(EbiPortalContext context)

Creates a new user component info object.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiUserComponentInfo object that has portalID and UserIID retrieved from the portal context.

addUserComponentInfo

public void addUserComponentInfo(EbiPortalContext context,
                                 EbiUserComponentInfo userCompInfo)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Adds a user component info for a specified user and component instance.

Parameters:

context - a portal context object that contains session/user info.

userCompInfo - an EbiUserComponentInfo object.

modifyUserComponentInfo

public void modifyUserComponentInfo(EbiPortalContext context,
                                    EbiUserComponentInfo userCompInfo)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Modifies a user component info for a specified user and component instance. Acl based security is enforced to allow user to modify the user component info objects that belong to him/herself, and allow only user administrators to modify any user component info objects.

Parameters:

context - a portal context object that contains session/user info.

userCompInfo - an EbiUserComponentInfo object.

removeAllUserComponentInfos

public void removeAllUserComponentInfos(EbiPortalContext context)
                                 throws EboUnrecoverableSystemException,
                                        EboSecurityException

Removes all user component info for the authenticated user from the current portal context.

Parameters:

context - a portal context object that contains session/user info.

removeAllUserComponentInfos

public void removeAllUserComponentInfos(EbiPortalContext context,
                                        String userIID)
                                 throws EboUnrecoverableSystemException,
                                        EboSecurityException

Removes all user component info for a specified user. Acl based security is enforced to allow user to remove the user component info objects that belong to him/herself, and allow only user administrators to remove user component info objects for any user.

Parameters:

context - a portal context object that contains session/user info.

userIID - a user UUID.

removeUserComponentInfo

public void removeUserComponentInfo(EbiPortalContext context,
                                    String componentName)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Removes a user component info for the authenticated user from the current portal context.

Parameters:

context - a portal context object that contains session/user info.

componentName - a component name.

removeUserComponentInfo

public void removeUserComponentInfo(EbiPortalContext context,
                                    String userIID,
                                    String componentName)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Removes a user component info for a specified user. Acl based security is enforced to allow user to remove any user component info object that belong to him/herself, and allow only user administrators to remove any user component info objects.

Parameters:

context - a portal context object that contains session/user info.

userIID - a user UUID.

componentName - a component name.

isValidContainerPage

public boolean isValidContainerPage(EbiPortalContext context,
                                    String containerPageName)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Checks if the specified container page is a valid container page for the authenticated user from the current portal context.

Parameters:

context - an EbiPortalContext object.

containerPageName - a container page name

Returns:

true if the specified container page is a valid container page, false otherwise.

addContainerPageInfo

public void addContainerPageInfo(EbiPortalContext context,
                                 EbiContainerPageInfo info)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Adds a container page to the datastore

Parameters:

context - a portal context object that contains session/user info.

info - an EbiContainerPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, is not a portal administrator

createContainerPageInfo

public EbiContainerPageInfo createContainerPageInfo(EbiPortalContext context)

Creates a new container page info object.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiContainerPageInfo object which sets the portal ID retrieved from the portal context and sets the layoutID to be the portal default layoutID.

getContainerPageInfoList

public EbiContainerPageInfo[] getContainerPageInfoList(EbiPortalContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets a list of Container Pages defined for a web application for the authenticated user of the current portal context. Acl based security is enforced to the Container Page instance level. Based on the current security context, the returned list only contains the Container Pages that the authenticated user can access.

Parameters:

context - a context object that contains session/user info.

Returns:

an array of EbiContainerPageInfo objects.

getContainerPageInfo

public EbiContainerPageInfo getContainerPageInfo(EbiPortalContext context,
                                                 String pageName)
                                          throws EboUnrecoverableSystemException,
                                                 EboSecurityException

Gets a particular Container Page defined for a web application for the authenticated user of the current portal context. Acl based security is enforced to the Container Page instance level. Based on the current security context

Parameters:

context - a context object that contains session/user info.

pageName - the name of the container page

Returns:

an EbiContainerPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, does not have READ permission to this container page

Since:

v5.0

getContainerPageInfoListByUser

public EbiContainerPageInfo[] getContainerPageInfoListByUser(EbiPortalContext context,
                                                             String userIID)
                                                      throws EboUnrecoverableSystemException,
                                                             EboSecurityException

Gets a container page info list for the container pages that are readable by a specified user.

This method is based on the user specified. If the useriid is null anonymous or non-authenticated user is assumed.

by the userIID.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID for the specified user.

Returns:

an array of EbiContainerPageInfo objects.

getContainerPageInfoListByOwner

public EbiContainerPageInfo[] getContainerPageInfoListByOwner(EbiPortalContext context,
                                                              String userIID)
                                                       throws EboUnrecoverableSystemException,
                                                              EboSecurityException

Returns the list of container pages that the current user has WRITE permission to. If the user is a portal administrator then all container pages are returned.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID for the specified user.

Returns:

an array of EbiContainerPageInfo objects.

Since:

v5.0

modifyContainerPageInfo

public void modifyContainerPageInfo(EbiPortalContext context,
                                    EbiContainerPageInfo pageInfo)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Modifies a container page info. only the Container Page administrators can modify any container pages.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiContainerPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, is not a portal administrator

Since:

v5.0

removeContainerPageInfo

public void removeContainerPageInfo(EbiPortalContext context,
                                    String containerPageName)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Removes a container page info. only the Container Page administrators can remove any containerp pages.

Parameters:

context - a portal context object that contains session/user info.

containerPageName - a container page name.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, is not a portal admin

Since:

v5.0

addSharedPageInfo

public void addSharedPageInfo(EbiPortalContext context,
                              EbiSharedPageInfo info)
                       throws EboUnrecoverableSystemException,
                              EboSecurityException

Adds a shared page info.

Parameters:

context - a portal context object that contains session/user info.

info - an EbiSharedPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, is not a portal administrator

Since:

v5.0

createSharedPageInfo

public EbiSharedPageInfo createSharedPageInfo(EbiPortalContext context)

Creates a new shared page info object.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiSharedPageInfo object which sets the portal ID retrieved from the portal context and sets the layoutID to be the portal default layoutID.

getSharedPageInfo

public EbiSharedPageInfo getSharedPageInfo(EbiPortalContext context,
                                           String sharedPageName)
                                    throws EboUnrecoverableSystemException,
                                           EboSecurityException

Gets a shared page info for the authenticated user from the current portal context. Acl based security is enforced to the shared page instance level. If the specified shared page has an acl list, then only the user that are on the acl list can access the page. If the specified shared page does not have an acl list, then everyone is allowed to access the page.

Parameters:

context - a context object that contains session/user info.

sharedPageName - a shared page name.

Returns:

an EbiSharedPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, does not have READ permission to this shared page

Since:

v5.0

getSharedPageInfoList

public EbiSharedPageInfo[] getSharedPageInfoList(EbiPortalContext context)
                                          throws EboUnrecoverableSystemException,
                                                 EboSecurityException

Gets a list of Shared Pages defined for a web application for the authenticated user of the current portal context. Acl based security is enforced to the Shared Page instance level. Based on the current security context, the returned list only contains the Shared Pages that the authenticated user can access.

Parameters:

context - a context object that contains session/user info.

Returns:

an array of EbiSharedPageInfo objects.

getSharedPageInfoListByUser

public EbiSharedPageInfo[] getSharedPageInfoListByUser(EbiPortalContext context,
                                                       String userIID)
                                                throws EboUnrecoverableSystemException,
                                                       EboSecurityException

Gets a shared page info list for the shared pages that are readable by a specified user.

This method is based on the user specified by the userIID. If the useriid is null anonymous or non-authenticated user is assumed.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID for the specified user.

Returns:

an array of EbiSharedPageInfo objects.

getSharedPageInfoListByOwner

public EbiSharedPageInfo[] getSharedPageInfoListByOwner(EbiPortalContext context,
                                                        String userIID)
                                                 throws EboUnrecoverableSystemException,
                                                        EboSecurityException

Gets a shared page info list for the shared pages that are writeable by a specified user. If the user is a portal administrator then all shared pages are returned.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID for the specified user.

Returns:

an array of EbiSharedPageInfo objects.

isValidSharedPage

public boolean isValidSharedPage(EbiPortalContext context,
                                 String sharedPageName)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Checks if the specified shared page is valid for the authenticated user from the current portal context.

Parameters:

context - an EbiPortalContext object.

sharedPageName - a shared page name

Returns:

true if the specified shared page is valid, false otherwise.

modifySharedPageInfo

public void modifySharedPageInfo(EbiPortalContext context,
                                 EbiSharedPageInfo pageInfo)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Modifies a shared page info. only the Shared Page administrators can modify any shared pages. However, it can be customized to allow shared page level access for the modify action.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiSharedPageInfo object.

Throws:

EboSecurityException - Thrown if the current user, specified by the context, does not have WRITE permission to this shared page

Since:

v5.0

removeSharedPageInfo

public void removeSharedPageInfo(EbiPortalContext context,
                                 String sharedPageName)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Removes a shared page info. only the Shared Page administrators can remove any shared pages. However, it can be customized to allow shared page level access for the delete action.

Parameters:

context - a portal context object that contains session/user info.

sharedPageName - a shared page name.

isValidGroupPage

public boolean isValidGroupPage(EbiPortalContext context,
                                String groupPageName)
                         throws EboUnrecoverableSystemException,
                                EboSecurityException

Deprecated.

Checks if the specified group page is a valid group page for the authenticated user from the current portal context.

Parameters:

context - an EbiPortalContext object.

groupPageName - a group page name

Returns:

true if the specified group page is a valid group page, false otherwise.

getGroupPageInfo

public EbiGroupPageInfo getGroupPageInfo(EbiPortalContext context,
                                         String groupPageName)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException

Deprecated.

Gets a group page info for the authenticated user from the current portal context. Acl based security is enforced to the group page instance level. If the specified group page has an acl list, then only the user that are on the acl list can access the group page. If the specified group page does not have an acl list, then everyone is allowed to access the group page.

Parameters:

context - a context object that contains session/user info.

groupPageName - a group page name.

Returns:

an EbiGroupPageInfo object.

getGroupPageInfoList

public EbiGroupPageInfo[] getGroupPageInfoList(EbiPortalContext context)
                                        throws EboUnrecoverableSystemException,
                                               EboSecurityException

Deprecated.

Gets the group page info list defined for a web application for the authenticated user from the current portal context. Acl based security is enforced to the group page instance level. Based on the current security context, the returned list only contains the group pages that the authenticated user can access.

Parameters:

context - a context object that contains session/user info.

Returns:

an array of EbiGroupPageInfo objects.

getGroupPageInfoListByUser

public EbiGroupPageInfo[] getGroupPageInfoListByUser(EbiPortalContext context,
                                                     String userIID)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException

Deprecated.

Gets a group page info list for the group pages that are readable by a specified user. Differ from the pervious method, this method is based on the user specified by the userIID.

Parameters:

context - a context object that contains session/user info.

userIID - a user UUID for the specified user.

Returns:

an array of EbiGroupPageInfo objects.

createGroupPageInfo

public EbiGroupPageInfo createGroupPageInfo(EbiPortalContext context)

Deprecated.

Creates a new group page info object.

Parameters:

context - an EbiPortalContext object.

Returns:

a newly created EbiGroupPageInfo object which sets the portal ID retrieved from the portal context and sets the layoutID to be the portal default layoutID.

addGroupPageInfo

public void addGroupPageInfo(EbiPortalContext context,
                             EbiGroupPageInfo info)
                      throws EboUnrecoverableSystemException,
                             EboSecurityException

Deprecated.

Adds a group page info.

Parameters:

context - a portal context object that contains session/user info.

info - an EbiGroupPageInfo object.

modifyGroupPageInfo

public void modifyGroupPageInfo(EbiPortalContext context,
                                EbiGroupPageInfo pageInfo)
                         throws EboUnrecoverableSystemException,
                                EboSecurityException

Deprecated.

Modifies a group page info. only the Group Page administrators can modify any group pages. However, it can be customized to allow group page level access for the modify action.

Parameters:

context - a portal context object that contains session/user info.

pageInfo - an EbiGroupPageInfo object.

removeGroupPageInfo

public void removeGroupPageInfo(EbiPortalContext context,
                                String groupPageName)
                         throws EboUnrecoverableSystemException,
                                EboSecurityException

Deprecated.

Removes a group page info. only the Group Page administrators can remove any group pages. However, it can be customized to allow group page level access for the delete action.

Parameters:

context - a portal context object that contains session/user info.

groupPageName - a group page name.

getPageType

public String getPageType(String pageName)

Get's the page type (User or Shared) of a particular page.

Parameters:

pageName - the name of a page (User or Shared)

Returns:

the page type

getPageType

public String getPageType(EbiPageLayoutInfo pageInfo)

Get's the page type (User or Shared) of a particular page.

Parameters:

pageInfo - the name of a page (User or Shared)

Returns:

the page type

getContainerPageCategoryInfo

public EbiCategoryInfo getContainerPageCategoryInfo(EbiPortalContext context,
                                                    String categoryName,
                                                    boolean flush)
                                             throws EboUnrecoverableSystemException,
                                                    EboFactoryException

Gets a container page category info.

Parameters:

context - a context.

categoryName - a name of the specified category.

flush - true if needs to re-get container page category info from resource set.

Returns:

an EbiCategoryInfo object.

Throws:

EboUnrecoverableSystemException -

getContainerPageCategoryInfo

public EbiCategoryInfo getContainerPageCategoryInfo(EbiPortalContext context,
                                                    String category)
                                             throws EboUnrecoverableSystemException,
                                                    EboFactoryException

Gets a container page category info.

Parameters:

context - a context.

category - Name of a category

Returns:

an EbiCategoryInfo object.

Throws:

EboUnrecoverableSystemException -

getContainerPageCategoryInfoList

public EbiCategoryInfo[] getContainerPageCategoryInfoList(EbiPortalContext context)
                                                   throws EboUnrecoverableSystemException,
                                                          EboFactoryException

Gets a list of container page category infos.

Parameters:

context - a context.

Returns:

an array of EbiCategoryInfo objects for container page categories.

Throws:

EboUnrecoverableSystemException -

addContainerPageToCategory

public void addContainerPageToCategory(EbiPortalContext context,
                                       String pageName,
                                       String categoryID)
                                throws EboUnrecoverableSystemException,
                                       EboSecurityException,
                                       EboItemExistenceException

Adds a container page to a page category.

Parameters:

context - an EbiPortalContext object.

pageName - a page name for a container page.

categoryID - a category indentifier.

Throws:

EboSecurityException - Thrown when the user is not a portal administrator. Only portal admins can make this call.

Since:

v5.0

removeContainerPageFromCategory

public void removeContainerPageFromCategory(EbiPortalContext context,
                                            String pageName,
                                            String categoryID)
                                     throws EboUnrecoverableSystemException,
                                            EboSecurityException,
                                            EboItemExistenceException

Removes a container page from a page category.

Parameters:

context - an EbiPortalContext object.

pageName - a page name for a container page.

categoryID - a category indentifier.

Throws:

EboSecurityException - Thrown when the user is not a portal administrator. Only portal admins can make this call.

Since:

v5.0

See Also:

EbiContainerPageInfo

getContainerPageInfoListByCategory

public EbiContainerPageInfo[] getContainerPageInfoListByCategory(EbiPortalContext context,
                                                                 String categoryID)
                                                          throws EboUnrecoverableSystemException,
                                                                 EboSecurityException

Gets a list of EbiContainerPageInfo objects for container pages by category ID that the authenticated user from EbiPortalContext is allowed to access. If categoryID is null, it gets a list of uncategorized container pages

Parameters:

context - an EbiPortalContext object.

categoryID - a page category identifier

Returns:

an array of EbiContainerPageInfo objects.

Since:

v5.0

See Also:

EbiContainerPageInfo

getContainerPageInfoListByCategory

public EbiContainerPageInfo[] getContainerPageInfoListByCategory(EbiPortalContext context,
                                                                 String userID,
                                                                 String categoryID)
                                                          throws EboUnrecoverableSystemException,
                                                                 EboSecurityException

Gets a list of EbiContainerPageInfo objects for container pages by category ID that the user, 'userID' is allowed to access. If category ID is null, it gets a list of uncategorized container pages

Parameters:

context - an EbiPortalContext object

userID - a user identifier

categoryID - a page category identifier

Returns:

an array of EbiContainerPageInfo objects.

Since:

v5.0

See Also:

EbiContainerPageInfo

getSharedPageCategoryInfo

public EbiCategoryInfo getSharedPageCategoryInfo(EbiPortalContext context,
                                                 String categoryName,
                                                 boolean flush)
                                          throws EboUnrecoverableSystemException,
                                                 EboFactoryException

Gets a Shared page category info.

Parameters:

context - a context.

categoryName - a name of the specified category.

flush - true if needs to re-get Shared page category info from resource set.

Returns:

an EbiCategoryInfo object.

Throws:

EboUnrecoverableSystemException -

getSharedPageCategoryInfo

public EbiCategoryInfo getSharedPageCategoryInfo(EbiPortalContext context,
                                                 String category)
                                          throws EboUnrecoverableSystemException,
                                                 EboFactoryException

Gets a Shared page category info.

Parameters:

context - a context.

category - Name of a category

Returns:

an EbiCategoryInfo object.

Throws:

EboUnrecoverableSystemException -

getSharedPageCategoryInfoList

public EbiCategoryInfo[] getSharedPageCategoryInfoList(EbiPortalContext context)
                                                throws EboUnrecoverableSystemException,
                                                       EboFactoryException

Gets a list of Shared page category infos.

Parameters:

context - a context.

Returns:

an array of EbiCategoryInfo objects for Shared page categories.

Throws:

EboUnrecoverableSystemException -

addSharedPageToCategory

public void addSharedPageToCategory(EbiPortalContext context,
                                    String pageName,
                                    String categoryID)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException,
                                    EboItemExistenceException

Adds a shared page to a page category.

Parameters:

context - an EbiPortalContext object.

pageName - a page name for a shared page.

categoryID - a category indentifier.

Throws:

EboSecurityException - Thrown if the current user does not have WRITE permission to the shared page

Since:

v5.0

removeSharedPageFromCategory

public void removeSharedPageFromCategory(EbiPortalContext context,
                                         String pageName,
                                         String categoryID)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException,
                                         EboItemExistenceException

Removes a shared page from a page category.

Parameters:

context - an EbiPortalContext object.

pageName - a page name for a shared page.

categoryID - a category indentifier.

Throws:

EboSecurityException - Thrown when the user is not a portal administrator. Only portal admins can make this call.

Since:

v5.0

See Also:

EbiSharedPageInfo

getSharedPageInfoListByCategory

public EbiSharedPageInfo[] getSharedPageInfoListByCategory(EbiPortalContext context,
                                                           String categoryID)
                                                    throws EboUnrecoverableSystemException,
                                                           EboSecurityException

Gets a list of EbiSharedPageInfo objects for shared pages by category ID that the authenticated user from EbiPortalContext is allowed to access. If categoryID is null, it gets a list of uncategorized shared pages

Parameters:

context - an EbiPortalContext object.

categoryID - a page category identifier

Returns:

an array of EbiSharedPageInfo objects.

Since:

v5.0

See Also:

EbiSharedPageInfo

getSharedPageInfoListByCategory

public EbiSharedPageInfo[] getSharedPageInfoListByCategory(EbiPortalContext context,
                                                           String userID,
                                                           String categoryID)
                                                    throws EboUnrecoverableSystemException,
                                                           EboSecurityException

Gets a list of EbiSharedPageInfo objects for shared pages by category ID that the user, 'userID' is allowed to access. If category ID is null, it gets a list of uncategorized shared pages

Parameters:

context - an EbiPortalContext object

userID - a user identifier

categoryID - a page category identifier

Returns:

an array of EbiSharedPageInfo objects.

Since:

v5.0

See Also:

EbiSharedPageInfo