public interface CommunicativeAction extends SemanticAction
Modifier and Type | Field and Description |
---|---|
static Term |
COMMUNICATIVE_ACTION_PATTERN
General pattern used to recognize action expressions denoting
a communicative action
|
ACTOR
Modifier and Type | Method and Description |
---|---|
Content |
getContent()
Returns the content.
|
Node |
getContentElement(int i)
Returns the element of the content at the specified index.
|
int |
getContentElementNumber()
Returns the number of elements in the content.
|
String |
getConversationId()
Returns the conversationId parameter.
|
String |
getEncoding()
Returns the encoding parameter.
|
String |
getInReplyTo()
Returns the inReplyTo parameter.
|
String |
getLanguage()
Returns the language parameter.
|
String |
getOntology()
Returns the ontology parameter.
|
int |
getPerformative()
Returns the performative.
|
String |
getProtocol()
Returns the protocol parameter.
|
Term |
getReceiver()
Returns the first receiver of the receiver list.
|
ListOfTerm |
getReceiverList()
Returns the receiver list.
|
Date |
getReplyBy()
Returns the replyBy parameter.
|
ListOfTerm |
getReplyToList()
Returns the replyToList parameter.
|
String |
getReplyWith()
Returns the replyWith parameter.
|
Content |
getSurfaceContent()
Returns the surface content.
|
Node |
getSurfaceContentElement(int i)
Returns the element of the surface content at the specified index.
|
int |
getSurfaceContentElementNumber()
Returns the number of element in the surface content.
|
int |
getSurfacePerformative()
Returns the surface performative.
|
SemanticAction |
newAction(ACLMessage aclMessage)
Creates a new instance of this prototype of semantic action from an
ACLMessage.
|
SemanticAction |
newAction(ActionExpression actionExpression)
Creates a new instance of this prototype of semantic action from
the specified action expression.
|
SemanticAction |
newAction(Content content,
CommunicativeAction body)
Creates an instance of the Semantic Action from a communicative action and a specific content
|
SemanticAction |
newAction(Formula rationalEffect,
ACLMessage inReplyTo)
Creates a new instance of this prototype of semantic action from
the specified rational effect.
|
SemanticAction |
newAction(Term author,
ListOfTerm receivers,
Content content,
CommunicativeAction inReplyTo)
Creates an instance of Semantic Action from a sender, receivers and content,
such that it is a consistent reply to another communicative action
|
void |
setAuthor(Term author)
Sets the author of the action.
|
void |
setContent()
Sets the content with a new content
|
void |
setContent(Content content)
Sets the content with the given content
|
void |
setContent(int size)
Sets the content with a new content of the given size
|
void |
setContentElement(int i,
Node element)
Sets the element i of the content
|
void |
setConversationId(String conversationId)
Sets the conversation-id.
|
void |
setConversationId(WordConstantNode conversationId)
Sets the conversation-id parameter.
|
void |
setEncoding(String encoding)
Sets the encoding parameter.
|
void |
setEncoding(WordConstantNode encoding)
Sets the encoding parameter.
|
void |
setInReplyTo(String inReplyTo)
Sets in-reply-to parameter
|
void |
setInReplyTo(WordConstantNode inReplyTo)
Sets in-reply-to parameter
|
void |
setLanguage(String language)
Sets the language parameter.
|
void |
setLanguage(WordConstantNode language)
Sets the language parameter.
|
void |
setOntology(String ontology)
Sets the ontology parameter.
|
void |
setOntology(WordConstantNode ontology)
Sets the ontology parameter.
|
void |
setPerformative(int performative)
Sets the performative.
|
void |
setProtocol(String protocol)
Sets the protocol parameter.
|
void |
setProtocol(WordConstantNode protocol)
Sets the protocol parameter.
|
void |
setReceiver(Term receiver)
Sets a unique receiver to this communicative action
|
void |
setReceiverList(ListOfTerm receiverList)
Sets a list of receiver
|
void |
setReceiverList(TermSetNode receiverList)
Sets a list of receiver
|
void |
setReplyBy(Date replyBy)
Sets reply-by parameter.
|
void |
setReplyBy(DateTimeConstantNode replyBy)
Sets reply-by parameter.
|
void |
setReplyToList(ListOfTerm replyToList)
Sets reply-to parameter.
|
void |
setReplyToList(TermSetNode replyToList)
Sets reply-to parameter.
|
void |
setReplyWith(String replyWith)
Sets reply-with parameter.
|
void |
setReplyWith(WordConstantNode replyWith)
Sets reply-with parameter.
|
void |
setSurfaceContent(Content content)
Sets the surface content with the given content
|
void |
setSurfaceContent(int size)
Sets the surface content size.
|
void |
setSurfaceContentElement(int i,
Node element)
Sets the element i of the surface content.
|
void |
setSurfacePerformative(int surfacePerformative)
Sets the surface performative.
|
ACLMessage |
toAclMessage()
Returns the ACL Message corresponding to the action.
|
getActor, getAuthor, getBehaviour, getFeasibilityPrecondition, getPersistentFeasibilityPrecondition, getPostCondition, getRationalEffect, getSemanticCapabilities, toActionExpression
static final Term COMMUNICATIVE_ACTION_PATTERN
SemanticAction newAction(ActionExpression actionExpression) throws SemanticInterpretationException
newAction
in interface SemanticAction
actionExpression
- an expression of action that specifies the instance to createSemanticInterpretationException
- if any exception occursSemanticAction newAction(ACLMessage aclMessage) throws SemanticInterpretationException
aclMessage
- an ACL MessageSemanticInterpretationException
- if any exception occursSemanticAction newAction(Term author, ListOfTerm receivers, Content content, CommunicativeAction inReplyTo) throws SemanticInterpretationException
author
- author of the actionreceivers
- list of receiverscontent
- content of the actioninReplyTo
- communicative action to reply toSemanticInterpretationException
- if any exception occursSemanticAction newAction(Content content, CommunicativeAction body) throws SemanticInterpretationException
content
- content of the actionbody
- communicative action, model to build the new actionSemanticInterpretationException
- if any exception occursSemanticAction newAction(Formula rationalEffect, ACLMessage inReplyTo)
newAction
in interface SemanticAction
rationalEffect
- a formula that specifies the rational effet of the instance to createinReplyTo
- an ACL message the message to answervoid setAuthor(Term author)
author
- the author of the actionint getPerformative()
void setPerformative(int performative)
performative
- The performative to set.int getSurfacePerformative()
void setSurfacePerformative(int surfacePerformative)
surfacePerformative
- The surfacePerformative to set.ListOfTerm getReceiverList()
Term getReceiver()
void setReceiver(Term receiver)
receiver
- a receivervoid setReceiverList(ListOfTerm receiverList)
receiverList
- The receiverList to set.void setReceiverList(TermSetNode receiverList)
receiverList
- a list of receiversvoid setContent(Content content)
content
- The content to set.void setContent()
void setContent(int size)
size
- size of the new contentvoid setContentElement(int i, Node element)
i
- an indexelement
- the element to setContent getContent()
Node getContentElement(int i)
i
- an indexint getContentElementNumber()
void setSurfaceContent(int size)
size
- the size to setvoid setSurfaceContent(Content content)
content
- the content to setvoid setSurfaceContentElement(int i, Node element)
i
- an indexelement
- the element to setContent getSurfaceContent()
Node getSurfaceContentElement(int i)
i
- an indexint getSurfaceContentElementNumber()
String getConversationId()
void setConversationId(String conversationId)
conversationId
- The conversationId to set.void setConversationId(WordConstantNode conversationId)
conversationId
- value of conversationIdString getEncoding()
void setEncoding(String encoding)
encoding
- value of the encoding parameter.void setEncoding(WordConstantNode encoding)
encoding
- value of the encoding parameterString getInReplyTo()
void setInReplyTo(String inReplyTo)
inReplyTo
- inReplyTo value to set.void setInReplyTo(WordConstantNode inReplyTo)
inReplyTo
- inReplyTo valueString getLanguage()
void setLanguage(String language)
language
- The language to set.void setLanguage(WordConstantNode language)
language
- the language to set.String getOntology()
void setOntology(String ontology)
ontology
- The ontology to set.void setOntology(WordConstantNode ontology)
ontology
- The ontology to set.String getProtocol()
void setProtocol(String protocol)
protocol
- The protocol to set.void setProtocol(WordConstantNode protocol)
protocol
- The protocol to set.Date getReplyBy()
void setReplyBy(Date replyBy)
replyBy
- The replyBy to set.void setReplyBy(DateTimeConstantNode replyBy)
replyBy
- value of the replyBy parameterListOfTerm getReplyToList()
void setReplyToList(ListOfTerm replyToList)
replyToList
- The replyToList to set.void setReplyToList(TermSetNode replyToList)
replyToList
- The replyToList to set.String getReplyWith()
void setReplyWith(String replyWith)
replyWith
- The replyWith to set.void setReplyWith(WordConstantNode replyWith)
replyWith
- The replyWith to set.ACLMessage toAclMessage() throws UnparseContentException
UnparseContentException
- if an error of parsing occurs