Collaboration API Documentation

com.filenet.bso.api.collaboration.store
Interface AccessLevelsStore


public interface AccessLevelsStore

A class that implements the AccessLevelsStore interface provides access to AccessLevelsDefinition objects in the Collaboration Store. These objects define security access levels that can be assigned to teamspace members.

See Also:
AccessLevelsDefinition, Member, MemberInfo, Teamspace, MemberManager

Field Summary
static java.lang.String ACCESSLEVEL_DEFINITION_CLASSNAME
           
 
Method Summary
 void getAccessAliasRights(java.lang.String aliasName, java.util.List accessRights)
          Merge the integer-based access rights for the given alias with the list of rights passed in.
 AccessLevelsDefinition getAccessLevelsDefinitionByID(java.lang.String definitionID)
          Return an AccessLevelsDefinition object from the Collaboration Store based on the unique access level definition ID.
 AccessLevelsDefinition getAccessLevelsDefinitionByName(java.lang.String name)
          Return an AccessLevelsDefinition object from the Collaboration Store based on the symbolic name of the access level.
 java.util.Iterator getAccessLevelsDefinitions(int accessLevelTypeMask)
          Return an iterator over the collection of AccessLevelsDefinition objects in the Collaboration Store.
 java.lang.String getAccessLevelsDefinitionsXML(int accessLevelTypeMask)
          Return an XML string containing all AccessLevelsDefinition objects in the Collaboration Store.
 

Field Detail

ACCESSLEVEL_DEFINITION_CLASSNAME

public static final java.lang.String ACCESSLEVEL_DEFINITION_CLASSNAME
Method Detail

getAccessLevelsDefinitions

public java.util.Iterator getAccessLevelsDefinitions(int accessLevelTypeMask)
Return an iterator over the collection of AccessLevelsDefinition objects in the Collaboration Store.

Parameters:
accessLevelTypeMask - A mask value that specifies the type of access levels to return (MEMBER or GUEST).

Returns:
An iterator over a collection of AccessLevelsDefinition objects.

getAccessLevelsDefinitionByID

public AccessLevelsDefinition getAccessLevelsDefinitionByID(java.lang.String definitionID)
Return an AccessLevelsDefinition object from the Collaboration Store based on the unique access level definition ID.

Parameters:
definitionID - The definition ID of the access level (the Content Engine version series ID of the underlying document).

Returns:
An AccessLevelsDefinition object.

getAccessLevelsDefinitionByName

public AccessLevelsDefinition getAccessLevelsDefinitionByName(java.lang.String name)
Return an AccessLevelsDefinition object from the Collaboration Store based on the symbolic name of the access level.

Parameters:
name - The name of the access level.

Returns:
An AccessLevelsDefinition object.

getAccessAliasRights

public void getAccessAliasRights(java.lang.String aliasName,
                                 java.util.List accessRights)
Merge the integer-based access rights for the given alias with the list of rights passed in.

Parameters:
aliasName - A security access alias name, as defined in a access alias configuration file.

accessRights - A list of integer-based access rights. Cannot be null.

getAccessLevelsDefinitionsXML

public java.lang.String getAccessLevelsDefinitionsXML(int accessLevelTypeMask)
Return an XML string containing all AccessLevelsDefinition objects in the Collaboration Store.

Parameters:
accessLevelTypeMask - A mask value that specifies the type of access levels to return (MEMBER or GUEST).

Returns:
An XML String.

Collaboration API Documentation

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