Jadex 0.96

jadex.planlib
Capability Protocols


capability Protocols

The protocols capability enables an easy goal-driven usage of some often used FIPA protocols.


Belief Summary
exported belief IFilter cm_filter
           The filter for deciding which cancel messages are handled in this capability.
exported belief IFilter cnp_filter
           The filter for deciding which initial cfp messages are handled in this capability.
exported belief IFilter da_filter
           The filter for deciding which initial cfp messages are handled in this capability.
exported belief IFilter ea_filter
           The filter for deciding which initial cfp messages are handled in this capability.
exported belief IFilter icnp_filter
           The filter for deciding which initial iterated cfp messages are handled in this capability.
exported belief IFilter rp_filter
           The filter for deciding which initial request messages are handled in this capability.
exported belief Long timeout
           Timeout for messages.
 
Goal Summary
exported querygoal cm_approve_cancel(String conversation-id, Object failure_reason, AgentIdentifier initiator, String protocol, Boolean result)
           (Participant side) Optional goal to approve a cancel request (default=true).
exported performgoal cm_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) FIPA-Cancel-Meta-Protocol protocol interaction goal (top-level goal of all receiver-side interactions).
exported querygoal cnp_evaluate_proposals(Object cfp, Object cfp_info, Boolean evaluated, ParticipantProposal [set] acceptables, NegotiationRecord [set] history, ParticipantProposal [set] proposals)
           (Initiator side) Evaluate the received proposals.
exported achievegoal cnp_execute_task(AgentIdentifier initiator, Object proposal, Object proposal_info, Object result)
           (Participant side) Execute a cfp task.
exported achievegoal cnp_initiate(Object cfp, Object cfp_info, Boolean executeall, InteractionState interaction_state, String language, String ontology, Long timeout, NegotiationRecord [set] history, AgentIdentifier [set] receivers, Object [set] result)
           (Initiator side) Initiate a call for proposal protcol.
exported querygoal cnp_make_proposal(Object cfp, AgentIdentifier initiator, Object proposal, Object proposal_info)
           (Participant side) Make a cfp proposal.
exported performgoal cnp_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) Contract-net protocol interaction goal (top-level goal of all receiver-side interactions).
exported querygoal da_decide_iteration(Object cfp, Object cfp_info, Object [set] history)
           (Initiator side) Decide if the next round should be executed and with which cfp.
exported achievegoal da_decide_participation(AuctionDescription auction_description, Object auction_info, AgentIdentifier initiator, Boolean participate)
           (Participant side) Optional goal that offers a possibility to decide a participation.
exported achievegoal da_initiate(AuctionDescription auction_description, Object cfp, Object cfp_info, InteractionState interaction_state, String language, String ontology, Object result, AgentIdentifier [set] receivers)
           (Initiator side) Initiate the dutch auction protocol.
exported querygoal da_make_proposal(Boolean accept, AuctionDescription auction_description, Object auction_info, Object cfp, Boolean leave, Object [set] history)
           (Participant side) Accept a proposal in a dutch auction.
exported performgoal da_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) Dutch auction protocol interaction goal (top-level goal of all receiver-side interactions).
exported querygoal ea_decide_acceptance(Boolean accept, AuctionDescription auction_description, Object cfp, Object cfp_info, AgentIdentifier winner, Object [set] history)
           (Initiator side) Decide if winning offer should be accepted.
exported querygoal ea_decide_iteration(Object cfp, Object cfp_info, Object [set] history)
           (Initiator side) Decide if the next round should be executed and with which cfp.
exported achievegoal ea_decide_participation(AuctionDescription auction_description, Object auction_info, AgentIdentifier initiator, Boolean participate)
           (Participant side) Optional goal that offers a possibility to decide about participation.
exported achievegoal ea_initiate(AuctionDescription auction_description, Object cfp, Object cfp_info, InteractionState interaction_state, String language, Comparable limit, String ontology, Object result, AgentIdentifier [set] receivers)
           (Initiator side) Initiate the english auction protocol.
exported querygoal ea_make_proposal(Boolean accept, AuctionDescription auction_description, Object auction_info, Object cfp, Boolean leave, Object [set] history)
           (Participant side) Make a proposal for an english auction.
exported performgoal ea_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) English auction protocol interaction goal (top-level goal of all receiver-side interactions).
exported querygoal icnp_evaluate_proposals(Object cfp, Object cfp_info, Boolean evaluated, ParticipantProposal [set] acceptables, NegotiationRecord [set] history, ParticipantProposal [set] proposals)
           (Initiator side) Evaluate the received proposals.
exported achievegoal icnp_execute_task(AgentIdentifier initiator, Object proposal, Object proposal_info, Object result)
           (Participant side) Execute a cfp task.
exported achievegoal icnp_initiate(Object cfp, Object cfp_info, Boolean executeall, InteractionState interaction_state, String language, String ontology, Long timeout, NegotiationRecord [set] history, AgentIdentifier [set] receivers, Object [set] result)
           (Initiator side) Initiate a call for proposal protcol.
exported querygoal icnp_make_proposal(Object cfp, AgentIdentifier initiator, Object proposal, Object proposal_info)
           (Participant side) Make a cfp proposal.
exported querygoal icnp_nextround_info(Object cfp, Object cfp_info, Boolean iterate, NegotiationRecord [set] history, AgentIdentifier [set] participants, ParticipantProposal [set] proposals)
           (Initiator side) Collect information for next round (if any).
exported performgoal icnp_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) Iterated contract-net protocol interaction goal (top-level goal of all receiver-side interactions).
exported performgoal perform_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           A subgoal that can be posted to trigger to protocol specific interaction handling.
exported querygoal rp_decide_request(Boolean accept, Object action, AgentIdentifier initiator)
           (Participant side) Decide upon a requested task will be executed.
exported achievegoal rp_execute_request(Object action, AgentIdentifier initiator, Object result)
           (Participant side) Execute the requested task.
exported achievegoal rp_initiate(Object action, InteractionState interaction_state, String language, String ontology, AgentIdentifier receiver, Object result, Long timeout)
           (Initiator side) Initiate a conversation using the fipa-request protocol.
exported performgoal rp_receiver_interaction(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
           (Participant side) Request protocol interaction goal (top-level goal of all receiver-side interactions).
 
Plan Summary
standard plan cm_approve_cancel_plan(boolean result)
           Default plan for deciding about cancellation.
standard plan cm_interaction_goal_creation_plan(String goaltype)
           FIPA-Cancel-Meta-Protocol generic interaction goal creation plan.
standard plan cm_receiver_plan(IMessageEvent message)
           Plan for cancelling an interaction (receiver side of FIPA-Cancel-Meta-Protocol).
standard plan cnp_evaluateproposals_plan(Object cfp, Object cfp_info, ParticipantProposal [set] acceptables, NegotiationRecord [set] history, ParticipantProposal [set] proposals)
           Default plan for evaluate proposals goal.
standard plan cnp_initiator_plan(Object cfp, Object cfp_info, boolean executeall, InteractionState interaction_state, Boolean iterated, String language, String ontology, Long timeout, NegotiationRecord [set] history, AgentIdentifier [set] receivers, Object [set] result)
          
standard plan cnp_interaction_goal_creation_plan(String goaltype)
           Generic interaction goal creation plan.
standard plan cnp_receiver_plan(Object interaction_description, InteractionState interaction_state, Boolean iterated, IMessageEvent message, Object result)
          
standard plan da_initiator_plan(AuctionDescription auction_description, Object cfp, Object cfp_info, InteractionState interaction_state, String language, String ontology, Object result, AgentIdentifier [set] receivers)
          
standard plan da_interaction_goal_creation_plan(String goaltype)
           Generic interaction goal creation plan.
standard plan da_receiver_plan(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
          
standard plan ea_initiator_plan(AuctionDescription auction_description, Object cfp, Object cfp_info, InteractionState interaction_state, String language, Comparable limit, String ontology, Object result, AgentIdentifier [set] receivers)
          
standard plan ea_interaction_goal_creation_plan(String goaltype)
           Generic interaction goal creation plan.
standard plan ea_receiver_plan(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
          
standard plan icnp_evaluateproposals_plan(Object cfp, Object cfp_info, ParticipantProposal [set] acceptables, NegotiationRecord [set] history, ParticipantProposal [set] proposals)
           Default plan for evaluate proposals goal.
standard plan icnp_initiator_plan(Object cfp, Object cfp_info, boolean executeall, InteractionState interaction_state, Boolean iterated, String language, String ontology, Long timeout, NegotiationRecord [set] history, AgentIdentifier [set] receivers, Object [set] result)
          
standard plan icnp_interaction_goal_creation_plan(String goaltype)
           Generic interaction goal creation plan.
standard plan icnp_querynextroundinfo_plan(Object cfp, Object cfp_info, Boolean iterate, NegotiationRecord [set] history, AgentIdentifier [set] participants, ParticipantProposal [set] proposals)
           Default plan for query nextround-info goal.
standard plan icnp_receiver_plan(Object interaction_description, InteractionState interaction_state, Boolean iterated, IMessageEvent message, Object result)
          
standard plan request_initiator_plan(Object action, InteractionState interaction_state, String language, String ontology, AgentIdentifier receiver, Object result, Long timeout)
          
standard plan rp_interaction_goal_creation_plan(String goaltype)
           Generic interaction goal creation plan.
standard plan rp_receiver_plan(Object interaction_description, InteractionState interaction_state, IMessageEvent message, Object result)
          
 
Event Summary
messageevent cm_cancel(String performative, String protocol)
           Cancel message sent by initiator side to terminate an ongoing interaction.
messageevent cm_failure(String performative, String protocol)
           Failure message sent by receiver side describing failed termination of an ongoing interaction.
messageevent cm_inform(String performative, String protocol)
           Inform message sent by receiver side describing successful termination of an ongoing interaction.
messageevent cm_not_understood(String performative)
           Not-understood message sent by receiver side describing the whish to abort the interaction.
exported messageevent cnp_accept(String language, String performative, String protocol)
          
exported messageevent cnp_cfp(String conversation-id, String language, String performative, String protocol)
          - cnp
exported messageevent cnp_failure(String language, String performative, String protocol)
          
exported messageevent cnp_inform(String language, String performative, String protocol)
          
exported messageevent cnp_not_understood(String language, String performative, String protocol)
          
exported messageevent cnp_propose(String language, String performative, String protocol)
          
exported messageevent cnp_refuse(String language, String performative, String protocol)
          
exported messageevent cnp_reject(String language, String performative, String protocol)
          
exported messageevent da_accept_proposal(String language, String performative, String protocol)
          
exported messageevent da_cfp(String language, String performative, String protocol)
          
exported messageevent da_inform_end_auction(String encoding, String language, String performative, String protocol)
          
exported messageevent da_inform_start_auction(AuctionDescription content, String conversation-id, String encoding, String language, String performative, String protocol)
           dutch auction
exported messageevent da_not_understood(String language, String performative, String protocol)
          
exported messageevent da_propose(String language, String performative, String protocol)
          
exported messageevent da_reject_proposal(String language, String performative, String protocol)
          
exported messageevent ea_accept_proposal(String language, String performative, String protocol)
          
exported messageevent ea_cfp(String language, String performative, String protocol)
          
exported messageevent ea_inform_end_auction(String encoding, String language, String performative, String protocol)
          
exported messageevent ea_inform_start_auction(AuctionDescription content, String conversation-id, String encoding, String language, String performative, String protocol)
           english auction
exported messageevent ea_not_understood(String language, String performative, String protocol)
          
exported messageevent ea_propose(String language, String performative, String protocol)
          
exported messageevent ea_reject_proposal(String language, String performative, String protocol)
          
exported messageevent icnp_accept(String language, String performative, String protocol)
          
exported messageevent icnp_cfp(String conversation-id, String language, String performative, String protocol)
          - icnp
exported messageevent icnp_failure(String language, String performative, String protocol)
          
exported messageevent icnp_inform(String language, String performative, String protocol)
          
exported messageevent icnp_not_understood(String language, String performative, String protocol)
          
exported messageevent icnp_propose(String language, String performative, String protocol)
          
exported messageevent icnp_refuse(String language, String performative, String protocol)
          
exported messageevent icnp_reject(String language, String performative, String protocol)
          
exported messageevent rp_agree(String language, String performative, String protocol)
          
exported messageevent rp_failure(String language, String performative, String protocol)
          
exported messageevent rp_inform(String language, String performative, String protocol)
          
exported messageevent rp_not_understood(String language, String performative, String protocol)
          
exported messageevent rp_refuse(String language, String performative, String protocol)
          
exported messageevent rp_request(String conversation-id, String language, String performative, String protocol)
          
 
Expression Summary
expression find_interaction_goal
           todo!!!
 

Belief Detail

timeout

exported belief Long timeout
Timeout for messages.

Default fact:
(Integer)$propertybase.getProperty("standard.timeout")

rp_filter

exported belief IFilter rp_filter
The filter for deciding which initial request messages are handled in this capability.

Default fact:
IFilter.NEVER

cnp_filter

exported belief IFilter cnp_filter
The filter for deciding which initial cfp messages are handled in this capability.

Default fact:
IFilter.NEVER

icnp_filter

exported belief IFilter icnp_filter
The filter for deciding which initial iterated cfp messages are handled in this capability.

Default fact:
IFilter.NEVER

ea_filter

exported belief IFilter ea_filter
The filter for deciding which initial cfp messages are handled in this capability.

Default fact:
IFilter.NEVER

da_filter

exported belief IFilter da_filter
The filter for deciding which initial cfp messages are handled in this capability.

Default fact:
IFilter.NEVER

cm_filter

exported belief IFilter cm_filter
The filter for deciding which cancel messages are handled in this capability.

Default fact:
new ComposedFilter(new IFilter[] { $beliefbase.rp_filter, $beliefbase.cnp_filter, $beliefbase.icnp_filter, $beliefbase.ea_filter, $beliefbase.da_filter }, ComposedFilter.OR)
Goal Detail

rp_receiver_interaction

exported performgoal rp_receiver_interaction(Object interaction_description, 
                                             InteractionState interaction_state, 
                                             IMessageEvent message, 
                                             Object result)
(Participant side) Request protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cnp_receiver_interaction

exported performgoal cnp_receiver_interaction(Object interaction_description, 
                                              InteractionState interaction_state, 
                                              IMessageEvent message, 
                                              Object result)
(Participant side) Contract-net protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_receiver_interaction

exported performgoal icnp_receiver_interaction(Object interaction_description, 
                                               InteractionState interaction_state, 
                                               IMessageEvent message, 
                                               Object result)
(Participant side) Iterated contract-net protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_receiver_interaction

exported performgoal ea_receiver_interaction(Object interaction_description, 
                                             InteractionState interaction_state, 
                                             IMessageEvent message, 
                                             Object result)
(Participant side) English auction protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

da_receiver_interaction

exported performgoal da_receiver_interaction(Object interaction_description, 
                                             InteractionState interaction_state, 
                                             IMessageEvent message, 
                                             Object result)
(Participant side) Dutch auction protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cm_receiver_interaction

exported performgoal cm_receiver_interaction(Object interaction_description, 
                                             InteractionState interaction_state, 
                                             IMessageEvent message, 
                                             Object result)
(Participant side) FIPA-Cancel-Meta-Protocol protocol interaction goal (top-level goal of all receiver-side interactions).

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
in parameter message - The message that initiated the protocol.
out parameter result - The interaction result.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

perform_interaction

exported performgoal perform_interaction(Object interaction_description, 
                                         InteractionState interaction_state, 
                                         IMessageEvent message, 
                                         Object result)
A subgoal that can be posted to trigger to protocol specific interaction handling. Should be used when implementing custom plan for receiver interaction goal.

Parameters:
out parameter interaction_description - The interaction description (content of first message).
out parameter interaction_state - The interaction state should be assign from the superordinated goal.
in parameter message - The message should be assign from the superordinated goal.
out parameter result - The result should be passed back to the superordinated goal.
BDI flags:
retry: false
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

rp_initiate

exported achievegoal rp_initiate(Object action, 
                                 InteractionState interaction_state, 
                                 String language, 
                                 String ontology, 
                                 AgentIdentifier receiver, 
                                 Object result, 
                                 Long timeout)
(Initiator side) Initiate a conversation using the fipa-request protocol.

Parameters:
in parameter action - The requested action.
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
optional in parameter language - Optional language for marshalling.
optional in parameter ontology - Optional ontology for marshalling.
in parameter receiver - The receiver of the request.
out parameter result - The result of the request.
optional in parameter timeout - The optional request timeout.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

rp_execute_request

exported achievegoal rp_execute_request(Object action, 
                                        AgentIdentifier initiator, 
                                        Object result)
(Participant side) Execute the requested task.

Parameters:
in parameter action - The requested action.
in parameter initiator - The requesting agent.
optional out parameter result - The result of the request.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cnp_initiate

exported achievegoal cnp_initiate(Object cfp, 
                                  Object cfp_info, 
                                  Boolean executeall, 
                                  InteractionState interaction_state, 
                                  String language, 
                                  String ontology, 
                                  Long timeout, 
                                  NegotiationRecord [set] history, 
                                  AgentIdentifier [set] receivers, 
                                  Object [set] result)
(Initiator side) Initiate a call for proposal protcol.

Parameters:
in parameter cfp - The call-for-proposals is in the content.
optional inout parameter cfp_info - The call-for-proposals info (local information).
optional in parameter executeall Default value:  Boolean.FALSE
- If several proposals are acceptable, should all be accepted.
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
optional in parameter language - Optional langauge for marshalling.
optional in parameter ontology - Optional ontology for marshalling.
optional in parameter timeout - The timeout used during the negotiation.
optional out parameterset history - The negotiation history.
in parameterset receivers - The (initial) negotiation participants.
out parameterset result - The tasks done by the winners.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cnp_execute_task

exported achievegoal cnp_execute_task(AgentIdentifier initiator, 
                                      Object proposal, 
                                      Object proposal_info, 
                                      Object result)
(Participant side) Execute a cfp task.

Parameters:
in parameter initiator - The initiator of the interaction.
in parameter proposal - The proposal for doing the task.
optional in parameter proposal_info - Optional information about the task from the preceding step (not sent to initiator).
optional out parameter result - Information about the task execution.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_initiate

exported achievegoal icnp_initiate(Object cfp, 
                                   Object cfp_info, 
                                   Boolean executeall, 
                                   InteractionState interaction_state, 
                                   String language, 
                                   String ontology, 
                                   Long timeout, 
                                   NegotiationRecord [set] history, 
                                   AgentIdentifier [set] receivers, 
                                   Object [set] result)
(Initiator side) Initiate a call for proposal protcol.

Parameters:
in parameter cfp - The call-for-proposals is in the content.
optional inout parameter cfp_info - The call-for-proposals info (local information).
optional in parameter executeall Default value:  Boolean.FALSE
- If several proposals are acceptable, should all be accepted.
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
optional in parameter language - Optional langauge for marshalling.
optional in parameter ontology - Optional ontology for marshalling.
optional in parameter timeout - The timeout used during the negotiation.
out parameterset history - The negotiation history.
in parameterset receivers - The (initial) negotiation participants.
out parameterset result - The tasks done by the winners.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_execute_task

exported achievegoal icnp_execute_task(AgentIdentifier initiator, 
                                       Object proposal, 
                                       Object proposal_info, 
                                       Object result)
(Participant side) Execute a cfp task.

Parameters:
in parameter initiator - The initiator of the interaction.
in parameter proposal - The proposal for doing the task.
optional in parameter proposal_info - Optional information about the task from the preceding step (not sent to initiator).
optional out parameter result - Information about the task execution.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_initiate

exported achievegoal ea_initiate(AuctionDescription auction_description, 
                                 Object cfp, 
                                 Object cfp_info, 
                                 InteractionState interaction_state, 
                                 String language, 
                                 Comparable limit, 
                                 String ontology, 
                                 Object result, 
                                 AgentIdentifier [set] receivers)
(Initiator side) Initiate the english auction protocol.

Parameters:
in parameter auction_description - The auction description containing necessary information about the auction: a) the auction topic, b) the round timeout, c) the starttime (optional)
in parameter cfp - The call-for-proposals is in the content.
optional in parameter cfp_info - The call-for-proposals info (local information).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
optional in parameter language - Optional language for marshalling.
optional in parameter limit - The optional limit offer (if defined no ea_decide_acceptance goal is thrown).
optional in parameter ontology - Optional ontology for marshalling.
optional out parameter result - The auction result.
in parameterset receivers - The initially participating bidder agents.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_decide_participation

exported achievegoal ea_decide_participation(AuctionDescription auction_description, 
                                             Object auction_info, 
                                             AgentIdentifier initiator, 
                                             Boolean participate)
(Participant side) Optional goal that offers a possibility to decide about participation.

Parameters:
in parameter auction_description - The auction info describing the auction.
optional out parameter auction_info - Local auction info.
in parameter initiator - The initiator of the interaction.
out parameter participate - False for not participating in the auction.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

da_initiate

exported achievegoal da_initiate(AuctionDescription auction_description, 
                                 Object cfp, 
                                 Object cfp_info, 
                                 InteractionState interaction_state, 
                                 String language, 
                                 String ontology, 
                                 Object result, 
                                 AgentIdentifier [set] receivers)
(Initiator side) Initiate the dutch auction protocol.

Parameters:
in parameter auction_description - The auction description containing necessary information about the auction: a) the auction topic, b) the round timeout, c) the starttime (optional)
in parameter cfp - The current offer made by the auctioneer.
optional in parameter cfp_info - The call-for-proposals info (local information).
out parameter interaction_state Default value:  new InteractionState()
- The interaction state.
optional in parameter language - Optional language for marshalling.
optional in parameter ontology - Optional ontology for marshalling.
optional out parameter result - The result of the protocol execution.
in parameterset receivers - The initially participating bidder agents.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

da_decide_participation

exported achievegoal da_decide_participation(AuctionDescription auction_description, 
                                             Object auction_info, 
                                             AgentIdentifier initiator, 
                                             Boolean participate)
(Participant side) Optional goal that offers a possibility to decide a participation.

Parameters:
in parameter auction_description - The auction description.
optional out parameter auction_info - Local auction info.
in parameter initiator - The initiator of the interaction.
out parameter participate - False for not participating in the auction.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

rp_decide_request

exported querygoal rp_decide_request(Boolean accept, 
                                     Object action, 
                                     AgentIdentifier initiator)
(Participant side) Decide upon a requested task will be executed.

Parameters:
out parameter accept - True, if request should be done and agree message should be sent.
in parameter action - The requested action.
in parameter initiator - The requesting agent.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cnp_evaluate_proposals

exported querygoal cnp_evaluate_proposals(Object cfp, 
                                          Object cfp_info, 
                                          Boolean evaluated, 
                                          ParticipantProposal [set] acceptables, 
                                          NegotiationRecord [set] history, 
                                          ParticipantProposal [set] proposals)
(Initiator side) Evaluate the received proposals.

Parameters:
in parameter cfp - The original call-for-proposals.
optional inout parameter cfp_info - The call-for-proposals info (local information).
out parameter evaluated Default value:   ($goal.acceptables.length>0 || (select one ParticipantProposal $prop from $goal.proposals where $prop.getEvaluation()==null)==null) ? true : null
- Dummy paramter that leads to goal completion, when an acceptable proposal is available or all proposals are evaluated.
optional out parameterset acceptables - The acceptable proposals, sorted by preference (best proposal first).
in parameterset history - The negotiation history.
in parameterset proposals - The received proposals.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cnp_make_proposal

exported querygoal cnp_make_proposal(Object cfp, 
                                     AgentIdentifier initiator, 
                                     Object proposal, 
                                     Object proposal_info)
(Participant side) Make a cfp proposal.

Parameters:
in parameter cfp - The cfp describing the task to be done.
in parameter initiator - The initiator of the interaction.
out parameter proposal - The proposal for doing the task.
optional out parameter proposal_info - Optional information about the task that will be tranferred to the task execution step (not sent to initiator).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_evaluate_proposals

exported querygoal icnp_evaluate_proposals(Object cfp, 
                                           Object cfp_info, 
                                           Boolean evaluated, 
                                           ParticipantProposal [set] acceptables, 
                                           NegotiationRecord [set] history, 
                                           ParticipantProposal [set] proposals)
(Initiator side) Evaluate the received proposals.

Parameters:
in parameter cfp - The original call-for-proposals.
optional inout parameter cfp_info - The call-for-proposals info (local information).
out parameter evaluated Default value:   ($goal.acceptables.length>0 || (select one ParticipantProposal $prop from $goal.proposals where $prop.getEvaluation()==null)==null) ? true : null
- Dummy paramter that leads to goal completion, when an acceptable proposal is available or all proposals are evaluated.
optional out parameterset acceptables - The acceptable proposals, sorted by preference (best proposal first). By default, setting acceptable proposals will end the protocol (i.e. no more iterations).
in parameterset history - The negotiation history.
in parameterset proposals - The received proposals
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_nextround_info

exported querygoal icnp_nextround_info(Object cfp, 
                                       Object cfp_info, 
                                       Boolean iterate, 
                                       NegotiationRecord [set] history, 
                                       AgentIdentifier [set] participants, 
                                       ParticipantProposal [set] proposals)
(Initiator side) Collect information for next round (if any).

Parameters:
inout parameter cfp - The call-for-proposal object sent to participants (should be refined for next round).
optional inout parameter cfp_info - The call-for-proposal info (local information, can be refined for next round).
out parameter iterate - Flag indicating the decision to iterate (set to true or false to end goal).
in parameterset history - The negotiation history.
inout parameterset participants - The participants (can be altered for next negotiation round).
in parameterset proposals - The proposals, received from participants including evaluation (if any).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

icnp_make_proposal

exported querygoal icnp_make_proposal(Object cfp, 
                                      AgentIdentifier initiator, 
                                      Object proposal, 
                                      Object proposal_info)
(Participant side) Make a cfp proposal.

Parameters:
in parameter cfp - The cfp describing the task to be done.
in parameter initiator - The initiator of the interaction.
out parameter proposal - The proposal for doing the task.
optional out parameter proposal_info - Optional information about the task that will be tranferred to the task execution step (not sent to initiator).
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_decide_iteration

exported querygoal ea_decide_iteration(Object cfp, 
                                       Object cfp_info, 
                                       Object [set] history)
(Initiator side) Decide if the next round should be executed and with which cfp.

Parameters:
out parameter cfp - Decide about the cfp for the next round.
optional inout parameter cfp_info - Decide about the (new) cfp info.
in parameterset history - The history of cfps.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_decide_acceptance

exported querygoal ea_decide_acceptance(Boolean accept, 
                                        AuctionDescription auction_description, 
                                        Object cfp, 
                                        Object cfp_info, 
                                        AgentIdentifier winner, 
                                        Object [set] history)
(Initiator side) Decide if winning offer should be accepted.

Parameters:
out parameter accept - The result.
in parameter auction_description - The auction description.
in parameter cfp - The winning proposal
optional in parameter cfp_info - The local cfp info
in parameter winner - The winning agent.
in parameterset history - The history of cfps.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

ea_make_proposal

exported querygoal ea_make_proposal(Boolean accept, 
                                    AuctionDescription auction_description, 
                                    Object auction_info, 
                                    Object cfp, 
                                    Boolean leave, 
                                    Object [set] history)
(Participant side) Make a proposal for an english auction.

Parameters:
out parameter accept - True, for accepting the offer.
in parameter auction_description - The auction description describing the auction.
optional inout parameter auction_info - Local auction info.
in parameter cfp - The current offer made by the auctioneer.
optional out parameter leave - True, for immediately leaving the current auction.
optional in parameterset history - The history of all offers in the auction.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

da_decide_iteration

exported querygoal da_decide_iteration(Object cfp, 
                                       Object cfp_info, 
                                       Object [set] history)
(Initiator side) Decide if the next round should be executed and with which cfp.

Parameters:
out parameter cfp - Decide about the cfp for the next round.
optional inout parameter cfp_info - Decide about the (new) cfp info.
in parameterset history - The history of cfps.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

da_make_proposal

exported querygoal da_make_proposal(Boolean accept, 
                                    AuctionDescription auction_description, 
                                    Object auction_info, 
                                    Object cfp, 
                                    Boolean leave, 
                                    Object [set] history)
(Participant side) Accept a proposal in a dutch auction.

Parameters:
out parameter accept - True, for accepting the offer.
in parameter auction_description - The auction description.
optional inout parameter auction_info - Local auction info.
in parameter cfp - The current offer made by the auctioneer.
optional out parameter leave - True, for immediately leaving the current auction.
optional in parameterset history - The history of all offers in the auction.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false

cm_approve_cancel

exported querygoal cm_approve_cancel(String conversation-id, 
                                     Object failure_reason, 
                                     AgentIdentifier initiator, 
                                     String protocol, 
                                     Boolean result)
(Participant side) Optional goal to approve a cancel request (default=true).

Parameters:
in parameter conversation-id - The interaction to be cancelled.
optional out parameter failure_reason - A failure reason when cancellation is not ok.
in parameter initiator - The initiator agent for the cancel request.
in parameter protocol - The protocol of the interaction to be cancelled.
out parameter result - True, if the cancellation is ok.
BDI flags:
retry: true
retry delay: 0
exclude: when_tried
random selection: false
post to all: false
Plan Detail

rp_interaction_goal_creation_plan

standard plan rp_interaction_goal_creation_plan(String goaltype)
Generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "rp_receiver_interaction"
Plan body:
Plan trigger:
Message events:
rp_request

cnp_interaction_goal_creation_plan

standard plan cnp_interaction_goal_creation_plan(String goaltype)
Generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "cnp_receiver_interaction"
Plan body:
Plan trigger:
Message events:
cnp_cfp

icnp_interaction_goal_creation_plan

standard plan icnp_interaction_goal_creation_plan(String goaltype)
Generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "icnp_receiver_interaction"
Plan body:
Plan trigger:
Message events:
icnp_cfp

ea_interaction_goal_creation_plan

standard plan ea_interaction_goal_creation_plan(String goaltype)
Generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "ea_receiver_interaction"
Plan body:
Plan trigger:
Message events:
ea_inform_start_auction

da_interaction_goal_creation_plan

standard plan da_interaction_goal_creation_plan(String goaltype)
Generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "da_receiver_interaction"
Plan body:
Plan trigger:
Message events:
da_inform_start_auction

request_initiator_plan

standard plan request_initiator_plan(Object action, 
                                    InteractionState interaction_state, 
                                    String language, 
                                    String ontology, 
                                    AgentIdentifier receiver, 
                                    Object result, 
                                    Long timeout)
Parameters:
in parameter action (goal mappings: rp_initiate.action)
out parameter interaction_state (goal mappings: rp_initiate.interaction_state)
in parameter language (goal mappings: rp_initiate.language)
in parameter ontology (goal mappings: rp_initiate.ontology)
in parameter receiver (goal mappings: rp_initiate.receiver)
out parameter result (goal mappings: rp_initiate.result)
in parameter timeout (goal mappings: rp_initiate.timeout)
Plan body:
Plan trigger:
Goals:
rp_initiate

rp_receiver_plan

standard plan rp_receiver_plan(Object interaction_description, 
                              InteractionState interaction_state, 
                              IMessageEvent message, 
                              Object result)
Parameters:
out parameter interaction_description (goal mappings: rp_receiver_interaction.interaction_description perform_interaction.interaction_description)
out parameter interaction_state (goal mappings: rp_receiver_interaction.interaction_state perform_interaction.interaction_state)
in parameter message (goal mappings: rp_receiver_interaction.message perform_interaction.message)
out parameter result (goal mappings: rp_receiver_interaction.result perform_interaction.result)
Plan body:
Plan trigger:
Goals:
rp_receiver_interaction
Goals:
perform_interaction

cnp_initiator_plan

standard plan cnp_initiator_plan(Object cfp, 
                                Object cfp_info, 
                                boolean executeall, 
                                InteractionState interaction_state, 
                                Boolean iterated, 
                                String language, 
                                String ontology, 
                                Long timeout, 
                                NegotiationRecord [set] history, 
                                AgentIdentifier [set] receivers, 
                                Object [set] result)
Parameters:
in parameter cfp (goal mappings: cnp_initiate.cfp)
in parameter cfp_info (goal mappings: cnp_initiate.cfp_info)
in parameter executeall Default value:  false
 (goal mappings: cnp_initiate.executeall)
out parameter interaction_state (goal mappings: cnp_initiate.interaction_state)
in parameter iterated Default value:  Boolean.FALSE
in parameter language (goal mappings: cnp_initiate.language)
in parameter ontology (goal mappings: cnp_initiate.ontology)
in parameter timeout (goal mappings: cnp_initiate.timeout)
in parameterset history (goal mappings: cnp_initiate.history)
in parameterset receivers (goal mappings: cnp_initiate.receivers)
out parameterset result (goal mappings: cnp_initiate.result)
Plan body:
Plan trigger:
Goals:
cnp_initiate

cnp_evaluateproposals_plan

standard plan cnp_evaluateproposals_plan(Object cfp, 
                                        Object cfp_info, 
                                        ParticipantProposal [set] acceptables, 
                                        NegotiationRecord [set] history, 
                                        ParticipantProposal [set] proposals)
Default plan for evaluate proposals goal.

Parameters:
in parameter cfp (goal mappings: cnp_evaluate_proposals.cfp)
in parameter cfp_info (goal mappings: cnp_evaluate_proposals.cfp_info)
optional out parameterset acceptables (goal mappings: cnp_evaluate_proposals.acceptables)
in parameterset history (goal mappings: cnp_evaluate_proposals.history)
in parameterset proposals (goal mappings: cnp_evaluate_proposals.proposals)
Plan body:
Plan trigger:
Goals:
cnp_evaluate_proposals

cnp_receiver_plan

standard plan cnp_receiver_plan(Object interaction_description, 
                               InteractionState interaction_state, 
                               Boolean iterated, 
                               IMessageEvent message, 
                               Object result)
Parameters:
out parameter interaction_description (goal mappings: cnp_receiver_interaction.interaction_description perform_interaction.interaction_description)
out parameter interaction_state (goal mappings: cnp_receiver_interaction.interaction_state perform_interaction.interaction_state)
in parameter iterated Default value:  Boolean.FALSE
in parameter message (goal mappings: cnp_receiver_interaction.message perform_interaction.message)
out parameter result (goal mappings: cnp_receiver_interaction.result perform_interaction.result)
Plan body:
Plan trigger:
Goals:
cnp_receiver_interaction
Goals:
perform_interaction

icnp_initiator_plan

standard plan icnp_initiator_plan(Object cfp, 
                                 Object cfp_info, 
                                 boolean executeall, 
                                 InteractionState interaction_state, 
                                 Boolean iterated, 
                                 String language, 
                                 String ontology, 
                                 Long timeout, 
                                 NegotiationRecord [set] history, 
                                 AgentIdentifier [set] receivers, 
                                 Object [set] result)
Parameters:
in parameter cfp (goal mappings: icnp_initiate.cfp)
in parameter cfp_info (goal mappings: icnp_initiate.cfp_info)
in parameter executeall Default value:  false
 (goal mappings: icnp_initiate.executeall)
out parameter interaction_state (goal mappings: icnp_initiate.interaction_state)
in parameter iterated Default value:  Boolean.TRUE
in parameter language (goal mappings: icnp_initiate.language)
in parameter ontology (goal mappings: icnp_initiate.ontology)
in parameter timeout (goal mappings: icnp_initiate.timeout)
in parameterset history (goal mappings: icnp_initiate.history)
in parameterset receivers (goal mappings: icnp_initiate.receivers)
out parameterset result (goal mappings: icnp_initiate.result)
Plan body:
Plan trigger:
Goals:
icnp_initiate

icnp_evaluateproposals_plan

standard plan icnp_evaluateproposals_plan(Object cfp, 
                                         Object cfp_info, 
                                         ParticipantProposal [set] acceptables, 
                                         NegotiationRecord [set] history, 
                                         ParticipantProposal [set] proposals)
Default plan for evaluate proposals goal.

Parameters:
in parameter cfp (goal mappings: icnp_evaluate_proposals.cfp)
in parameter cfp_info (goal mappings: icnp_evaluate_proposals.cfp_info)
optional out parameterset acceptables (goal mappings: icnp_evaluate_proposals.acceptables)
in parameterset history (goal mappings: icnp_evaluate_proposals.history)
in parameterset proposals (goal mappings: icnp_evaluate_proposals.proposals)
Plan body:
Plan trigger:
Goals:
icnp_evaluate_proposals

icnp_querynextroundinfo_plan

standard plan icnp_querynextroundinfo_plan(Object cfp, 
                                          Object cfp_info, 
                                          Boolean iterate, 
                                          NegotiationRecord [set] history, 
                                          AgentIdentifier [set] participants, 
                                          ParticipantProposal [set] proposals)
Default plan for query nextround-info goal.

Parameters:
in parameter cfp (goal mappings: icnp_nextround_info.cfp)
inout parameter cfp_info (goal mappings: icnp_nextround_info.cfp_info)
out parameter iterate (goal mappings: icnp_nextround_info.iterate)
in parameterset history (goal mappings: icnp_nextround_info.history)
inout parameterset participants (goal mappings: icnp_nextround_info.participants)
in parameterset proposals (goal mappings: icnp_nextround_info.proposals)
Plan body:
Plan trigger:
Goals:
icnp_nextround_info

icnp_receiver_plan

standard plan icnp_receiver_plan(Object interaction_description, 
                                InteractionState interaction_state, 
                                Boolean iterated, 
                                IMessageEvent message, 
                                Object result)
Parameters:
out parameter interaction_description (goal mappings: icnp_receiver_interaction.interaction_description perform_interaction.interaction_description)
out parameter interaction_state (goal mappings: icnp_receiver_interaction.interaction_state perform_interaction.interaction_state)
in parameter iterated Default value:  Boolean.TRUE
in parameter message (goal mappings: icnp_receiver_interaction.message perform_interaction.message)
out parameter result (goal mappings: icnp_receiver_interaction.result perform_interaction.result)
Plan body:
Plan trigger:
Goals:
icnp_receiver_interaction
Goals:
perform_interaction

ea_initiator_plan

standard plan ea_initiator_plan(AuctionDescription auction_description, 
                               Object cfp, 
                               Object cfp_info, 
                               InteractionState interaction_state, 
                               String language, 
                               Comparable limit, 
                               String ontology, 
                               Object result, 
                               AgentIdentifier [set] receivers)
Parameters:
in parameter auction_description (goal mappings: ea_initiate.auction_description)
in parameter cfp (goal mappings: ea_initiate.cfp)
in parameter cfp_info (goal mappings: ea_initiate.cfp_info)
out parameter interaction_state (goal mappings: ea_initiate.interaction_state)
in parameter language (goal mappings: ea_initiate.language)
in parameter limit (goal mappings: ea_initiate.limit)
in parameter ontology (goal mappings: ea_initiate.ontology)
in parameter result (goal mappings: ea_initiate.result)
in parameterset receivers (goal mappings: ea_initiate.receivers)
Plan body:
Plan trigger:
Goals:
ea_initiate

ea_receiver_plan

standard plan ea_receiver_plan(Object interaction_description, 
                              InteractionState interaction_state, 
                              IMessageEvent message, 
                              Object result)
Parameters:
out parameter interaction_description (goal mappings: ea_receiver_interaction.interaction_description perform_interaction.interaction_description)
out parameter interaction_state (goal mappings: ea_receiver_interaction.interaction_state perform_interaction.interaction_state)
in parameter message (goal mappings: ea_receiver_interaction.message perform_interaction.message)
out parameter result (goal mappings: ea_receiver_interaction.result perform_interaction.result)
Plan body:
Plan trigger:
Goals:
ea_receiver_interaction
Goals:
perform_interaction

da_initiator_plan

standard plan da_initiator_plan(AuctionDescription auction_description, 
                               Object cfp, 
                               Object cfp_info, 
                               InteractionState interaction_state, 
                               String language, 
                               String ontology, 
                               Object result, 
                               AgentIdentifier [set] receivers)
Parameters:
in parameter auction_description (goal mappings: da_initiate.auction_description)
in parameter cfp (goal mappings: da_initiate.cfp)
in parameter cfp_info (goal mappings: da_initiate.cfp_info)
out parameter interaction_state (goal mappings: da_initiate.interaction_state)
in parameter language (goal mappings: da_initiate.language)
in parameter ontology (goal mappings: da_initiate.ontology)
in parameter result (goal mappings: da_initiate.result)
in parameterset receivers (goal mappings: da_initiate.receivers)
Plan body:
Plan trigger:
Goals:
da_initiate

da_receiver_plan

standard plan da_receiver_plan(Object interaction_description, 
                              InteractionState interaction_state, 
                              IMessageEvent message, 
                              Object result)
Parameters:
out parameter interaction_description (goal mappings: da_receiver_interaction.interaction_description perform_interaction.interaction_description)
out parameter interaction_state (goal mappings: da_receiver_interaction.interaction_state perform_interaction.interaction_state)
in parameter message (goal mappings: da_receiver_interaction.message perform_interaction.message)
out parameter result (goal mappings: da_receiver_interaction.result perform_interaction.result)
Plan body:
Plan trigger:
Goals:
da_receiver_interaction
Goals:
perform_interaction

cm_interaction_goal_creation_plan

standard plan cm_interaction_goal_creation_plan(String goaltype)
FIPA-Cancel-Meta-Protocol generic interaction goal creation plan.

Parameters:
in parameter goaltype Default value:  "cm_receiver_interaction"
Plan body:
Plan trigger:
Message events:
cm_cancel

cm_receiver_plan

standard plan cm_receiver_plan(IMessageEvent message)
Plan for cancelling an interaction (receiver side of FIPA-Cancel-Meta-Protocol).

Parameters:
in parameter message (goal mappings: cm_receiver_interaction.message perform_interaction.message)
Plan body:
Plan trigger:
Goals:
cm_receiver_interaction
Goals:
perform_interaction

cm_approve_cancel_plan

standard plan cm_approve_cancel_plan(boolean result)
Default plan for deciding about cancellation.

Parameters:
in parameter result Default value:  false
 (goal mappings: cm_approve_cancel.result)
Plan body:
Plan trigger:
Goals:
cm_approve_cancel
Event Detail

rp_request

exported messageevent rp_request(String conversation-id, 
                                 String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
in parameter language Default value:  SFipa.NUGGETS_XML
- SFipa.createUniqueId($scope.getAgentName())
fixed parameter performative Default value:  SFipa.REQUEST
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_agree

exported messageevent rp_agree(String language, 
                               String performative, 
                               String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.AGREE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_refuse

exported messageevent rp_refuse(String language, 
                                String performative, 
                                String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REFUSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_failure

exported messageevent rp_failure(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.FAILURE
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_not_understood

exported messageevent rp_not_understood(String language, 
                                        String performative, 
                                        String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

rp_inform

exported messageevent rp_inform(String language, 
                                String performative, 
                                String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_REQUEST
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_cfp

exported messageevent cnp_cfp(String conversation-id, 
                              String language, 
                              String performative, 
                              String protocol)
- cnp

Parameters:
inout parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
- hmm inout needed to read it in plan :-(
in parameter language Default value:  SFipa.NUGGETS_XML
- SFipa.createUniqueId($scope.getAgentName())
fixed parameter performative Default value:  SFipa.CFP
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_propose

exported messageevent cnp_propose(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.PROPOSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_refuse

exported messageevent cnp_refuse(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REFUSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_reject

exported messageevent cnp_reject(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REJECT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_accept

exported messageevent cnp_accept(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.ACCEPT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_inform

exported messageevent cnp_inform(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_failure

exported messageevent cnp_failure(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.FAILURE
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cnp_not_understood

exported messageevent cnp_not_understood(String language, 
                                         String performative, 
                                         String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_cfp

exported messageevent icnp_cfp(String conversation-id, 
                               String language, 
                               String performative, 
                               String protocol)
- icnp

Parameters:
inout parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
- hmm inout needed to read it in plan :-(
in parameter language Default value:  SFipa.NUGGETS_XML
- SFipa.createUniqueId($scope.getAgentName())
fixed parameter performative Default value:  SFipa.CFP
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_propose

exported messageevent icnp_propose(String language, 
                                   String performative, 
                                   String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.PROPOSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_refuse

exported messageevent icnp_refuse(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REFUSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_reject

exported messageevent icnp_reject(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REJECT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_accept

exported messageevent icnp_accept(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.ACCEPT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_inform

exported messageevent icnp_inform(String language, 
                                  String performative, 
                                  String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_failure

exported messageevent icnp_failure(String language, 
                                   String performative, 
                                   String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.FAILURE
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

icnp_not_understood

exported messageevent icnp_not_understood(String language, 
                                          String performative, 
                                          String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_ITERATED_CONTRACT_NET
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_inform_start_auction

exported messageevent ea_inform_start_auction(AuctionDescription content, 
                                              String conversation-id, 
                                              String encoding, 
                                              String language, 
                                              String performative, 
                                              String protocol)
english auction

Parameters:
inout parameter content
inout parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
fixed parameter encoding Default value:  "begin_auction"
- This is no encoding, but this is the only parameter left.
in parameter language Default value:  SFipa.NUGGETS_XML
- SFipa.createUniqueId($scope.getAgentName())
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_inform_end_auction

exported messageevent ea_inform_end_auction(String encoding, 
                                            String language, 
                                            String performative, 
                                            String protocol)
Parameters:
fixed parameter encoding Default value:  "end_auction"
- This is no encoding, but this is the only parameter left.
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_cfp

exported messageevent ea_cfp(String language, 
                             String performative, 
                             String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.CFP
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_propose

exported messageevent ea_propose(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.PROPOSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_not_understood

exported messageevent ea_not_understood(String language, 
                                        String performative, 
                                        String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_reject_proposal

exported messageevent ea_reject_proposal(String language, 
                                         String performative, 
                                         String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REJECT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

ea_accept_proposal

exported messageevent ea_accept_proposal(String language, 
                                         String performative, 
                                         String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.ACCEPT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_ENGLISH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_inform_start_auction

exported messageevent da_inform_start_auction(AuctionDescription content, 
                                              String conversation-id, 
                                              String encoding, 
                                              String language, 
                                              String performative, 
                                              String protocol)
dutch auction

Parameters:
inout parameter content
inout parameter conversation-id Default value:  SFipa.createUniqueId($scope.getAgentName())
fixed parameter encoding Default value:  "begin_auction"
- This is no encoding, but this is the only parameter left.
in parameter language Default value:  SFipa.NUGGETS_XML
- SFipa.createUniqueId($scope.getAgentName())
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_inform_end_auction

exported messageevent da_inform_end_auction(String encoding, 
                                            String language, 
                                            String performative, 
                                            String protocol)
Parameters:
fixed parameter encoding Default value:  "end_auction"
- This is no encoding, but this is the only parameter left.
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_cfp

exported messageevent da_cfp(String language, 
                             String performative, 
                             String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.CFP
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_propose

exported messageevent da_propose(String language, 
                                 String performative, 
                                 String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.PROPOSE
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_not_understood

exported messageevent da_not_understood(String language, 
                                        String performative, 
                                        String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_reject_proposal

exported messageevent da_reject_proposal(String language, 
                                         String performative, 
                                         String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.REJECT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

da_accept_proposal

exported messageevent da_accept_proposal(String language, 
                                         String performative, 
                                         String protocol)
Parameters:
in parameter language Default value:  SFipa.NUGGETS_XML
fixed parameter performative Default value:  SFipa.ACCEPT_PROPOSAL
fixed parameter protocol Default value:  SFipa.PROTOCOL_DUTCH_AUCTION
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cm_cancel

messageevent cm_cancel(String performative, 
                       String protocol)
Cancel message sent by initiator side to terminate an ongoing interaction. Part of the generic FIPA-Cancel-Meta-Protocol (CM).

Parameters:
fixed parameter performative Default value:  SFipa.CANCEL
fixed parameter protocol Default value:  SFipa.PROTOCOL_CANCEL_META
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cm_inform

messageevent cm_inform(String performative, 
                       String protocol)
Inform message sent by receiver side describing successful termination of an ongoing interaction. Part of the generic FIPA-Cancel-Meta-Protocol (CM).

Parameters:
fixed parameter performative Default value:  SFipa.INFORM
fixed parameter protocol Default value:  SFipa.PROTOCOL_CANCEL_META
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cm_failure

messageevent cm_failure(String performative, 
                        String protocol)
Failure message sent by receiver side describing failed termination of an ongoing interaction. Part of the generic FIPA-Cancel-Meta-Protocol (CM).

Parameters:
fixed parameter performative Default value:  SFipa.FAILURE
fixed parameter protocol Default value:  SFipa.PROTOCOL_CANCEL_META
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false

cm_not_understood

messageevent cm_not_understood(String performative)
Not-understood message sent by receiver side describing the whish to abort the interaction.

Parameters:
fixed parameter performative Default value:  SFipa.NOT_UNDERSTOOD
Event flags:
direction: send_receive
message type: fipa
random selection: false
post to all: false
Expression Detail

find_interaction_goal

expression find_interaction_goal
todo!!!

Expression:
select one $g.getName() from IRGoal $g in $goalbase.getGoals() where $g.hasParameter("message") && ((IMessageEvent)$g.getParameter("message").getValue()) .getParameter(SFipa.CONVERSATION_ID).getValue().equals($convid)
Parameter:  String $convid

Jadex 0.96

Submit a bug or feature
For further API reference and developer documentation, see the Jadex User Guide and the Jadex Tutorial. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, and working code examples.

Copyright (C) 2002-2007 Lars Braubach, Alexander Pokahr - University of Hamburg. Use is subject to license terms.