OSID - osid.communication.Communique Service Interface Definition

Interface	osid.communication.Communique
Implements	`osid.OsidObject`
Description	A communique is a message to a user handled through an application. Communiques may require some form of acknowledgement ranging from a simple confirmation to data input.
Method	getMessage
Description	Gets the message.
Return	`osid.locale.DisplayText`		the message
Compliance	`mandatory`		This method must be implemented.
Method	getLevel
Description	Gets the message level for this communique.
Return	`osid.communication.CommuniqueLevel`		the message level
Compliance	`mandatory`		This method must be implemented.
Method	isResponseRequired
Description	Tests if the provider is blocking for a response. A response may take the form of s simple acknowledgement, a selection among a list of options, or a form input.
Return	`boolean`		`true` if the provider is blocking for a response `false` if no response is required
Compliance	`mandatory`		This method must be implemented.
Method	respondViaOption
Description	Tests if the provider is blocking on a choice selection. If `respondViaForm()` is `true` , then this method must return `false` . If `isResponseRequired()` is `false` and `respondViaOption()` is `true` , then a response is optional.
Return	`boolean`		`true` if the provider accepts a selection input, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResponseOptions
Description	Gets a list of possible response choices to this communique.
Return	`osid.communication.ResponseOption[]`		a list of possible responses
Errors	ILLEGAL_STATE		`respondViaOption()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	respondViaForm
Description	Tests if the provider is blocking on a form input. If `respondViaOption()` is `true` , then this method must return `false` . If `isResponseRequired()` is false and `respondViaForm()` is `true` , then a response is optional.
Return	`boolean`		`true` if the provider accepts form input, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCommuniqueRecord
Description	Gets the communique record corresponding to the given `Communique` record `Type` . This method is used to retrieve an object implementing the requested record. The `communiqueRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(communiqueRecordType)` is `true` .
Parameters	`osid.type.Type`	`communiqueRecordType`	the type of the record to retrieve
Return	`osid.communication.records.CommuniqueRecord`		the communique record
Errors	NULL_ARGUMENT		`communiqueRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(communiqueRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.