Collaboration API Documentation

com.filenet.bso.api.collaboration
Interface Meeting

All Superinterfaces:
CollaborationObject, Container, FolderContainer, PersistentBaseObject

public interface Meeting
extends FolderContainer

Classes that implement the Meeting interface represent online meetings or other types of meetings that are scheduled in the teamspace environment.

See Also:
MeetingSession

Field Summary
static java.lang.String AGENDA_SYMNAME
          Content Engine property name
static java.lang.String COLLABORATIONTYPE_SYMNAME
           
static java.lang.String CONNECTIONACCESSKEY_SYMNAME
           
static java.lang.String ENDDATETIME_SYMNAME
           
static java.lang.String MEETINGDEFNAME_SYMNAME
           
static java.lang.String MEETINGTYPE_SYMNAME
           
static java.lang.String MEMBERID_SYMNAME
           
static java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
           
static java.lang.String PARTICIPANTS_SYMNAME
           
static java.lang.String[] PROPERTIES
           
static java.lang.String PURPOSE_SYMNAME
           
static java.lang.String SECURITYOWNERID_SYMNAME
           
static java.lang.String SESSIONS_SYMNAME
           
static java.lang.String STARTDATETIME_SYMNAME
           
static java.lang.String TEAMSPACE_SYMNAME
           
static java.lang.String TYPE_ONLINE
          Value of meeting type that represents an Online meeting.
static java.lang.String UPDATESEQUENCE_SYMNAME
           
static java.lang.String VENDORATTENDLINKBASE_SYMNAME
           
static java.lang.String VENDORMEETINGID_SYMNAME
           
static java.lang.String VENDORSTARTLINKBASE_SYMNAME
           
static java.lang.String VENDORTYPE_SYMNAME
           
 
Fields inherited from interface com.filenet.bso.api.collaboration.Container
ADD_CONTAINEES_CAPABILITY, ADD_SUBCONTAINERS_CAPABILITY, ASCENDING_SORT, DEACTIVATE_CAPABILITY, DESCENDING_SORT, FIND_BY_ID_CAPABILITY, FIND_BY_NAME_CAPABILITY, HAS_CONTAINEES_CAPABILITY, HAS_SUBCONTAINERS_CAPABILITY, REMOVE_CONTAINEES_CAPABILITY, REMOVE_SUBCONTAINERS_CAPABILITY
 
Method Summary
 void bulkUpdate(java.util.Map data)
          Perform a bulk update of properties.
 void cancel()
          Cancels the meeting without removing the meeting folder and its contents.
 void delete()
          Cancels the meeting and removes the meeting folder and its contents.
 java.lang.String getAgenda()
          Returns the agenda of the meeting.
 java.lang.String getAttendLink()
          Returns a URL to use to attend the online 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 in creating the meeting.
 java.util.Date getEndDateTime()
          Returns the end date/time of the meeting.
 SubjectInfo getHost()
          Returns a SubjectInfo object representing the meeting host.
 java.lang.String getLink()
          Returns a URL to use to start or attend the online meeting.
 java.util.Iterator getParticipants()
          Returns an iterator over an array of Participant objects representing all meeting participants except the host member.
 SubjectInfo[] getParticipantsInfo()
          Returns an array of SubjectInfo objects representing all meeting participants except the host member.
 com.filenet.wcm.api.Properties getProperties(java.lang.String[] propNames)
          Returns the properties for the meeting.
 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.
 java.lang.String getStartLink()
          Returns a URL to use to start the online meeting.
 Teamspace getTeamspace()
          Returns the teamspace where the meeting is scheduled.
 com.filenet.wcm.api.TransportInputStream getVCalendar()
          Returns VCALENDAR infromation for the meeting.
 boolean isMeetingType(java.lang.String meetingType)
          Returns true if this meeting is of the type specified by the patameter.
 void notifyParticipants(int notifyType)
          Sends notification messages to the participants who are invited to the meeting.
 void setAccessKey(java.lang.String 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 to use to connect to the meeting vendor's site.
 void setDateTimes(java.util.Date startDateTime, java.util.Date endDateTime)
          Sets the dates and times at which the first session of the meeting will start and end.
 void setParticipants(SubjectInfo[] participants)
          Sets the participants who are invited to attend the meeting.
 void setProperties(com.filenet.wcm.api.Properties props)
          Sets or modifies the properties for the meeting.
 void setPurpose(java.lang.String purpose)
          Sets the purpose (topic, subject) for the meeting.
 void updateParticipants(SubjectInfo[] addParticipants, SubjectInfo[] removeParticipants)
          Add and remove participants.
 
Methods inherited from interface com.filenet.bso.api.collaboration.FolderContainer
addSubContainer, findSubContainerByID, getEligibleMembers, getSubContainers, getSubContainersXML, removeSubContainer
 
Methods inherited from interface com.filenet.bso.api.collaboration.Container
addContainee, findContaineeByID, findContaineeByName, getContainees, getContaineesXML, getDefinitionID, getName, removeContainee, supports
 
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, isMembershipManagedSecurity, isOwner, refresh
 

Field Detail

AGENDA_SYMNAME

public static final java.lang.String AGENDA_SYMNAME
Content Engine property name

COLLABORATIONTYPE_SYMNAME

public static final java.lang.String COLLABORATIONTYPE_SYMNAME

CONNECTIONACCESSKEY_SYMNAME

public static final java.lang.String CONNECTIONACCESSKEY_SYMNAME

ENDDATETIME_SYMNAME

public static final java.lang.String ENDDATETIME_SYMNAME

MEETINGDEFNAME_SYMNAME

public static final java.lang.String MEETINGDEFNAME_SYMNAME

MEETINGTYPE_SYMNAME

public static final java.lang.String MEETINGTYPE_SYMNAME

MEMBERID_SYMNAME

public static final java.lang.String MEMBERID_SYMNAME

MEMBERSHIPMANAGEDSECURITY_SYMNAME

public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME

PARTICIPANTS_SYMNAME

public static final java.lang.String PARTICIPANTS_SYMNAME

PURPOSE_SYMNAME

public static final java.lang.String PURPOSE_SYMNAME

SECURITYOWNERID_SYMNAME

public static final java.lang.String SECURITYOWNERID_SYMNAME

SESSIONS_SYMNAME

public static final java.lang.String SESSIONS_SYMNAME

STARTDATETIME_SYMNAME

public static final java.lang.String STARTDATETIME_SYMNAME

TEAMSPACE_SYMNAME

public static final java.lang.String TEAMSPACE_SYMNAME

UPDATESEQUENCE_SYMNAME

public static final java.lang.String UPDATESEQUENCE_SYMNAME

VENDORATTENDLINKBASE_SYMNAME

public static final java.lang.String VENDORATTENDLINKBASE_SYMNAME

VENDORMEETINGID_SYMNAME

public static final java.lang.String VENDORMEETINGID_SYMNAME

VENDORSTARTLINKBASE_SYMNAME

public static final java.lang.String VENDORSTARTLINKBASE_SYMNAME

VENDORTYPE_SYMNAME

public static final java.lang.String VENDORTYPE_SYMNAME

PROPERTIES

public static final java.lang.String[] PROPERTIES

TYPE_ONLINE

public static final java.lang.String TYPE_ONLINE
Value of meeting type that represents an Online meeting.
Method Detail

cancel

public void cancel()
            throws NonTeamspaceMemberException
Cancels the meeting without removing the meeting folder and its contents.
Throws:
NonTeamspaceObjectException -  

delete

public void delete()
            throws NonTeamspaceMemberException
Cancels the meeting and removes the meeting folder and its contents.
Throws:
NonTeamspaceObjectException -  

getAttendLink

public java.lang.String getAttendLink()
Returns a URL to use to attend the online meeting.

Returns:
A String value containing a URL.

getHost

public SubjectInfo getHost()
Returns a SubjectInfo object representing the meeting host.

Returns:
A SubjectInfo object representing the meeting host.

getParticipantsInfo

public SubjectInfo[] getParticipantsInfo()
Returns an array of SubjectInfo objects representing all meeting participants except the host member.

Returns:
An array of SubjectInfo objects representing all meeting participants except the host member. Returns an empty array if no participants have been specified.

getParticipants

public java.util.Iterator getParticipants()
Returns an iterator over an array of Participant objects representing all meeting participants except the host member.

Returns:
An Iterator over SubjectInfo objects representing all meeting participants except the host member. Returns an iterator for an empty array if no participants have been specified.

getLink

public java.lang.String getLink()
Returns a URL to use to start or attend the online meeting. If the current member is the host member for the meeting, then the start URL is returned, otherwise the attend URL is.

Returns:
A String value containing a URL.

getProperties

public com.filenet.wcm.api.Properties getProperties(java.lang.String[] propNames)
Returns the properties for the meeting.

Specified by:
getProperties in interface PersistentBaseObject
Parameters:
propNames - The names of the properties to be returned.

Returns:
A Properties list object containing Property objects.

getVCalendar

public com.filenet.wcm.api.TransportInputStream getVCalendar()
                                                      throws NonExistentParticipantException
Returns VCALENDAR infromation for the meeting.

Returns:
A TransportInputStream object containing the VCALENDAR information for the meeting.
Throws:
NonExistentParticipantException -  

getStartLink

public java.lang.String getStartLink()
Returns a URL to use to start the online meeting.

Returns:
A String value containing a URL.

isMeetingType

public boolean isMeetingType(java.lang.String meetingType)
Returns true if this meeting is of the type specified by the patameter.

Parameters:
meetingType - The type of meeting for which to check.

Returns:
A boolean value.

notifyParticipants

public void notifyParticipants(int notifyType)
                        throws NonTeamspaceMemberException
Sends notification messages to the participants who are invited to the meeting.

Parameters:
notifyType - The type of notification to send.
Throws:
NonTeamspaceMemberException -  

setProperties

public void setProperties(com.filenet.wcm.api.Properties props)
                   throws ValidationException
Sets or modifies the properties for the meeting.

Specified by:
setProperties in interface PersistentBaseObject
Parameters:
props - The properties to be set on the meeting.
Throws:
ValidationException -  

setConnectionCredentials

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

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

vendorPassword - The password for the vendor site.

saveCredentials - True if the credentials should be saved.

updateParticipants

public void updateParticipants(SubjectInfo[] addParticipants,
                               SubjectInfo[] removeParticipants)
                        throws NonExistentParticipantException,
                               DuplicateParticipantException,
                               RemoveHostParticipantException,
                               NonTeamspaceMemberException
Add and remove participants. This results in deleting and adding Participant objects..

Parameters:
addParticipants - An array of user subjectInfos to add as participants of the meeting.

removeParticipants - An array of user subjectInfos to remove as participants of the meeting.

Throws:
NonExistentParticipantException - if given a user to remomve who is not a participant.
DuplicateParticipantException - if given a user to add who is already a participant.
RemoveHostParticipantException - if update attempted to remove the host participant.
NonTeamspaceMemberException -  

bulkUpdate

public void bulkUpdate(java.util.Map data)
                throws ValidationException
Perform a bulk update of properties. The Map parameter contains the new property values keyed by property name. The properties that are legal to be updated via this method include (by property name, type):

AGENDA_SYMNAME (String)

ENDDATETIME_SYMNAME (Date)

PURPOSE_SYMNAME (String)

STARTDATETIME_SYMNAME (Date)

Parameters:
data - Data to update meeting properties.
Throws:
ValidationException -  

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 in creating 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.

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 where 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 that is true if the connection credentials are to be saved.

setAccessKey

public void setAccessKey(java.lang.String accessKey)
                  throws NonTeamspaceMemberException,
                         ValidationException,
                         EncryptionException,
                         ConfigurationException
Sets the access key for the meeting.

Parameters:
accessKey - A String containing the meeting access key.
Throws:
NonTeamspaceMemberException -  
ValidationException -  
EncryptionException -  
ConfigurationException -  

setAgenda

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

Parameters:
agenda - The meeting's agenda.
Throws:
ValidationException -  

setDateTimes

public void setDateTimes(java.util.Date startDateTime,
                         java.util.Date endDateTime)
                  throws ValidationException
Sets the dates and times at which the first session of the meeting will start and end.

Parameters:
startDateTime - The meeting start date/time.

endDateTime - The meeting end date/time.
Throws:
ValidationException -  

setParticipants

public void setParticipants(SubjectInfo[] participants)
                     throws NonTeamspaceMemberException,
                            NonExistentParticipantException,
                            RemoveHostParticipantException,
                            DuplicateParticipantException
Sets the participants who are invited to attend the meeting.

Parameters:
participants - A SubjectInfo array containing information about the participants to invite to the meeting.
Throws:
NonTeamspaceMemberException -  
NonExistentParticipantException -  
RemoveHostParticipantException -  
DuplicateParticipantException -  

setPurpose

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

Parameters:
purpose - The meeting's purpose.
Throws:
ValidationException -  

Collaboration API Documentation

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