Collaboration API Documentation

com.filenet.bso.api.collaboration.store
Interface MeetingsStore


public interface MeetingsStore

A class that implements the MeetingsStore interface provides access to MeetingDefinition objects in the Collaboration Store. These objects define templates for meetings that can be scheduled within a teamspace.

See Also:
MeetingDefinition, Meeting, MeetingSession

Method Summary
 MeetingDefinition getMeetingDefinitionByID(java.lang.String id)
          Return a MeetingDefinition object from the Collaboration Store based on the unique meeting definition ID.
 MeetingDefinition getMeetingDefinitionByName(java.lang.String name)
          Return a MeetingDefinition object from the Collaboration Store based on the symbolic name of the meeting definition.
 java.util.Iterator getMeetingDefinitions()
          Return an iterator over the collection of MeetingDefinition objects in the Collaboration Store.
 java.lang.String getMeetingDefinitionsXML()
          Return an XML string with all MeetingDefinition objects in the Collaboration Store.
 boolean hasConnectionCredentials(java.lang.String subjectID, java.lang.String connectionAccessId)
          Determine if the specified user has stored security credentials to create meetings with the specified connection template.
 void saveConnectionCredentials(java.lang.String subjectID, java.lang.String vendorUserID, java.lang.String vendorPassword, java.lang.String connAccessID, SubjectInfo ownerInfo)
          Sets the vendor-specific credentials to use for the meeting connection.
 

Method Detail

getMeetingDefinitionByID

public MeetingDefinition getMeetingDefinitionByID(java.lang.String id)
Return a MeetingDefinition object from the Collaboration Store based on the unique meeting definition ID.

Parameters:
id - The ID of the meeting definition.

Returns:
A MeetingDefinition object.

getMeetingDefinitionByName

public MeetingDefinition getMeetingDefinitionByName(java.lang.String name)
Return a MeetingDefinition object from the Collaboration Store based on the symbolic name of the meeting definition.

Parameters:
name - The name of the meeting definition.

Returns:
A MeetingDefinition object.

getMeetingDefinitions

public java.util.Iterator getMeetingDefinitions()
Return an iterator over the collection of MeetingDefinition objects in the Collaboration Store.

Returns:
An iterator over a collection of MeetingDefinition objects.

getMeetingDefinitionsXML

public java.lang.String getMeetingDefinitionsXML()
Return an XML string with all MeetingDefinition objects in the Collaboration Store.

Returns:
A XML String.

hasConnectionCredentials

public boolean hasConnectionCredentials(java.lang.String subjectID,
                                        java.lang.String connectionAccessId)
Determine if the specified user has stored security credentials to create meetings with the specified connection template.

param subjectID Subject ID for the user.

param connectionAccessId ID of the Connection Access Template.

Returns:
A boolean value, true if the user has stored credentials to use with the specified connection template to create meetings.

saveConnectionCredentials

public void saveConnectionCredentials(java.lang.String subjectID,
                                      java.lang.String vendorUserID,
                                      java.lang.String vendorPassword,
                                      java.lang.String connAccessID,
                                      SubjectInfo ownerInfo)
                               throws EncryptionException,
                                      ConfigurationException
Sets the vendor-specific credentials to use for the meeting connection.

Parameters:
subjectID - The subject ID of the user to whom the connection credentials belong.

vendorUserID - The user ID to use for the vendor-specific meeting connection.

vendorPassword - The password to use for the vendor-specific meeting connection.

connAccessID - The ID of the connection access template with which these credentials are used.

ownerInfo - The user information for the user who has security ownership of the stored credentials.

Collaboration API Documentation

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