Collaboration API Documentation

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

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

public class MeetingInfo
extends FolderContainerInfo

The MeetingInfo class is a collection of data used to add a meeting to a teamspace. A teamspace meeting is created by instantiating a new MeetingInfo object and adding it to the teamspace using the teamspace meeting container object obtained from the ContainerManager.

See Also:
ContainerManager, FolderContainer, Meeting, Serialized Form

Fields inherited from class com.filenet.bso.api.collaboration.data.FolderContainerInfo
folderName, linkObject, memberID
 
Constructor Summary
protected MeetingInfo()
           
  MeetingInfo(java.lang.String defName, Teamspace teamspace, java.util.Date startDateTime, java.util.Date endDateTime, java.lang.String purpose, java.lang.String agenda, SubjectInfo hostMember, SubjectInfo[] participants)
          Construct a meeting info object with specified data.
 
Method Summary
 byte[] getAccessKey()
          Returns the access key of the meeting.
 java.lang.String getAgenda()
          Returns the agenda of the meeting.
 java.lang.String getConnectionPassword()
          Returns the member's password to use for credentials when connecting to the vendor meeting site.
 java.lang.String getConnectionUserID()
          Returns the member's user ID to use for credentials when connecting to the vendor meeting site.
 java.lang.String getDefinitionName()
          Returns the name of the meeting definition used to create the meeting.
 java.util.Date getEndDateTime()
          Returns the end date/time of the meeting.
 SubjectInfo getHostInfo()
          Returns information about the meeting's host member.
 java.lang.String getHostMemberID()
          Returns the ID of the member who scheduled and hosts the meeting.
 SubjectInfo[] getParticipants()
          Returns an array of SubjectInfo objects representing meeting participants.
 java.lang.String getPurpose()
          Returns the purpose (topic, subject) of the meeting.
 boolean getSaveConnectionCredentialsFlag()
          Returns a boolean flag representing whether the connection credentials should be saved.
 java.util.Date getStartDateTime()
          Returns the start date/time of the meeting.
 Teamspace getTeamspace()
          Returns the teamspace in which the meeting is scheduled.
 void setAccessKey(byte[] accessKey)
          Sets the access key for the meeting.
 void setAgenda(java.lang.String agenda)
          Sets the agenda for the meeting.
 void setConnectionCredentials(java.lang.String vendorUserID, java.lang.String vendorPassword, boolean saveCredentials)
          Sets the connection credentials required to connect to the meeting vendor site.
 void setDefinitionName(java.lang.String defName)
          Sets the name of the meeting definition to use in creating the meeting.
 void setEndDateTime(java.util.Date endDateTime)
          Sets the date and time at which the first session of the meeting will end.
 void setHostMemberID(java.lang.String hostMemberID)
          Sets the ID for the member who will host the meeting.
 void setName(java.lang.String meetingName)
          Sets a name for the meeting.
 void setParticipants(SubjectInfo[] participants)
          Sets meeting participant information.
 void setPurpose(java.lang.String purpose)
          Sets the purpose (topic and subject) for the meeting.
 void setStartDateTime(java.util.Date startDateTime)
          Sets the date and time at which the first session of the meeting will occur.
 
Methods inherited from class com.filenet.bso.api.collaboration.data.FolderContainerInfo
getFolderName, getLinkObject, getOwnerID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MeetingInfo

protected MeetingInfo()

MeetingInfo

public MeetingInfo(java.lang.String defName,
                   Teamspace teamspace,
                   java.util.Date startDateTime,
                   java.util.Date endDateTime,
                   java.lang.String purpose,
                   java.lang.String agenda,
                   SubjectInfo hostMember,
                   SubjectInfo[] participants)
Construct a meeting info object with specified data.

Parameters:
defName - The meeting definition name.

teamspace - The teamspace in which the meeting is scheduled.

startDateTime - The meeting start date/time.

endDateTime - The meeting end date/time.

purpose - The meeting purpose.

agenda - The meeting agenda.

hostMember - The meeting's host member information.

participants - The participants to invite to the meeting.

Method Detail

getAccessKey

public byte[] getAccessKey()
Returns the access key of the meeting.

Returns:
A byte array containing the meeting access key.

getAgenda

public java.lang.String getAgenda()
Returns the agenda of the meeting.

Returns:
A String containing the meeting agenda.

getDefinitionName

public java.lang.String getDefinitionName()
Returns the name of the meeting definition used to create the meeting.

Returns:
A String containing the meeting definition name.

getEndDateTime

public java.util.Date getEndDateTime()
Returns the end date/time of the meeting.

Returns:
A Date containing the meeting end date and time.

getHostMemberID

public java.lang.String getHostMemberID()
Returns the ID of the member who scheduled and hosts the meeting.

Returns:
A String containing the host member ID.

getHostInfo

public SubjectInfo getHostInfo()
Returns information about the meeting's host member.

Returns:
A SubjectInfo containing information about the meeting host.

getParticipants

public SubjectInfo[] getParticipants()
Returns an array of SubjectInfo objects representing meeting participants.

Returns:
An array of SubjectInfo objects holding data about meeting participants.

getPurpose

public java.lang.String getPurpose()
Returns the purpose (topic, subject) of the meeting.

Returns:
A String containing the meeting's purpose.

getStartDateTime

public java.util.Date getStartDateTime()
Returns the start date/time of the meeting.

Returns:
A Date containing the meeting start date and time.

getTeamspace

public Teamspace getTeamspace()
Returns the teamspace in which the meeting is scheduled.

Returns:
A Teamspace object for the scheduled meeting.

getConnectionPassword

public java.lang.String getConnectionPassword()
Returns the member's password to use for credentials when connecting to the vendor meeting site.

Returns:
A String containing the password.

getConnectionUserID

public java.lang.String getConnectionUserID()
Returns the member's user ID to use for credentials when connecting to the vendor meeting site.

Returns:
A String containing the user ID.

getSaveConnectionCredentialsFlag

public boolean getSaveConnectionCredentialsFlag()
Returns a boolean flag representing whether the connection credentials should be saved.

Returns:
A boolean value, true if the connection credentials are to be saved.

setAccessKey

public void setAccessKey(byte[] accessKey)
Sets the access key for the meeting.

Parameters:
accessKey - A byte array containing the meeting access key.

setAgenda

public void setAgenda(java.lang.String agenda)
Sets the agenda for the meeting.

Parameters:
agenda - The meeting agenda.

setDefinitionName

public void setDefinitionName(java.lang.String defName)
Sets the name of the meeting definition to use in creating the meeting.

Parameters:
defName - The meeting definition name.

setEndDateTime

public void setEndDateTime(java.util.Date endDateTime)
Sets the date and time at which the first session of the meeting will end.

Parameters:
endDateTime - The meeting end date/time.

setHostMemberID

public void setHostMemberID(java.lang.String hostMemberID)
Sets the ID for the member who will host the meeting.

Parameters:
hostMemberID - The ID of the meeting's host member.

setParticipants

public void setParticipants(SubjectInfo[] participants)
Sets meeting participant information.

Parameters:
participants - A SubjectInfo array containing information about the members who will be invited to the meeting.

setName

public void setName(java.lang.String meetingName)
Sets a name for the meeting. This is used for the meeting container's folder name in the Content Engine, so it must be unique within a teamspace. If not set, a name is generated by combining the meeting definition name, the host member ID, and the start date and time.

Parameters:
meetingName - The meeting name.

setPurpose

public void setPurpose(java.lang.String purpose)
Sets the purpose (topic and subject) for the meeting.

Parameters:
purpose - The meeting's purpose.

setStartDateTime

public void setStartDateTime(java.util.Date startDateTime)
Sets the date and time at which the first session of the meeting will occur.

Parameters:
startDateTime - The meeting start date/time.

setConnectionCredentials

public void setConnectionCredentials(java.lang.String vendorUserID,
                                     java.lang.String vendorPassword,
                                     boolean saveCredentials)
Sets the connection credentials required to connect to the meeting vendor site.

Parameters:
vendorUserID - The user ID for the vendor site.

vendorPassword - The password for the vendor site.

saveCredentials - Set to true to save the credentials.

Collaboration API Documentation

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