public interface Communique extends OsidObject
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.
Modifier and Type | Method and Description |
---|---|
CommuniqueRecord |
getCommuniqueRecord(Type communiqueRecordType)
Gets the communique record corresponding to the given
Communique record Type. |
CommuniqueLevel |
getLevel()
Gets the message level for this communique.
|
DisplayText |
getMessage()
Gets the message.
|
ResponseOption[] |
getResponseOptions()
Gets a list of possible response choices to this communique.
|
boolean |
isResponseRequired()
Tests if the provider is blocking for a response.
|
boolean |
respondViaForm()
Tests if the provider is blocking on a form input.
|
boolean |
respondViaOption()
Tests if the provider is blocking on a choice selection.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DisplayText getMessage()
mandatory
- This method must be implemented. CommuniqueLevel getLevel()
mandatory
- This method must be implemented. boolean isResponseRequired()
true
if the provider is blocking for a response
false
if no response is requiredmandatory
- This method must be implemented. boolean respondViaOption()
respondViaForm()
is true,
then this method must
return false.
If isResponseRequired()
is
false
and respondViaOption()
is
true,
then a response is optional. true
if the provider accepts a selection input,
false
otherwisemandatory
- This method must be implemented. ResponseOption[] getResponseOptions()
IllegalStateException
- respondViaOption()
is false
mandatory
- This method must be implemented. boolean respondViaForm()
respondViaOption()
is true,
then this method
must return false
. If isResponseRequired()
is false and respondViaForm()
is true
, then a response is optional. true
if the provider accepts form input,
false
otherwisemandatory
- This method must be implemented. CommuniqueRecord getCommuniqueRecord(Type communiqueRecordType) throws OperationFailedException
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
.communiqueRecordType
- the type of the record to retrieveNullArgumentException
- communiqueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(communiqueRecordType)
is false
mandatory
- This method must be implemented.