|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.groupsmanager.CGroupsManagerServantFactory
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.
as an example of using Groups Manager servants
Field Summary |
Fields inherited from interface org.jasig.portal.channels.groupsmanager.GroupsManagerConstants |
ADD_REMOVE_PERMISSION, ASSIGN_PERMISSION, BASE_PACKAGE, BROWSE_MODE, COMMANDS_PACKAGE, CREATE_PERMISSION, DELETE_PERMISSION, EDIT_MODE, ENTITY_CLASSNAME, ENTITY_TAGNAME, GROUP_CLASSNAME, GROUP_TAGNAME, GROUPS_PACKAGE, MEMBERS_ONLY_MODE, OWNER, PROPERTIES_TAGNAME, ROOT_GROUP_DESCRIPTION, ROOT_GROUP_TITLE, SECURITY_PACKAGE, SELECT_MODE, SELECT_PERMISSION, UPDATE_PERMISSION, VIEW_PERMISSION, WRAPPERS_PACKAGE |
Method Summary | |
static IServant |
getGroupsServantforAddRemove(ChannelStaticData staticData,
java.lang.String groupKey)
Returns a servant with the group corresponding to the provided key selected and locked for editing. |
static IServant |
getGroupsServantforGroupMemberships(ChannelStaticData staticData,
java.lang.String message,
IGroupMember member,
boolean allowFinish)
Returns a servant that is used to select IEntityGroups that the supplied GroupMember belongs to. |
static IServant |
getGroupsServantforSelection(ChannelStaticData staticData,
java.lang.String message)
Returns a servant that is used to select IGroupMembers. |
static IServant |
getGroupsServantforSelection(ChannelStaticData staticData,
java.lang.String message,
java.lang.String type)
Returns a servant that is used to select IGroupMembers. |
static IServant |
getGroupsServantforSelection(ChannelStaticData staticData,
java.lang.String message,
java.lang.String type,
boolean allowFinish,
boolean allowEntitySelect)
Returns a servant that is used to select IGroupMembers. |
static IServant |
getGroupsServantforSelection(ChannelStaticData staticData,
java.lang.String message,
java.lang.String type,
boolean allowFinish,
boolean allowEntitySelect,
IGroupMember[] members)
Returns a servant that is used to select IGroupMembers. |
static IServant |
getGroupsServantforSelection(ChannelStaticData staticData,
java.lang.String message,
java.lang.String type,
boolean allowFinish,
boolean allowEntitySelect,
IGroupMember[] members,
IGroupsManagerPermissions permissions)
Returns a servant that is used to select IGroupMembers. |
static java.lang.String |
getNextUid()
Returns the next sequential identifier which is used to uniquely identify an element. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public static IServant getGroupsServantforSelection(ChannelStaticData staticData, java.lang.String message) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should select
PortalException
public static IServant getGroupsServantforSelection(ChannelStaticData staticData, java.lang.String message, java.lang.String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should selecttype
- the distinguished group name representing the desired root group for
selection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIESallowFinish
- whether or not the user can "finish" selecting. if false, the servant
method "isFinished()" will always return false; the master must have
some other mechanism for allowing the user to change screens.allowEntitySelect
- if false, only groups can be selectedmembers
- an IGroupMember[] of pre-selected members.
PortalException
public static IServant getGroupsServantforGroupMemberships(ChannelStaticData staticData, java.lang.String message, IGroupMember member, boolean allowFinish) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should selectmember
- The IGroupMember whose parent groups are to be selectedallowFinish
- whether or not the user can "finish" selecting. if false, the servant
method "isFinished()" will always return false; the master must have
some other mechanism for allowing the user to change screens.
PortalException
public static IServant getGroupsServantforSelection(ChannelStaticData staticData, java.lang.String message, java.lang.String type) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should selecttype
- the distinguished group name representing the desired root group for
selection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIES
PortalException
public static IServant getGroupsServantforSelection(ChannelStaticData staticData, java.lang.String message, java.lang.String type, boolean allowFinish, boolean allowEntitySelect) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should selecttype
- the distinguished group name representing the desired root group for
selection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIESallowFinish
- whether or not the user can "finish" selecting. if false, the servant
method "isFinished()" will always return false; the master must have
some other mechanism for allowing the user to change screens.allowEntitySelect
- if false, only groups can be selected
PortalException
public static IServant getGroupsServantforAddRemove(ChannelStaticData staticData, java.lang.String groupKey) throws PortalException
staticData
- groupKey
- the group to be managed
PortalException
public static java.lang.String getNextUid()
public static IServant getGroupsServantforSelection(ChannelStaticData staticData, java.lang.String message, java.lang.String type, boolean allowFinish, boolean allowEntitySelect, IGroupMember[] members, IGroupsManagerPermissions permissions) throws PortalException
staticData
- the master channel's staticDatamessage
- a custom message to present the user to explain what they should selecttype
- the distinguished group name representing the desired root group for
selection, e.g. GroupService.EVERYONE or GroupService.ALL_CATEGORIESallowFinish
- whether or not the user can "finish" selecting. if false, the servant
method "isFinished()" will always return false; the master must have
some other mechanism for allowing the user to change screens.allowEntitySelect
- if false, only groups can be selectedmembers
- an IGroupMember[] of pre-selected members.permissions
- an instance of IGroupsManagerPermissions
PortalException
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |