OSID Specifications
communication package
Version 3.1.0
communication package
Version 3.1.0
| Interface | osid.communication.CommunicationProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.communication.CommunicationManager | ||
osid.communication.CommunicationProxyManager | |||
| Description |
The communication profile describes the interoperability communication services. | ||
| Method | supportsCommunication | ||
| Description |
Tests if a communication service is available. | ||
| Return | boolean | true if communication is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCommuniqueRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Communique record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCommuniqueRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | communiqueRecordType | a Type indicating a Communique record type |
| Return | boolean | true if the given record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | communiqueRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseOptionRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported ResponseOption record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResponseOptionRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | responseOptionRecordType | a Type indicating a ResponseOption record type |
| Return | boolean | true if the given record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | responseOptionRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Response record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsResponseRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | responseRecordType | a Type indicating a Response record type |
| Return | boolean | true if the given record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | responseRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |