Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Team

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Team
extends CollaborationObject, PersistentBaseObject

Classes that implement the Team interface represent a group of members forming a team within an instance of a Teamspace object.


Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String DESCRIPTION_SYMNAME
          Value of "Description"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String[] PROPERTIES
          String array of Team persistent property names.
static java.lang.String[] QUERYPROPERTIES
          String array of Team persistent property names that are queriable.
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
static java.lang.String TEAMLEADER_SYMNAME
          Value of "TeamLeader"; Content Engine property.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "TeamspaceID"; Content Engine property.
static java.lang.String TITLE_SYMNAME
          Value of "DocumentTitle"; Content Engine property.
 
Method Summary
 void bulkUpdate(java.util.Map teamData)
          Perform a bulk update of team properties.
 java.lang.String getDescription()
          Returns the description of this Team object.
 SubjectInfo getLeaderInfo()
          Returns the leader of this Team object.
 java.util.Iterator getMembers()
          Returns the id of the members assigned to this team, may be null.
 java.lang.String getName()
          Returns the name assigned to the Team object.
 Teamspace getTeamspace()
          Returns the target Teamspace object.
 void updateMembers(java.lang.String[] addMemberIDs, java.lang.String[] removeMemberIDs)
          Update Team members given a list of members to add and a list of members to remove.
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 
Methods inherited from interface com.filenet.bso.api.collaboration.PersistentBaseObject
getBaseObject, getID, getObjectStore, getProperties, isMembershipManagedSecurity, isOwner, refresh, setProperties
 

Field Detail

DESCRIPTION_SYMNAME

public static final java.lang.String DESCRIPTION_SYMNAME
Value of "Description"; Content Engine property.

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME
Value of "TeamspaceID"; Content Engine property.

TITLE_SYMNAME

public static final java.lang.String TITLE_SYMNAME
Value of "DocumentTitle"; Content Engine property.

TEAMLEADER_SYMNAME

public static final java.lang.String TEAMLEADER_SYMNAME
Value of "TeamLeader"; Content Engine property.

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
Value of "MembershipManagedSecurity"; Content Engine property.

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME
Value of "SecurityOwnerID"; Content Engine property.

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
String array of Team persistent property names.

QUERYPROPERTIES

public static final java.lang.String[] QUERYPROPERTIES
String array of Team persistent property names that are queriable.
Method Detail

getTeamspace

public Teamspace getTeamspace()
Returns the target Teamspace object.

Returns:
A Teamspace object.

getName

public java.lang.String getName()
Returns the name assigned to the Team object.

Returns:
A String holding the Team object's name.

getDescription

public java.lang.String getDescription()
Returns the description of this Team object.

Returns:
A String holding the Team object's description.

getLeaderInfo

public SubjectInfo getLeaderInfo()
Returns the leader of this Team object.

Returns:
A String holding the Team object's leader.

getMembers

public java.util.Iterator getMembers()
Returns the id of the members assigned to this team, may be null.

updateMembers

public void updateMembers(java.lang.String[] addMemberIDs,
                          java.lang.String[] removeMemberIDs)
                   throws ValidationException
Update Team members given a list of members to add and a list of members to remove.

Parameters:
addMemberIDs - An array of Strings holding memberIDs of Teamspace members to add as Team members.
removeMemberIDs - An array of Strings holding memberIDs of Teamspace Team members to be removed from Team members.

bulkUpdate

public void bulkUpdate(java.util.Map teamData)
                throws NonTeamspaceMemberException,
                       ValidationException
Perform a bulk update of team properties. The Map parameter contains the new property values keyed by property name. The team properties that are legal to be updated via this method include (by property name, type):

DESCRIPTION_SYMNAME (String)

TEAMLEADER_SYMNAME (String)

TITLE_SYMNAME (String)

Team leader is added to the team membership if the leader is currently not a team member.
Parameters:
teamData - Data to update team properties.
Throws:
NonTeamspaceMemberException - if update attempted by non-teamspace member.
ValidationException -  

Collaboration API Documentation

Copyright ?2002 - 2005 FileNet Corporation. All rights reserved.