|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Classes that implement the Meeting
interface represent online meetings or other types of meetings
that are scheduled in the teamspace environment.
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 |
public static final java.lang.String AGENDA_SYMNAME
public static final java.lang.String COLLABORATIONTYPE_SYMNAME
public static final java.lang.String CONNECTIONACCESSKEY_SYMNAME
public static final java.lang.String ENDDATETIME_SYMNAME
public static final java.lang.String MEETINGDEFNAME_SYMNAME
public static final java.lang.String MEETINGTYPE_SYMNAME
public static final java.lang.String MEMBERID_SYMNAME
public static final java.lang.String MEMBERSHIPMANAGEDSECURITY_SYMNAME
public static final java.lang.String PARTICIPANTS_SYMNAME
public static final java.lang.String PURPOSE_SYMNAME
public static final java.lang.String SECURITYOWNERID_SYMNAME
public static final java.lang.String SESSIONS_SYMNAME
public static final java.lang.String STARTDATETIME_SYMNAME
public static final java.lang.String TEAMSPACE_SYMNAME
public static final java.lang.String UPDATESEQUENCE_SYMNAME
public static final java.lang.String VENDORATTENDLINKBASE_SYMNAME
public static final java.lang.String VENDORMEETINGID_SYMNAME
public static final java.lang.String VENDORSTARTLINKBASE_SYMNAME
public static final java.lang.String VENDORTYPE_SYMNAME
public static final java.lang.String[] PROPERTIES
public static final java.lang.String TYPE_ONLINE
Method Detail |
public void cancel() throws NonTeamspaceMemberException
NonTeamspaceObjectException
- public void delete() throws NonTeamspaceMemberException
NonTeamspaceObjectException
- public java.lang.String getAttendLink()
String
value containing a URL.public SubjectInfo getHost()
SubjectInfo
object representing the meeting host.
SubjectInfo
object representing the meeting host.public SubjectInfo[] getParticipantsInfo()
SubjectInfo
objects representing
all meeting participants except the host member.
SubjectInfo
objects representing
all meeting participants except the host member.
Returns an empty array if no participants have been specified.public java.util.Iterator getParticipants()
Participant
objects representing
all meeting participants except the host member.
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.public java.lang.String getLink()
String
value containing a URL.public com.filenet.wcm.api.Properties getProperties(java.lang.String[] propNames)
getProperties
in interface PersistentBaseObject
propNames
- The names of the properties to be returned.
Properties
list object containing Property objects.public com.filenet.wcm.api.TransportInputStream getVCalendar() throws NonExistentParticipantException
TransportInputStream
object containing the VCALENDAR information for the meeting.NonExistentParticipantException
- public java.lang.String getStartLink()
String
value containing a URL.public boolean isMeetingType(java.lang.String meetingType)
meetingType
- The type of meeting for which to check.
boolean
value.public void notifyParticipants(int notifyType) throws NonTeamspaceMemberException
notifyType
- The type of notification to send.NonTeamspaceMemberException
- public void setProperties(com.filenet.wcm.api.Properties props) throws ValidationException
setProperties
in interface PersistentBaseObject
props
- The properties to be set on the meeting.ValidationException
- public void setConnectionCredentials(java.lang.String vendorUserID, java.lang.String vendorPassword, boolean saveCredentials)
vendorUserID
- The user ID for the vendor site.
vendorPassword
- The password for the vendor site.
saveCredentials
- True if the credentials should be saved.public void updateParticipants(SubjectInfo[] addParticipants, SubjectInfo[] removeParticipants) throws NonExistentParticipantException, DuplicateParticipantException, RemoveHostParticipantException, NonTeamspaceMemberException
Participant
objects..
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.
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
- public void bulkUpdate(java.util.Map data) throws ValidationException
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)
data
- Data to update meeting properties.ValidationException
- public java.lang.String getAgenda()
String
containing the meeting agenda.public java.lang.String getDefinitionName()
String
containing the meeting definition name.public java.util.Date getEndDateTime()
Date
containing the meeting end date and time.public java.lang.String getPurpose()
String
containing the meeting's purpose.public java.util.Date getStartDateTime()
Date
containing the meeting start date and time.public Teamspace getTeamspace()
Teamspace
object for the scheduled meeting.public java.lang.String getConnectionPassword()
String
containing the password.public java.lang.String getConnectionUserID()
String
containing the user ID.public boolean getSaveConnectionCredentialsFlag()
boolean
value that is true if the connection credentials are to be saved.public void setAccessKey(java.lang.String accessKey) throws NonTeamspaceMemberException, ValidationException, EncryptionException, ConfigurationException
accessKey
- A String
containing the meeting access key.NonTeamspaceMemberException
- ValidationException
- EncryptionException
- ConfigurationException
- public void setAgenda(java.lang.String agenda) throws ValidationException
agenda
- The meeting's agenda.ValidationException
- public void setDateTimes(java.util.Date startDateTime, java.util.Date endDateTime) throws ValidationException
startDateTime
- The meeting start date/time.
endDateTime
- The meeting end date/time.ValidationException
- public void setParticipants(SubjectInfo[] participants) throws NonTeamspaceMemberException, NonExistentParticipantException, RemoveHostParticipantException, DuplicateParticipantException
participants
- A SubjectInfo array
containing information about the participants to invite to the meeting.NonTeamspaceMemberException
- NonExistentParticipantException
- RemoveHostParticipantException
- DuplicateParticipantException
- public void setPurpose(java.lang.String purpose) throws ValidationException
purpose
- The meeting's purpose.ValidationException
-
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |