Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Participant

All Superinterfaces:
CollaborationObject, PersistentBaseObject

public interface Participant
extends CollaborationObject, PersistentBaseObject

A class that implements the Participant interface represent a participant in a meeting or meeting session.

See Also:
Meeting, MeetingSession

Field Summary
static java.lang.String COLLABORATION_TYPE_SYMNAME
          Value of "CollaborationType"; Content Engine property.
static java.lang.String DIRECTCONTAINER_SYMNAME
          Value of "DirectContainer"; Content Engine property.
static java.lang.String EMAILADDRESS_SYMNAME
          Value of "EmailAddress"; Content Engine property.
static java.lang.String ISENTERPRISEUSER_SYMNAME
          Value of "IsEnterpriseUser"; Content Engine property.
static java.lang.String ISHOST_SYMNAME
          Value of "IsHost"; Content Engine property.
static java.lang.String MEMBERID_SYMNAME
          Value of "MemberID"; Content Engine property.
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
          Value of "MembershipManagedSecurity"; Content Engine property.
static java.lang.String[] PROPERTIES
          String array of persistent Participant properties.
static java.lang.String SECURITYOWNERID_SYMNAME
          Value of "SecurityOwnerID"; Content Engine property.
static java.lang.String TEAMSPACE_SYMNAME
          Value of "Teamspace"; Content Engine property.
static java.lang.String USERDISPLAYNAME_SYMNAME
          Value of "UserDisplayName"; Content Engine property.
 
Method Summary
 Meeting getMeeting()
          Returns the Meeting object that contains this participant.
 SubjectInfo getSubjectInfo()
          Returns a SubjectInfo object for the participant.
 Teamspace getTeamspace()
          Returns the target Teamspace object.
 boolean isEnterpriseUser()
          Returns true if the participant is registered in the enterprise directory.
 boolean isHost()
          Returns true if the participant is the host of the meeting or session.
 
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

DIRECTCONTAINER_SYMNAME

public static final java.lang.String DIRECTCONTAINER_SYMNAME
Value of "DirectContainer"; Content Engine property.

EMAILADDRESS_SYMNAME

public static final java.lang.String EMAILADDRESS_SYMNAME
Value of "EmailAddress"; Content Engine property.

ISHOST_SYMNAME

public static final java.lang.String ISHOST_SYMNAME
Value of "IsHost"; Content Engine property.

MEMBERID_SYMNAME

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

USERDISPLAYNAME_SYMNAME

public static final java.lang.String USERDISPLAYNAME_SYMNAME
Value of "UserDisplayName"; Content Engine property.

ISENTERPRISEUSER_SYMNAME

public static final java.lang.String ISENTERPRISEUSER_SYMNAME
Value of "IsEnterpriseUser"; 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
String array of persistent Participant properties.
Method Detail

getTeamspace

public Teamspace getTeamspace()
Returns the target Teamspace object.

Returns:
A Teamspace object.

getSubjectInfo

public SubjectInfo getSubjectInfo()
Returns a SubjectInfo object for the participant.

Returns:
A SubjectInfo object.

getMeeting

public Meeting getMeeting()
                   throws com.filenet.wcm.api.PropertyNotFoundException
Returns the Meeting object that contains this participant.

Returns:
A Meeting object.

isHost

public boolean isHost()
Returns true if the participant is the host of the meeting or session.

Returns:
A boolean value.

isEnterpriseUser

public boolean isEnterpriseUser()
Returns true if the participant is registered in the enterprise directory.

Returns:
A boolean value.

Collaboration API Documentation

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