| java.lang.Object
 org.jasig.portal.channels.groupsmanager.CGroupsManagerServantFactory
| CGroupsManagerServantFactory | | public class CGroupsManagerServantFactory implements GroupsManagerConstants(Code) | | A Factory that produces a Groups Manager IServant for
one of several groups-management related tasks. Each specific servant
is available from one of the methods documented below.
Groups Manager servants can relieve uPortal channels from having to
implement complicated custom GUIs for managing group memberships or
selecting groups and entities.
See Also: org.jasig.portal.channels.CChannelManager
See Also: as an example of using Groups Manager servants
author:
Alex Vigdor
version:
$Revision: 36398 $ |
| Method Summary | |
| protected static ChannelStaticData | cloneStaticData(ChannelStaticData sd)
| | protected static CGroupsManagerServant | getGroupsServant()
| | public static IServant | getGroupsServantforAddRemove(ChannelStaticData staticData, String groupKey)
Returns a servant with the group corresponding to the provided key selected
and locked for editing. | | public static IServant | getGroupsServantforGroupMemberships(ChannelStaticData staticData, String message, IGroupMember member, boolean allowFinish)
Returns a servant that is used to select IEntityGroups that the supplied
GroupMember belongs to. | | public static IServant | getGroupsServantforSelection(ChannelStaticData staticData, String message)
Returns a servant that is used to select IGroupMembers. | | public static IServant | getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members)
Returns a servant that is used to select IGroupMembers. | | public static IServant | getGroupsServantforSelection(ChannelStaticData staticData, String message, String type)
Returns a servant that is used to select IGroupMembers. | | public static IServant | getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect)
Returns a servant that is used to select IGroupMembers. | | public static IServant | getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members, IGroupsManagerPermissions permissions)
Returns a servant that is used to select IGroupMembers. | | public static synchronized String | getNextUid()
Returns the next sequential identifier which is used to uniquely
identify an element. | | public static IGroupsManagerPermissions | getPermissionsPolicy(ChannelStaticData staticData)
Returns a permissions policy based upon the users role. | | protected static synchronized CGroupsManagerServantFactory | instance()
|
| CGroupsManagerServantFactory | | protected CGroupsManagerServantFactory()(Code) | | Creates new CGroupsManagerServantFactory
|
| getGroupsServantforAddRemove | | public static IServant getGroupsServantforAddRemove(ChannelStaticData staticData, String groupKey) throws PortalException(Code) | | Returns a servant with the group corresponding to the provided key selected
and locked for editing. Only add/remove member functions are enabled -
group name, description and permissions are not editable.
IServant
Parameters:
staticData -
Parameters:
groupKey - the group to be managed
throws:
PortalException - |
| getGroupsServantforGroupMemberships | | public static IServant getGroupsServantforGroupMemberships(ChannelStaticData staticData, String message, IGroupMember member, boolean allowFinish) throws PortalException(Code) | | Returns a servant that is used to select IEntityGroups that the supplied
GroupMember belongs to. Existing memberships are reflected as pre-
selected groups.
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
Parameters:
member - The IGroupMember whose parent groups are to be selected
Parameters:
allowFinish - whether or not the user can "finish" selecting. if false, the servantmethod "isFinished()" will always return false; the master must havesome other mechanism for allowing the user to change screens.
throws:
PortalException - |
| getGroupsServantforSelection | | public static IServant getGroupsServantforSelection(ChannelStaticData staticData, String message) throws PortalException(Code) | | Returns a servant that is used to select IGroupMembers. The
list of selected IGroupMembers is available via the getResults() method
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
throws:
PortalException - |
| getGroupsServantforSelection | | public static IServant getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members) throws PortalException(Code) | | Returns a servant that is used to select IGroupMembers. The
list of selected IGroupMembers is available via the getResults() method
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
Parameters:
type - the distinguished group name representing the desired root group forselection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIES
Parameters:
allowFinish - whether or not the user can "finish" selecting. if false, the servantmethod "isFinished()" will always return false; the master must havesome other mechanism for allowing the user to change screens.
Parameters:
allowEntitySelect - if false, only groups can be selected
Parameters:
members - an IGroupMember[] of pre-selected members.
throws:
PortalException - |
| getGroupsServantforSelection | | public static IServant getGroupsServantforSelection(ChannelStaticData staticData, String message, String type) throws PortalException(Code) | | Returns a servant that is used to select IGroupMembers. The
list of selected IGroupMembers is available via the getResults() method
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
Parameters:
type - the distinguished group name representing the desired root group forselection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIES
throws:
PortalException - |
| getGroupsServantforSelection | | public static IServant getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect) throws PortalException(Code) | | Returns a servant that is used to select IGroupMembers. The
list of selected IGroupMembers is available via the getResults() method
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
Parameters:
type - the distinguished group name representing the desired root group forselection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIES
Parameters:
allowFinish - whether or not the user can "finish" selecting. if false, the servantmethod "isFinished()" will always return false; the master must havesome other mechanism for allowing the user to change screens.
Parameters:
allowEntitySelect - if false, only groups can be selected
throws:
PortalException - |
| getGroupsServantforSelection | | public static IServant getGroupsServantforSelection(ChannelStaticData staticData, String message, String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members, IGroupsManagerPermissions permissions) throws PortalException(Code) | | Returns a servant that is used to select IGroupMembers. The
list of selected IGroupMembers is available via the getResults() method
IServant
Parameters:
staticData - the master channel's staticData
Parameters:
message - a custom message to present the user to explain what they should select
Parameters:
type - the distinguished group name representing the desired root group forselection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIES
Parameters:
allowFinish - whether or not the user can "finish" selecting. if false, the servantmethod "isFinished()" will always return false; the master must havesome other mechanism for allowing the user to change screens.
Parameters:
allowEntitySelect - if false, only groups can be selected
Parameters:
members - an IGroupMember[] of pre-selected members.
Parameters:
permissions - an instance of IGroupsManagerPermissions
throws:
PortalException - |
| getNextUid | | public static synchronized String getNextUid()(Code) | | Returns the next sequential identifier which is used to uniquely
identify an element. This identifier is held in the Element "id" attribute.
"0" is reserved for the Group containing the Initial Contexts for the user.
String |
|
|