|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Communication
Data representation of an abstract Communication.
Field Summary | |
---|---|
static String |
DEFAULT_FLOW_ID
|
static int |
TYPE_AGET
|
static int |
TYPE_DELEGATED_SET
|
static int |
TYPE_ERROR
|
static int |
TYPE_GET
|
static int |
TYPE_RESULT
|
static int |
TYPE_SET
|
static int |
TYPE_UNDEFINED
According to the specification of Powerobject model, these constants defines the basic types of communication. |
static int |
TYPE_UNKOWN
|
Method Summary | ||
---|---|---|
Map<String,Object> |
acquireParameters(Map<String,Class> types)
Maps the parameters of the given communication according to the give type mappings |
|
|
acquireResponse(Class<T> type)
Maps the response object according to the given type mapping |
|
|
acquireResponse(Class<T> type,
Map<String,Class> typeHint)
Maps the response object according to the given type mapping |
|
|
acquireResponse(Class<T> type,
String typeHint,
Class hintClass)
Maps the response object according to the given type mapping |
|
|
acquireResponse(Map<String,Class> typeHint)
Maps the response object according to the given type mapping |
|
|
acquireResponse(String typeHint,
Class hintClass)
Maps the response object according to the given type mapping |
|
void |
addExtension(String key,
Object value)
Application or chanel specific extension can be added to a communication |
|
String |
getApiKey()
Gets the api_key of the given Communication |
|
Integer |
getErrorCode()
Gets the value of an error if this is a communication about an error |
|
Object |
getErrorValue()
Gets the value of an error if this is a communication about an error |
|
Map<String,Object> |
getExtension()
Gets the extension of the given Communication |
|
|
getExtension(String key)
Retrieves application or chanel specific extension |
|
String |
getFlowID()
Gets the id of the Flow where the given Communication appears in |
|
String |
getId()
Gets the id of the given Communication |
|
Integer |
getMessageType()
Gets the type of the given Communication |
|
String |
getOriginalId()
Gets the id of a source ommunication which this communication represents a respond to |
|
Integer |
getOriginalType()
Gets the type of a source ommunication which this communication represents a respond to |
|
Map<String,Object> |
getParameters()
Retrieves the parameters of the given communication |
|
String |
getRecipient()
Gets the recipient of the given Communication |
|
String |
getRecipientApiVersion()
Gets the api version of the sender service to be called Optional attribute |
|
String |
getRedirectEntityName()
Gets the recipient of the returning communication when this will be answered |
|
String |
getRedirectMessage()
Gets the subject of the returning communication when this will be answered |
|
Long |
getRequestTime()
Gets the creation time of the given Communication |
|
|
getResponse()
Gets the response object if this communication represents a respond to previous one |
|
Long |
getResponseTime()
Gets the creation time of the given Communication if it is a response |
|
String |
getSender()
Gets the sender of the given Communication |
|
String |
getSenderApiVersion()
Gets the api version of the sender service to be called Optional attribute |
|
Session |
getSession()
Gets the session of the given Communication |
|
String |
getSubject()
Gets the subject of the given Communication |
|
boolean |
hasExcension(String key)
Tells whether the given excension exists |
|
boolean |
isAnswerTo(Communication msg)
|
|
boolean |
isErrorCommunication()
Tells whether this Communication is an error message or not |
|
void |
setApiKey(String apiKey)
Sets the api_key of the given Communication |
|
void |
setErrorCode(Integer errorCode)
Sets the code of an error if this is a communication about an error |
|
void |
setErrorValue(Object errorValue)
Sets the value of an error if this is a communication about an error |
|
void |
setExtension(Map<String,Object> extension)
Sets the extension of the given Communication |
|
void |
setFlowID(String flowID)
Sets the id of the Flow where the given Communication appears in |
|
void |
setId(String id)
Sets the id of the given Communication |
|
void |
setMessageType(Integer messageType)
Sets the type of the given Communication |
|
void |
setOriginalId(String id)
Sets the id of a source ommunication which this communication represents a respond to |
|
void |
setOriginalType(Integer originalType)
Sets the type of a source ommunication which this communication represents a respond to |
|
void |
setParameters(Map<String,Object> parameters)
Sets the id of the given Communication |
|
void |
setRecipient(String recipient)
Sets the recipient of the given Communication |
|
void |
setRecipientApiVersion(String apiVersion)
Sets the api version of the sender service to be called Optional attribute |
|
void |
setRedirectEntityName(String redirectEntityName)
Sets the recipient of the returning communication when this will be answered |
|
void |
setRedirectMessage(String redirectMessage)
Sets the subject of the returning communication when this will be answered |
|
void |
setRequestTime(Long requestTime)
Sets the creation time of the given Communication |
|
void |
setResponse(Object response)
Sets the response object if this communication represents a respond to previous one |
|
void |
setResponseTime(Long responseTime)
Sets the creation time of the given Communication if it is a response |
|
void |
setSender(String sender)
Sets the sender of the given Communication |
|
void |
setSenderApiVersion(String apiVersion)
Sets the api version of the sender service to be called Optional attribute |
|
void |
setSession(Session session)
Sets the session of the given Communication |
|
void |
setSubject(String subject)
Sets the subject of the given Communication |
Field Detail |
---|
static final int TYPE_UNDEFINED
static final int TYPE_UNKOWN
static final int TYPE_GET
static final int TYPE_AGET
static final int TYPE_SET
static final int TYPE_DELEGATED_SET
static final int TYPE_RESULT
static final int TYPE_ERROR
static final String DEFAULT_FLOW_ID
Method Detail |
---|
String getId()
void setId(String id)
Integer getMessageType()
void setMessageType(Integer messageType)
String getSender()
void setSender(String sender)
String getRecipient()
void setRecipient(String recipient)
String getFlowID()
void setFlowID(String flowID)
Session getSession()
void setSession(Session session)
String getApiKey()
void setApiKey(String apiKey)
String getSenderApiVersion()
void setSenderApiVersion(String apiVersion)
String getRecipientApiVersion()
void setRecipientApiVersion(String apiVersion)
String getSubject()
void setSubject(String subject)
String getRedirectEntityName()
void setRedirectEntityName(String redirectEntityName)
String getRedirectMessage()
void setRedirectMessage(String redirectMessage)
Long getRequestTime()
void setRequestTime(Long requestTime)
Long getResponseTime()
void setResponseTime(Long responseTime)
Map<String,Object> getParameters()
void setParameters(Map<String,Object> parameters)
Map<String,Object> getExtension()
void setExtension(Map<String,Object> extension)
Map<String,Object> acquireParameters(Map<String,Class> types) throws BrillienException
BrillienException
<T> T getResponse()
void setResponse(Object response)
<T> T acquireResponse(Class<T> type) throws BrillienException
BrillienException
<T> T acquireResponse(Class<T> type, Map<String,Class> typeHint) throws BrillienException
BrillienException
<T> T acquireResponse(Map<String,Class> typeHint) throws BrillienException
BrillienException
<T> T acquireResponse(String typeHint, Class hintClass) throws BrillienException
BrillienException
<T> T acquireResponse(Class<T> type, String typeHint, Class hintClass) throws BrillienException
BrillienException
Integer getOriginalType()
void setOriginalType(Integer originalType)
String getOriginalId()
void setOriginalId(String id)
Integer getErrorCode()
void setErrorCode(Integer errorCode)
Object getErrorValue()
void setErrorValue(Object errorValue)
boolean isErrorCommunication()
boolean isAnswerTo(Communication msg)
void addExtension(String key, Object value)
boolean hasExcension(String key)
<T> T getExtension(String key)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |