|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A class that implements the MemberManager
interface provides functionality to manage members of a teamspace.
Member
,
MemberInfo
Method Summary | |
void |
generateObjectPermissions(java.lang.String objectSymbolicName,
com.filenet.wcm.api.Permissions permissions)
Generate teamspace wide permissions for a given object based on the current membership. |
Member |
getCurrentMember()
Return a BsoTeamspaceMember object which represents the current logged on teamspace member. |
Member |
getMember(java.lang.String memberID)
Return a BsoTeamspaceMember object which represents the teamspace member. |
Member |
getMemberByObjectID(java.lang.String memberObjectID)
Return a BsoTeamspaceMember object which represents the teamspace member. |
java.util.Iterator |
getMembers(java.lang.Integer[] memberTypes)
Return an iterator over a collection of Member objects which represents all teamspace members. |
java.lang.String |
getMembersXML(java.lang.Integer[] memberTypes,
java.lang.String[] properties,
OrderBy[] sortOrder)
Return all the members for this teamspace, returned as XML. |
void |
refresh()
Force refresh of membership data. |
void |
updateMembership(MemberInfo[] newMemberDefinitions,
java.lang.String[] removeMemberObjectIDs,
java.util.Map data)
Update membership by adding zero or more members, and removing zero or more members. |
Method Detail |
public Member getMember(java.lang.String memberID)
BsoTeamspaceMember
object which represents the teamspace member. May be null if
the member ID given does not match any member of the teamspace.
memberID
- The LDAP id of a member. Required.
Member
object.public Member getMemberByObjectID(java.lang.String memberObjectID)
BsoTeamspaceMember
object which represents the teamspace member. May be null if
the member object ID given does not match any member object in the teamspace.
memberObjectID
- The GUID of the Content Engine member object. Required.
Member
object.public java.util.Iterator getMembers(java.lang.Integer[] memberTypes)
Member
objects which represents all teamspace members.
memberTypes
- An array of integer member types that define what type of members are returned. If null, all members returned.
Member
objects.public Member getCurrentMember()
BsoTeamspaceMember
object which represents the current logged on teamspace member.
Member
object.public void updateMembership(MemberInfo[] newMemberDefinitions, java.lang.String[] removeMemberObjectIDs, java.util.Map data) throws DuplicateMemberException, NonTeamspaceMemberException, ValidationException
newMemberDefinitions
- A set of MemberInfo
objects that provides information used to create a new teamspace members. May be null.
removeMemberObjectIDs
- A set of member object IDs (GUIDs) that reference members to be removed. May be null.
data
- Data to update member properties. The key is the member ID and its value is another Map object that contains a propertySymName and propertyValue pair.
The member properties that can be updated include (by property name, type):
MEMBERACCESSLEVEL_SYMNAME (String)
MEMBEREMAILADDRESS_SYMNAME (String)
DuplicateMemberException
- if an existing member is added to the teamspace.NonTeamspaceMemberException
- if update is attempted by non-teamspace member.BsoRuntimeException
- for any other error.public void generateObjectPermissions(java.lang.String objectSymbolicName, com.filenet.wcm.api.Permissions permissions)
objectSymbolicName
- A String
that provides the symbolic name of a teamspace object. Required.
permissions
- A Permissions
object to hold the generated permissions. Required.public java.lang.String getMembersXML(java.lang.Integer[] memberTypes, java.lang.String[] properties, OrderBy[] sortOrder)
memberTypes
- An array of integer member types that define what type of members are returned. If null, all members are returned.
properties
- A String
array containing the property
names to include in the XML, may be null.
sortOrder
- An OrderBy
array that contains the property name and
sort order (ASCENDING_SORT or DESCENDING_SORT) for each property value
selected to sort on. Optional, may be null.
public void refresh()
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |