Collaboration API Documentation

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

All Superinterfaces:
CollaborationObject

public interface AccessLevelsDefinition
extends CollaborationObject

Classes that implement the AccessLevelsDefinition specify a set of Access Control List (ACL) definitions that are associated with various logical teamspace objects. When this access level definition is assigned to a member of a teamspace, the member is granted the specified access level permissions to objects within the teamspace.

See Also:
Teamspace, AccessLevelsStore

Field Summary
static int ALL_ACCESS_LEVEL_TYPES
          Value of "3"; all access level definition types.
static java.lang.String GUEST_ACCESS_LEVEL_STR
          Value of "guest"; XML value..
static int GUEST_ACCESS_LEVEL_TYPE
          Value of "2"; defines member type access level definition.
static java.lang.String MEMBER_ACCESS_LEVEL_STR
          Value of "member"; XML value.
static int MEMBER_ACCESS_LEVEL_TYPE
          Value of "1"; defines member type access level definition.
static java.lang.String[] PROPERTIES
           
 
Method Summary
 void checkAccessControl(Teamspace teamspace, AccessControlInfo accessControlInfo)
          Determine if this access level definition grants the requested access control.
 void generateAccessLevels(SubjectInfo subjectInfo, java.lang.String teamspaceObjectName, com.filenet.wcm.api.Permissions objectPermissions)
          Generate permissions based on the name of the teamspace object, for the teamspace member of the given type.
 int getAccessLevelType()
          Return the type of the access level definition (MEMBER or GUEST).
 com.filenet.wcm.api.BaseObject getBaseObject()
          Returns a BaseObject, which provides access to the underlying Content Java API object for this object.
 java.lang.String getDefinitionID()
          Return the id of the access level definition in the Collaboration Store.
 java.lang.String getDescription()
          Return the description of the access level definition
 java.lang.String getID()
          Returns the ID (in GUID format) for this object.
 java.lang.String getLabel()
          Return the label of the access level definition
 java.lang.String getName()
          Return the symbolic name of the access level definition
 boolean hasAccess(SubjectInfo subjectInfo, java.lang.String teamspaceObjectName)
          Determine if the subject has access to the teamspace object
 
Methods inherited from interface com.filenet.bso.api.collaboration.CollaborationObject
getSymbolicName, getType
 

Field Detail

PROPERTIES

public static final java.lang.String[] PROPERTIES

MEMBER_ACCESS_LEVEL_TYPE

public static final int MEMBER_ACCESS_LEVEL_TYPE
Value of "1"; defines member type access level definition.

GUEST_ACCESS_LEVEL_TYPE

public static final int GUEST_ACCESS_LEVEL_TYPE
Value of "2"; defines member type access level definition.

ALL_ACCESS_LEVEL_TYPES

public static final int ALL_ACCESS_LEVEL_TYPES
Value of "3"; all access level definition types.

MEMBER_ACCESS_LEVEL_STR

public static final java.lang.String MEMBER_ACCESS_LEVEL_STR
Value of "member"; XML value.

GUEST_ACCESS_LEVEL_STR

public static final java.lang.String GUEST_ACCESS_LEVEL_STR
Value of "guest"; XML value..
Method Detail

getDefinitionID

public java.lang.String getDefinitionID()
Return the id of the access level definition in the Collaboration Store.

Returns:
A String containing the access level definition id.

getName

public java.lang.String getName()
Return the symbolic name of the access level definition

Returns:
A String containing the symbolic name.

getLabel

public java.lang.String getLabel()
Return the label of the access level definition

Returns:
A String containing the label.

getDescription

public java.lang.String getDescription()
Return the description of the access level definition

Returns:
A String containing the description.

getAccessLevelType

public int getAccessLevelType()
Return the type of the access level definition (MEMBER or GUEST).

Returns:
An int values that specifies the type of access level definition.

generateAccessLevels

public void generateAccessLevels(SubjectInfo subjectInfo,
                                 java.lang.String teamspaceObjectName,
                                 com.filenet.wcm.api.Permissions objectPermissions)
Generate permissions based on the name of the teamspace object, for the teamspace member of the given type.

param subjectInfo A SubjectInfo object.

param teamspaceObjectName Symbolic name of teamspace object.

param Permissions A collection of Permission objects.

checkAccessControl

public void checkAccessControl(Teamspace teamspace,
                               AccessControlInfo accessControlInfo)
Determine if this access level definition grants the requested access control. Caller retrieves the state by calling the access control info method isGranted().

param teamspace The teamspace.

param accessControlInfo An AccessControlInfo object that specifies the requested access control.

hasAccess

public boolean hasAccess(SubjectInfo subjectInfo,
                         java.lang.String teamspaceObjectName)
Determine if the subject has access to the teamspace object
Parameters:
subjectInfo - A SubjectInfo object.
teamspaceObjectName - Symbolic name of teamspace object.

getBaseObject

public com.filenet.wcm.api.BaseObject getBaseObject()
Returns a BaseObject, which provides access to the underlying Content Java API object for this object.

Returns:
A BsoBaseObject.

getID

public java.lang.String getID()
Returns the ID (in GUID format) for this object.

Returns:
A String containing an object GUID.

Collaboration API Documentation

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