Interface CommunicationProxyManager

All Superinterfaces:

AutoCloseable, Closeable, CommunicationProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface CommunicationProxyManager
extends OsidProxyManager, CommunicationProfile

The communication manager provides access to locale sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy for passing information from server environments. The sessions included in this manager are:

• CommunicationSession : a session to receive communications

Method Summary

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

Methods inherited from interface Closeable

close

Methods inherited from interface CommunicationProfile

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

Modifier and Type	Method	Description
TypeList	getCommuniqueRecordTypes()	Gets the supported Communique record types.
TypeList	getResponseOptionRecordTypes()	Gets the supported ResponseOption record types.
TypeList	getResponseRecordTypes()	Gets the supported Response record types.
boolean	supportsCommunication()	Tests if a communication service is available.
boolean	supportsCommuniqueRecordType(Type communiqueRecordType)	Tests if the given Communique record type is supported.
boolean	supportsResponseOptionRecordType(Type responseOptionRecordType)	Tests if the given ResponseOption record type is supported.
boolean	supportsResponseRecordType(Type responseRecordType)	Tests if the given Response record type is supported.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getCommunicationSession

CommunicationSession getCommunicationSession(CommunicationReceiver receiver,
 Proxy proxy)
                                      throws OperationFailedException

Gets an OsidSession associated with the communication service.

Parameters:

receiver - the communication receiver

proxy - a proxy

Returns:

a CommunicationSession

Throws:

NullArgumentException - receiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCommunication() is false

Compliance:

optional - This method must be implemented if {@code supportsCommunication()} is {@code true} .