|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CommandResponse
A command response interface.
Version History
EPG - Initial - 10 APR 06
Nested Class Summary | |
---|---|
static class |
CommandResponse.CompletionDisposition
The completion disposition describes the response. |
static class |
CommandResponse.ResponseState
The response state disposition describes state of the interaction. |
Field Summary | |
---|---|
static long |
serialVersionUID
|
Method Summary | |
---|---|
void |
dispose()
Dispose of the response, command, or anything else that might be associated with this interaction. |
Receipt |
getFinalReceipt()
Get the final receipt. |
ReceiptList |
getReceiptList()
Get the receipt list. |
CommandResponse.ResponseState |
getState()
Get state of the command response. |
Entity<Receipt> |
next()
Get next available submission. |
AttributeReader |
rollup()
Get a rollup of all the attributes. |
CommandResponse.CompletionDisposition |
validateCompletion(boolean throwReason)
Assuming the response is done, was the reponse well formed per the scheme? |
Entity<Receipt> |
waitResponse(int timeout)
Wait for a submission and then get it. |
AttributeReader |
waitRollup(int timeout)
Wait for the whole transation to be done and then get a rollup of attributes. |
Field Detail |
---|
static final long serialVersionUID
Method Detail |
---|
CommandResponse.ResponseState getState()
CommandResponse.CompletionDisposition validateCompletion(boolean throwReason) throws SystemException
throwReason
- If true and the disposition is BAD, it will throw a SystemException for the reason that makes it BAD.
SystemException
Receipt getFinalReceipt()
Receipt
ReceiptList getReceiptList()
Receipt
Entity<Receipt> next() throws SystemException
SystemException
Receipt
,
Entity
Entity<Receipt> waitResponse(int timeout) throws SystemException
timeout
- a timeout period in milliseconds. It'll throw a ThingsCodes.SYSTEM_SERVICE_RESPONSE_TIMEOUT SystemException at the end of the timeout. This is a harmless exception and can be safely thrown away. The timeout resolution isn't exact, so don't base any critical timing on it.
SystemException
Receipt
,
Entity
AttributeReader rollup() throws SystemException
SystemException
Receipt
,
Entity
AttributeReader waitRollup(int timeout) throws SystemException
timeout
- a timeout period in milliseconds. It'll throw a ThingsCodes.SYSTEM_SERVICE_RESPONSE_TIMEOUT SystemException at the end of the timeout. This is a harmless exception and can be safely thrown away. The timeout resolution isn't exact, so don't base any critical timing on it.
SystemException
Receipt
,
Entity
void dispose()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |