org.osid.communication

Interface CommunicationManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, CommunicationProfile, OsidManager, OsidProfile, Sourceable

public interface CommunicationManager
extends OsidManager, CommunicationProfile

The communication manager provides access to locale sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• CommunicationSession: a session to receive communications

Method Summary

Methods

Modifier and Type	Method and Description
CommunicationSession	getCommunicationSession(CommunicationReceiver receiver) Gets an OsidSession associated with the communication service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.communication.CommunicationProfile

getCommuniqueRecordTypes, getResponseOptionRecordTypes, getResponseRecordTypes, supportsCommunication, supportsCommuniqueRecordType, supportsResponseOptionRecordType, supportsResponseRecordType

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCommunicationSession

CommunicationSession getCommunicationSession(CommunicationReceiver receiver)
                                             throws OperationFailedException

Gets an OsidSession associated with the communication service.

Parameters:

receiver - the communication receiver

Returns:

a CommunicationSession

Throws:

NullArgumentException - receiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommunication() is false

Compliance:

optional - This method must be implemented if supportsCommunication() is true.