|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortalManager
Manager for Portal configuration. A user's dashboard is a portal configuration and may have a configuration
Field Summary | |
---|---|
static String |
DASHBOARD_PAGE_NAME
|
static String |
SYSTEM_PORTLET_PACKAGE
|
Method Summary | |
---|---|
Long |
createPortalPageConfiguration(User u,
String pagename,
String description)
|
Long |
createPortalPageConfiguration(User u,
String pagename,
String description,
Long copyPageId)
|
void |
decreasePageConfigurationSequence(User user,
int position)
Decreases the position of the page configuration in the user's page configuration set. |
void |
deletePortalPageConfiguration(User u,
Long pageId)
This function removes a portal page configuration for a user including all of its portlet configurations and their properties. |
Collection |
getAllPortlets()
|
PortalPageConfiguration |
getDefaultPortalPage()
Returns the default portal page configuration |
PortalPageConfiguration |
getEditablePortalPageConfiguration(User user,
Long pageId)
|
PortalPageConfiguration |
getPortalPageConfiguration(User u,
Long pageId)
Get a portlet configuration for a particular user and page from the database. |
Map |
getPortalPageConfigurations(User remoteUser)
Get all the portal pages for a given user. |
Portlet |
getPortlet(String id)
|
Collection |
getPortlets(User user)
This function returns all the portlets a user has permission to see. |
boolean |
hasAccessToPage(User user,
Long selectPageId)
Return true only if the given User has permission to see the page with id selectPageId. |
void |
increasePageConfigurationSequence(User remoteUser,
int position)
Increases the position of the page configuration in the user's page configuration set |
boolean |
isDefaultPortalPageName(String pageName)
|
boolean |
isMultiplePortalPagesEnabled()
|
boolean |
isUsingDefaultPortalPageConfigurations(User remoteUser)
Returns true only if the user has the default portal page configuration. |
void |
movePortlets(Long[] selectedPortlets,
PortalPageConfiguration sourcePage,
PortalPageConfiguration destinationPage)
Move portlets from one page to another |
void |
moveToEndPageConfigurationSequence(User user,
int position)
Puts the page at the given position to the end fo the user's page configuration set. |
void |
moveToStartPageConfigurationSequence(User user,
int position)
Puts the page at the given position to the start of the user's page configuration set. |
void |
resetDefault(String pagename)
This function reloads the default portal page configuration from the database. |
void |
updatePortalPage(User user,
Long pageId,
String name,
String description)
Updates the page with given name and description and persists it. |
Field Detail |
---|
static final String SYSTEM_PORTLET_PACKAGE
static final String DASHBOARD_PAGE_NAME
Method Detail |
---|
Portlet getPortlet(String id)
Collection getAllPortlets()
Long createPortalPageConfiguration(User u, String pagename, String description) throws PortletConfigurationException
PortletConfigurationException
Long createPortalPageConfiguration(User u, String pagename, String description, Long copyPageId) throws PortletConfigurationException
PortletConfigurationException
PortalPageConfiguration getPortalPageConfiguration(User u, Long pageId) throws PortletConfigurationException
u
- the user.pageId
- id of portal page to remove.
PortletConfigurationException
PortalPageConfiguration getDefaultPortalPage() throws PortletConfigurationException
PortletConfigurationException
void deletePortalPageConfiguration(User u, Long pageId) throws PortletConfigurationException
u
- the user.pageId
- id of portal page to remove.
PortletConfigurationException
void updatePortalPage(User user, Long pageId, String name, String description)
user
- currently logged in userpageId
- page idname
- page namedescription
- page descriptionCollection getPortlets(User user)
user
- requesting portlets
PortalPageConfiguration getEditablePortalPageConfiguration(User user, Long pageId) throws PortletConfigurationException
PortletConfigurationException
void resetDefault(String pagename)
pagename
- e.g. dashboard.Map getPortalPageConfigurations(User remoteUser) throws PortletConfigurationException
PortletConfigurationException
void movePortlets(Long[] selectedPortlets, PortalPageConfiguration sourcePage, PortalPageConfiguration destinationPage) throws PortletConfigurationException, org.ofbiz.core.entity.GenericEntityException
PortletConfigurationException
org.ofbiz.core.entity.GenericEntityException
boolean isUsingDefaultPortalPageConfigurations(User remoteUser)
remoteUser
- the user.
boolean isMultiplePortalPagesEnabled()
void increasePageConfigurationSequence(User remoteUser, int position) throws PortletConfigurationException
remoteUser
- position
- the current position of the page to resequence.
PortletConfigurationException
void decreasePageConfigurationSequence(User user, int position) throws PortletConfigurationException
user
- the user.position
- the current position of the page to resequence.
PortletConfigurationException
void moveToStartPageConfigurationSequence(User user, int position) throws PortletConfigurationException
user
- the user.position
- the current position of the page to resequence.
PortletConfigurationException
void moveToEndPageConfigurationSequence(User user, int position) throws PortletConfigurationException
user
- position
- the current position of the page to resequence.
PortletConfigurationException
boolean isDefaultPortalPageName(String pageName)
boolean hasAccessToPage(User user, Long selectPageId)
user
- the user.selectPageId
- the id of the page.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |