|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.beasys.commerce.portal.admin.jspbeans.PortalFinderJspBean
A JSP page helper class that contains numerous finder methods that wrap many of the PortalManger APIs. NOTE : All methods in this class MUST BE STATIC for performance reasons. Some methods in this class use the Waterfall algorithm. The waterfall algorithm will look for a portlet at the requested personalization level and if not found will go to the next personalization level to find the portlet, and if not found, it will go to the next level, and so on... Read each method description carefully to see whether or not the waterfall algorithm is used.
PortalManager
Method Summary | |
static boolean |
doesGroupExist(java.lang.String aPortalName,
java.lang.String aGroupName)
Returns true if a portal group exists for a given portal and group. |
static Portlet |
findPortletInArray(Portlet[] array,
java.lang.String portletName)
Returns a portlet object found in an array of portlets for a given portlet name. |
boolean |
findPortletInPortletArray(Portlet[] array,
java.lang.String str)
Returns true if an array of Portlets contains an exact match (case sensative) for a portlet name string passed in. |
static java.lang.String[] |
getAllPortalNames()
Returns an array of portal names for all of the portals definitions that exist in the system. |
static java.lang.String[] |
getAllPortletNames()
Returns an array of portlet names for all of the portlet definitions in the system. |
static java.lang.String[] |
getAvailablePortletNamesFor(java.lang.String aPortalName)
Returns an array of portlet names for all of the available portlets for a portal at the portal level. |
static java.lang.String[] |
getAvailablePortletNamesFor(java.lang.String aPortalName,
java.lang.String aGroupName)
Returns the available portlet names for a portal and a group. |
static java.lang.String[] |
getAvailablePortletNamesFor(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aUserName)
Returns an array of available Portlet names for a given portal, group, and user. |
static Portlet[] |
getAvailablePortletsFor(java.lang.String aPortalName)
Returns the available portlets for a portal at the portal level (not the group or user level). |
static Portlet[] |
getAvailablePortletsFor(java.lang.String aPortalName,
long aGroup,
long aUserId)
|
static Portlet[] |
getAvailablePortletsFor(java.lang.String aPortalName,
java.lang.String aGroupName)
Returns the available portlets for a portal and a group. |
static Portlet[] |
getAvailablePortletsFor(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aUserName)
Get available portlets for a portal, group, and user. |
static java.lang.String[] |
getGroupIdsForPortal(java.lang.String aPortalName)
Returns an array of group ids (names) for a given portal. |
static Portal |
getPortalFor(java.lang.String aPortalName)
Returns a portal object. |
static java.lang.String[] |
getPortalNamesFor(java.lang.String aPortletName)
Returns all of the portal names that contain a portlet as an available portlet. |
static Portlet |
getPortletFor(java.lang.String aPortletName)
Returns the portal definition for a given portlet name. |
static Portlet |
getPortletForGroup(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aPortletName,
boolean isWaterfall)
Returns a portlet object for a group for a specified portal name, group name, and portlet name. |
static Portlet |
getPortletForPortal(java.lang.String aPortalName,
java.lang.String aPortletName)
Returns a the PortalPersonalization entity for a portal for the given portlet name. |
static Portlet |
getPortletForUser(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aPortletName,
java.lang.String aUserName)
Returns a portlet object for a specified portal name, group name, user name, and portlet name. |
static Portlet |
getPortletForUser(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aPortletName,
java.lang.String aUserName,
boolean isWaterfall)
Returns a portlet object for a specified portal name, group name, user name, and portlet name. |
static Portlet[] |
getPortletsForPortal(java.lang.String aPortalName)
Returns an array of portlet definition objects for a portal for a specified portal name. |
static java.lang.String[] |
getVisiblePortletNamesFor(java.lang.String aPortalName)
Returns an array of visible Portlet names for a given portal at the portal level (not the group and user level). |
static java.lang.String[] |
getVisiblePortletNamesFor(java.lang.String aPortalName,
java.lang.String aGroupName)
Returns an array of Portlet names for a given portal and group. |
static java.lang.String[] |
getVisiblePortletNamesFor(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aUserName)
Returns an array of visible Portlet names for a given portal, group, and user. |
static Portlet[] |
getVisiblePortletsFor(java.lang.String aPortalName)
Returns an array of visible Portlets for a given portal at the portal level (not the group and user level). |
static Portlet[] |
getVisiblePortletsFor(java.lang.String aPortalName,
java.lang.String aGroupName)
Returns an array of visible Portlets for a given portal and group. |
static Portlet[] |
getVisiblePortletsFor(java.lang.String aPortalName,
java.lang.String aGroupName,
java.lang.String aUserName)
Returns an array of all available and visible Portlets for a given portal, group, and user. |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Method Detail |
public static java.lang.String[] getAllPortalNames()
public static java.lang.String[] getAllPortletNames()
public static Portal getPortalFor(java.lang.String aPortalName)
aPortalName
- The name of the portal to retrieve.public static Portlet getPortletFor(java.lang.String aPortletName)
aPortletName
- The name of the portletpublic static java.lang.String[] getAvailablePortletNamesFor(java.lang.String aPortalName)
aPortalName
- The name of the portal.public static boolean doesGroupExist(java.lang.String aPortalName, java.lang.String aGroupName)
aPortalName
- The name of the portal.aGroupName
- The name of the portal group.public static java.lang.String[] getGroupIdsForPortal(java.lang.String aPortalName)
aPortalName
- The name of the portal.public static java.lang.String[] getAvailablePortletNamesFor(java.lang.String aPortalName, java.lang.String aGroupName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.public static Portlet[] getAvailablePortletsFor(java.lang.String aPortalName, java.lang.String aGroupName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.public static Portlet[] getAvailablePortletsFor(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aUserName)
aPortalName
- aGroupName
- aUserName
- []
public static Portlet[] getAvailablePortletsFor(java.lang.String aPortalName, long aGroup, long aUserId)
public static Portlet[] getAvailablePortletsFor(java.lang.String aPortalName)
aPortalName
- The name of the portal.public static java.lang.String[] getAvailablePortletNamesFor(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aUserName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.aUserName
- The name of the user.public static java.lang.String[] getVisiblePortletNamesFor(java.lang.String aPortalName)
aPortalName
- The name of the portal.public static Portlet[] getVisiblePortletsFor(java.lang.String aPortalName)
aPortalName
- The name of the portal.public static java.lang.String[] getVisiblePortletNamesFor(java.lang.String aPortalName, java.lang.String aGroupName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.public static Portlet[] getVisiblePortletsFor(java.lang.String aPortalName, java.lang.String aGroupName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.public static java.lang.String[] getVisiblePortletNamesFor(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aUserName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.aUserName
- The name of the user.public static Portlet[] getVisiblePortletsFor(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aUserName)
aPortalName
- The name of the portal.aGroupName
- The name of the group.aUserName
- The name of the user.public static java.lang.String[] getPortalNamesFor(java.lang.String aPortletName)
aPortletName
- The name of a portlet.public static Portlet getPortletForPortal(java.lang.String aPortalName, java.lang.String aPortletName)
aPortalName
- The name of the portal.aPortletName
- The name of th portlet to find.PortalManager.getPortletForPortal(String, String, String)
public static Portlet getPortletForGroup(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aPortletName, boolean isWaterfall)
aPortalName
- The portal name.aGroupName
- The group name.aPortletName
- The portlet name.public static Portlet[] getPortletsForPortal(java.lang.String aPortalName)
aPortalName
- The portal name.public static Portlet findPortletInArray(Portlet[] array, java.lang.String portletName)
array
- An array of Portlets to search.portletName
- The name to find.public static Portlet getPortletForUser(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aPortletName, java.lang.String aUserName)
aPortalName
- The portal name.aGroupName
- The group name.aPortletName
- The portlet name.aUserName
- The user name.public static Portlet getPortletForUser(java.lang.String aPortalName, java.lang.String aGroupName, java.lang.String aPortletName, java.lang.String aUserName, boolean isWaterfall)
aPortalName
- The portal name.aGroupName
- The group name.aPortletName
- The portlet name.aUserName
- The user name.isWaterfall
- true means use the waterfall algorithm, and
false means do not use the waterfall algorithm.public boolean findPortletInPortletArray(Portlet[] array, java.lang.String str)
array
- An array of Portlets.str
- A portlet name.
|
BEA Systems, Inc. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |