OSID Logo
OSID Specifications
communication package
Version 3.0.0
Release Candidate Preview
Interfaceosid.communication.CommunicationSession
Implementsosid.OsidSession
Description

This session defines methods to process communications. Notifications are cancelled when this session is closed.

MethodregisterForCommuniques
Description

Register for notifications of new communiques. CommunicationReceiver.newCommunique() is invoked when a new Communique is sent.

ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
Methodacknowledge
Description

Sends a nonce response indicating that operations should continue or abort.

Parametersosid.id.IdcommuniqueIdthe Id of a communique
ErrorsILLEGAL_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_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodrespondViaOption
Description

Responds to a communique requiring a response option.

Parametersosid.id.IdresponseOptionIdthe Id of a response option
ErrorsILLEGAL_STATE Communique.respondViaOption() is false or a response was already supplied
INVALID_ARGUMENT responseOptionId not valid
NULL_ARGUMENT responseOptionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetResponseForm
Description

Gets the response form for submitting form-based responses.

Parametersosid.id.IdcommuniqueIdthe Id of a communique
Returnosid.communication.ResponseForma response form
ErrorsILLEGAL_STATE Communique.respondViaForm() is false
INVALID_ARGUMENT communiqueId not valid
NULL_ARGUMENT communiqueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodrespondViaForm
Description

Responds to a communique requiring form input.

Parametersosid.communication.ResponseFormresponseForma response form
ErrorsILLEGAL_STATE responseForm already used in a response transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT responseForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED responseForm did not originate from getResponseForm()
CompliancemandatoryThis method must be implemented.