Interface CommunicationProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

CommunicationManager, CommunicationProxyManager

public interface CommunicationProfile
extends OsidProfile

The communication profile describes the interoperability communication services.

Method Summary

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 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

supportsCommunication

boolean supportsCommunication()

Tests if a communication service is available.

Returns:

true if communication is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

getCommuniqueRecordTypes

TypeList getCommuniqueRecordTypes()

Gets the supported Communique record types.

Returns:

a list containing the supported Communique record types

Compliance:

mandatory - This method must be implemented.

supportsCommuniqueRecordType

boolean supportsCommuniqueRecordType(Type communiqueRecordType)

Tests if the given Communique record type is supported.

Parameters:

communiqueRecordType - a Type indicating a Communique record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - communiqueRecordType is null

Compliance:

mandatory - This method must be implemented.

getResponseOptionRecordTypes

TypeList getResponseOptionRecordTypes()

Gets the supported ResponseOption record types.

Returns:

a list containing the supported ResponseOption record types

Compliance:

mandatory - This method must be implemented.

supportsResponseOptionRecordType

boolean supportsResponseOptionRecordType(Type responseOptionRecordType)

Tests if the given ResponseOption record type is supported.

Parameters:

responseOptionRecordType - a Type indicating a ResponseOption record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - responseOptionRecordType is null

Compliance:

mandatory - This method must be implemented.

getResponseRecordTypes

TypeList getResponseRecordTypes()

Gets the supported Response record types.

Returns:

a list containing the supported Response record types

Compliance:

mandatory - This method must be implemented.

supportsResponseRecordType

boolean supportsResponseRecordType(Type responseRecordType)

Tests if the given Response record type is supported.

Parameters:

responseRecordType - a Type indicating a Response record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - responseRecordType is null

Compliance:

mandatory - This method must be implemented.