Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Member

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Member
extends CollaborationObject, PersistentBaseObject

Classes that implement the Member interface represent a member of a teamspace, and provides access to a member's email address, notification preferences, and security access level.


Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static int ENTERPRISE_GROUP_SECURITY_MEMBER
          Value of 2001; Represents an Enterprise GROUP security member, granted certain rights to access a teamspace.
static int ENTERPRISE_USER_SECURITY_MEMBER
          Value of 2000; Represents an Enterprise USER security member, granted certain rights to access a teamspace.
static java.lang.String MEMBERACCESSLEVEL_SYMNAME
          Value of "MemberSecurityDefinitionID"; Content Engine property.
static int MEMBERDOMAINNAME_MAXLEN
          Maximum length of member domain name string(512); Content Engine property.
static java.lang.String MEMBERDOMAINNAME_SYMNAME
          Value of "MemberDomainName"; Content Engine property.
static int MEMBEREMAILADDRESS_MAXLEN
          Maximum length of member email address string(128); Content Engine property.
static java.lang.String MEMBEREMAILADDRESS_SYMNAME
          Value of "MemberEmailAddress"; Content Engine property.
static java.lang.String MEMBERID_SYMNAME
          Value of "MemberID"; Content Engine property.
static java.lang.String MEMBERNAME_SYMNAME
          Value of "MemberName"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String MEMBERSHORTNAME_SYMNAME
          Value of "MemberShortName"; Content Engine property.
static java.lang.String MEMBERTYPE_SYMNAME
          Value of "MemberType"; Content Engine property.
static java.lang.String[] PROPERTIES
           
static java.lang.String[] QUERYPROPERTIES
          String array of Member persistent property names that may be queried.
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
static int TEAMSPACE_MEMBER
          Value of 1; Represents an active teamspace member.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "Teamspace"; Content Engine property.
 
Method Summary
 void generateObjectPermissions(java.lang.String teamspaceObjectName, com.filenet.wcm.api.Permissions objectPermissions)
          
 AccessLevelsDefinition getAccessLevel()
          Returns the access level definition for a teamspace member.
 java.lang.String getMailAddress()
          Returns the email address of the teamspace member.
 int getMemberType()
          Returns the type of teamspace member, TEAMSPACE, ENTERPRISE SECURITY USER or GROUP.
 SubjectInfo getSubjectInfo()
          Returns a SubjectInfo object for the current member.
 Teamspace getTeamspace()
          Returns the teamspace where the member is in.
 
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

ENTERPRISE_GROUP_SECURITY_MEMBER

public static final int ENTERPRISE_GROUP_SECURITY_MEMBER
Value of 2001; Represents an Enterprise GROUP security member, granted certain rights to access a teamspace.

ENTERPRISE_USER_SECURITY_MEMBER

public static final int ENTERPRISE_USER_SECURITY_MEMBER
Value of 2000; Represents an Enterprise USER security member, granted certain rights to access a teamspace.

TEAMSPACE_MEMBER

public static final int TEAMSPACE_MEMBER
Value of 1; Represents an active teamspace member.

MEMBERID_SYMNAME

public static final java.lang.String MEMBERID_SYMNAME
Value of "MemberID"; Content Engine property.

MEMBERTYPE_SYMNAME

public static final java.lang.String MEMBERTYPE_SYMNAME
Value of "MemberType"; Content Engine property.

MEMBERNAME_SYMNAME

public static final java.lang.String MEMBERNAME_SYMNAME
Value of "MemberName"; Content Engine property.

MEMBERSHORTNAME_SYMNAME

public static final java.lang.String MEMBERSHORTNAME_SYMNAME
Value of "MemberShortName"; Content Engine property.

MEMBERDOMAINNAME_SYMNAME

public static final java.lang.String MEMBERDOMAINNAME_SYMNAME
Value of "MemberDomainName"; Content Engine property.

MEMBEREMAILADDRESS_SYMNAME

public static final java.lang.String MEMBEREMAILADDRESS_SYMNAME
Value of "MemberEmailAddress"; Content Engine property.

MEMBEREMAILADDRESS_MAXLEN

public static final int MEMBEREMAILADDRESS_MAXLEN
Maximum length of member email address string(128); Content Engine property.

MEMBERDOMAINNAME_MAXLEN

public static final int MEMBERDOMAINNAME_MAXLEN
Maximum length of member domain name string(512); Content Engine property.

MEMBERACCESSLEVEL_SYMNAME

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

TEAMSPACE_SYMNAME

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

QUERYPROPERTIES

public static final java.lang.String[] QUERYPROPERTIES
String array of Member persistent property names that may be queried.
Method Detail

getMemberType

public int getMemberType()
Returns the type of teamspace member, TEAMSPACE, ENTERPRISE SECURITY USER or GROUP.

Returns:
An int value that specifies the type of member.

getAccessLevel

public AccessLevelsDefinition getAccessLevel()
Returns the access level definition for a teamspace member.

Returns:
An AccessLevelDefinition object that specifies the access level of the member.

getMailAddress

public java.lang.String getMailAddress()
Returns the email address of the teamspace member. Enterprise security GROUP and USER members do not have email addresses as they are not active members of a teamspace.

Returns:
A String containing a member's email address.

getSubjectInfo

public SubjectInfo getSubjectInfo()
Returns a SubjectInfo object for the current member.

Returns:
A SubjectInfo object.

generateObjectPermissions

public void generateObjectPermissions(java.lang.String teamspaceObjectName,
                                      com.filenet.wcm.api.Permissions objectPermissions)

Determine the security access level given a member for a given object and add them to the set of permissions.

Parameters:
teamspaceObjectName - The symbolic name of an object within a teamspace.

objectPermissions - A collection of permissions.

getTeamspace

public Teamspace getTeamspace()
Returns the teamspace where the member is in.

Returns:
A Teamspace object.

Collaboration API Documentation

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