OSID Specifications
communication package
Version 3.0.0
Release Candidate Preview
communication package
Version 3.0.0
Release Candidate Preview
| Interface | osid.communication.CommunicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session defines methods to process communications. Notifications are cancelled when this session is closed. | ||
| Method | registerForCommuniques | ||
| Description |
Register for notifications of new communiques. | ||
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | acknowledge | ||
| Description |
Sends a nonce response indicating that operations should continue or abort. | ||
| Parameters | osid.id.Id | communiqueId | the Id of a communique |
| Errors | ILLEGAL_STATE | Communique.respondViaOption() or
Communique.respondViaForm() is true , or a response was
already supplied | |
| INVALID_ARGUMENT | communiqueId not valid | ||
| NULL_ARGUMENT | communiqueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | respondViaOption | ||
| Description |
Responds to a communique requiring a response option. | ||
| Parameters | osid.id.Id | responseOptionId | the Id of a response option |
| Errors | ILLEGAL_STATE | Communique.respondViaOption() is false or a response
was already supplied | |
| INVALID_ARGUMENT | responseOptionId not valid | ||
| NULL_ARGUMENT | responseOptionId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseForm | ||
| Description |
Gets the response form for submitting form-based responses. | ||
| Parameters | osid.id.Id | communiqueId | the Id of a communique |
| Return | osid.communication.ResponseForm | a response form | |
| Errors | ILLEGAL_STATE | Communique.respondViaForm() is false | |
| INVALID_ARGUMENT | communiqueId not valid | ||
| NULL_ARGUMENT | communiqueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | respondViaForm | ||
| Description |
Responds to a communique requiring form input. | ||
| Parameters | osid.communication.ResponseForm | responseForm | a response form |
| Errors | ILLEGAL_STATE | responseForm already used in a response transaction | |
| INVALID_ARGUMENT | the form contains an invalid value | ||
| NULL_ARGUMENT | responseForm is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| UNSUPPORTED | responseForm did not originate from getResponseForm()
| ||
| Compliance | mandatory | This method must be implemented. | |