org.osid.communication

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

Methods

Modifier and Type	Method and 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 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

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.