Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Teamspace

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Teamspace
extends CollaborationObject, PersistentBaseObject

Classes that implement the Teamspace interface provide a collaborative work environment.

Teamspace Collaboration functionality includes:

See Also:
MemberManager, ContainerManager, UserSubscriptionManager, Task

Field Summary
static java.lang.String APPLICATIONID_SYMNAME
          Value of "CollaborationApplicationID"; Content Engine property.
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String ISACTIVE_PROP_SYMNAME
          Value of "IsActive"; Content Engine property.
static java.lang.String ISTEMPLATE_PROP_SYMNAME
          Value of "IsTemplate"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String PERCENTCOMPLETE_PROP_SYMNAME
          Value of "PercentageComplete"; Content Engine property.
static java.lang.String[] PROPERTIES
           
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
 
Method Summary
 void bulkUpdate(java.util.Map teamspaceData)
          Perform a bulk update of teamspace properties.
 void checkAccessControl(AccessControlInfo info)
          Check access control for a single operation on a single object.
 void checkAccessControl(AccessControlInfo[] infos)
          Check access controls for a collection of operations and objects.
 void deactivate()
          Deactivate this teamspace.
 java.lang.String getApplicationID()
          Return the application ID associated with the teamspace.
 ContainerManager getContainerManager()
          Returns the container manager object for this Teamspace.
 ContentManager getContentManager()
          Returns the content manager object for this Teamspace.
 java.lang.String getCurrentApplicationID()
          Return the current application ID.
 Task getCurrentTask()
          Returns a Task object, if any, that is currently associated with this instance of the teamspace.
 java.lang.String getCurrentUserID()
           
 java.lang.String getDescription()
          Returns the description assigned to this Teamspace object.
 MemberManager getMemberManager()
          Returns the member manager object for this Teamspace.
 java.lang.String getName()
          Returns the name assigned to this Teamspace object.
 int getPercentComplete()
          Returns a int value between 0-100 that specifies the percentage of the teamspace's work that has been completed.
 RelationshipManager getRelationshipManager()
          Returns the link manager object for this Teamspace.
 UserSubscriptionManager getSubscriptionManager()
          Returns the subscription manager object for this Teamspace.
 com.filenet.wcm.api.Folder getTopLevelFolder()
          Returns the top-level content folder of the teamspace.
 com.filenet.wcm.api.TransportInputStream getVCard()
          Return a vCard for this teamspace.
 filenet.vw.api.VWSession getVWSession()
          Returns the VWSession object associated with the Teamspace.
 boolean isActive()
          Return TRUE if this teamspace is active, not deactivated.
 boolean isTemplate()
          Return TRUE if this this teamspace is a template.
 void setCurrentApplicationID(java.lang.String currentApplicationID)
          Set the current application ID.
 
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

ISTEMPLATE_PROP_SYMNAME

public static final java.lang.String ISTEMPLATE_PROP_SYMNAME
Value of "IsTemplate"; Content Engine property.

ISACTIVE_PROP_SYMNAME

public static final java.lang.String ISACTIVE_PROP_SYMNAME
Value of "IsActive"; Content Engine property.

PERCENTCOMPLETE_PROP_SYMNAME

public static final java.lang.String PERCENTCOMPLETE_PROP_SYMNAME
Value of "PercentageComplete"; Content Engine property.

COLLABORATION_TYPE_SYMNAME

public static final java.lang.String COLLABORATION_TYPE_SYMNAME
Value of "CollaborationType"; 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.

APPLICATIONID_SYMNAME

public static final java.lang.String APPLICATIONID_SYMNAME
Value of "CollaborationApplicationID"; Content Engine property.

PROPERTIES

public static final java.lang.String[] PROPERTIES
Method Detail

getMemberManager

public MemberManager getMemberManager()
Returns the member manager object for this Teamspace.

Returns:
MemberManager.

getCurrentUserID

public java.lang.String getCurrentUserID()
Returns:
the LDAP id of the user who requested this object

getRelationshipManager

public RelationshipManager getRelationshipManager()
Returns the link manager object for this Teamspace.

Returns:
LinkManager.

getTopLevelFolder

public com.filenet.wcm.api.Folder getTopLevelFolder()
Returns the top-level content folder of the teamspace.

Returns:
top-level content Folder.

getContainerManager

public ContainerManager getContainerManager()
Returns the container manager object for this Teamspace.

Returns:
ContainerManager.

getSubscriptionManager

public UserSubscriptionManager getSubscriptionManager()
Returns the subscription manager object for this Teamspace.

Returns:
MemberManager.

getContentManager

public ContentManager getContentManager()
Returns the content manager object for this Teamspace.

Returns:
ContentManager.

getCurrentTask

public Task getCurrentTask()
Returns a Task object, if any, that is currently associated with this instance of the teamspace. A Task object becomes associated with an instance of a teamspace when a teamspace is retrieved via the Task interface's getTeamspace() method, or a teamspace object is returned from a CollaborationFactory getTeamspace method in which a Task object was passed in as a parameter.

Returns:
A Task object; may return null if this teamspace has no associated Task object.

getVWSession

public filenet.vw.api.VWSession getVWSession()
Returns the VWSession object associated with the Teamspace.

Returns:
VWSession.

getName

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

Returns:
A String containing the Teamspace name.

getDescription

public java.lang.String getDescription()
Returns the description assigned to this Teamspace object.

Returns:
A String containing the Teamspace description.

getPercentComplete

public int getPercentComplete()
Returns a int value between 0-100 that specifies the percentage of the teamspace's work that has been completed. This value is manually set.

Returns:
An int value.

isTemplate

public boolean isTemplate()
Return TRUE if this this teamspace is a template.

Returns:
A boolean value.

isActive

public boolean isActive()
Return TRUE if this teamspace is active, not deactivated.

Returns:
A boolean value.

deactivate

public void deactivate()
                throws UserRightsException,
                       ValidationException
Deactivate this teamspace.

Throws:
UserRightsException - if user does not have rights to deactivate the teamspace.

checkAccessControl

public void checkAccessControl(AccessControlInfo info)
Check access control for a single operation on a single object.

checkAccessControl

public void checkAccessControl(AccessControlInfo[] infos)
Check access controls for a collection of operations and objects.

getApplicationID

public java.lang.String getApplicationID()
Return the application ID associated with the teamspace.
Returns:
the application ID associated with the teamspace
See Also:
which returns the application ID used by the current user when logging on to the current object store (i.e., the Java session).

getCurrentApplicationID

public java.lang.String getCurrentApplicationID()
Return the current application ID. This will, by default, be the application ID that was used by the logged on user when establishing the JavaAPI session to the current object store, but may be changed to some other value if setCurrentApplicationID had been called previously.
Returns:
the current application ID
See Also:
which returns the application ID used when creating the teamspace., which will set this to any desired value.

setCurrentApplicationID

public void setCurrentApplicationID(java.lang.String currentApplicationID)
Set the current application ID.
Parameters:
currentApplicationID -  
See Also:
which will return the current setting.

getVCard

public com.filenet.wcm.api.TransportInputStream getVCard()
Return a vCard for this teamspace.
Returns:
a TransportInputStream for the teamspace's vCard information

bulkUpdate

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

TITLE_SYMNAME (String)

DESCRIPTION_SYMNAME (String)

PERCENTCOMPLETE_PROP_SYMNAME (Integer)

Parameters:
teamspaceData - Data to update teamspace properties.

Throws:
NonTeamspaceMemberException - if update attempted by non-teamspace member.

Collaboration API Documentation

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