Collaboration API Documentation

com.filenet.bso.api.collaboration.data
Class MemberInfo

java.lang.Object
  |
  +--com.filenet.bso.api.collaboration.data.MemberInfo
All Implemented Interfaces:
java.io.Serializable

public class MemberInfo
extends java.lang.Object
implements java.io.Serializable

The MemberInfo class is a collection of data used to add a member to a teamspace. A teamspace member is created by generating a MemberInfo object from the CollaborationFactory and adding it to the teamspace using the MemberManager object.

See Also:
CollaborationFactory, MemberManager, Member, Serialized Form

Constructor Summary
protected MemberInfo()
           
  MemberInfo(SubjectInfo subject, int memberType, AccessLevelsDefinition memberSecurityDef)
          Constructor to create a MemberInfo object.
 
Method Summary
 void generateObjectPermissions(com.filenet.wcm.api.ObjectStore store, java.lang.String objectName, com.filenet.wcm.api.Permissions objectPermissions, com.filenet.wcm.api.Session session)
          Determine the permissions granted the member for the given teamspace object and add them to the collection.
 java.lang.String getMailAddress()
          Returns the member's email address.
 AccessLevelsDefinition getMemberSecurityDefinition()
          Returns the AccessLevelsDefinition object that determines the security access rights of the member.
 int getMemberType()
          Returns the type of member.
 SubjectInfo getSubjectInfo()
          Returns the SubjectInfo object for this user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MemberInfo

protected MemberInfo()

MemberInfo

public MemberInfo(SubjectInfo subject,
                  int memberType,
                  AccessLevelsDefinition memberSecurityDef)
Constructor to create a MemberInfo object. The MemberInfo object is used to create a Member object.

Parameters:
subject - A SubjectInfo object containing the information necessary to identify the user and the user's email address.
memberType - Types are defined in Member.
memberSecurityDef - An AccessLevelsDefinition used to specify the security level for the user within the teamspace.
See Also:
SubjectInfo, Member, AccessLevelsDefinition
Method Detail

getMailAddress

public java.lang.String getMailAddress()
Returns the member's email address.

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

getMemberType

public int getMemberType()
Returns the type of member.

Returns:
A int containing the member type.

getMemberSecurityDefinition

public AccessLevelsDefinition getMemberSecurityDefinition()
Returns the AccessLevelsDefinition object that determines the security access rights of the member.

Returns:
An AccessLevelsDefinition object that defines security access rights.

getSubjectInfo

public SubjectInfo getSubjectInfo()
Returns the SubjectInfo object for this user.

Returns:
A SubjectInfo object.

generateObjectPermissions

public void generateObjectPermissions(com.filenet.wcm.api.ObjectStore store,
                                      java.lang.String objectName,
                                      com.filenet.wcm.api.Permissions objectPermissions,
                                      com.filenet.wcm.api.Session session)
Determine the permissions granted the member for the given teamspace object and add them to the collection.

Parameters:
store - An ObjectStore in which the object resides and for which permissions are to be generated.
objectName - The name of the teamspace object.
objectPermissions - A collection of object permissions.
session - Content Engine session
See Also:
Permissions, Session

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.