Package org.cristalise.kernel.entity

Class ItemVertxEBProxy

java.lang.Object

org.cristalise.kernel.entity.ItemVertxEBProxy

All Implemented Interfaces:

Item

public class ItemVertxEBProxy
extends Object
implements Item

Constructor Summary

Constructors

Constructor	Description
ItemVertxEBProxy(io.vertx.core.Vertx vertx, String address)
ItemVertxEBProxy(io.vertx.core.Vertx vertx, String address, io.vertx.core.eventbus.DeliveryOptions options)

Method Summary

Modifier and Type	Method	Description
io.vertx.core.Future<String>	queryLifeCycle(String itemUuid, String agentUuid, boolean filter)	Returns a set of Jobs for this Agent on this Item.
io.vertx.core.Future<String>	requestAction(String itemUuid, String agentUuid, String stepPath, int transitionID, String requestData, String fileName, List<Byte> attachment)	Requests a transition of an Activity in this Item's workflow.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ItemVertxEBProxy

public ItemVertxEBProxy(io.vertx.core.Vertx vertx,
 String address)

ItemVertxEBProxy

public ItemVertxEBProxy(io.vertx.core.Vertx vertx,
 String address,
 io.vertx.core.eventbus.DeliveryOptions options)

Method Details

requestAction

public io.vertx.core.Future<String> requestAction(String itemUuid,
 String agentUuid,
 String stepPath,
 int transitionID,
 String requestData,
 String fileName,
 List<Byte> attachment)

Description copied from interface: Item

Requests a transition of an Activity in this Item's workflow. If possible and permitted, an Event is generated and stored, the Activity's state is updated, which may cause the Workflow to proceed. If this transition requires Outcome data, this is supplied and stored, and a Viewpoint will be created or updated to point to this latest version. In the case of PredefinedSteps, additional data changes may be performed in the server data. This method should not be called directly, as there is a large client side to activity execution implemented in the Proxy objects, such as script execution and schema validation.

Specified by:

requestAction in interface Item

Parameters:

itemUuid - The UUID of the Item to be requested.

agentUuid - The UUID of the Agent. Some activities may be restricted in which roles may execute them. Some transitions cause the activity to be assigned to the executing Agent.

stepPath - The path in the Workflow to the desired Activity

transitionID - The transition to be performed

requestData - The XML Outcome of the work defined by the Activity. Must be valid to the XML Schema, though this is not verified on the server, rather in the AgentProxy in the Client API.

fileName - the name of the file associated with attachment

attachment - binary data associated with the Outcome (can be empty)

Returns:

a Future that will be completed with the result.

queryLifeCycle

public io.vertx.core.Future<String> queryLifeCycle(String itemUuid,
 String agentUuid,
 boolean filter)

Description copied from interface: Item

Returns a set of Jobs for this Agent on this Item. Each Job represents a possible transition of a particular Activity in the Item's lifecycle. The list may be filtered to only refer to currently active activities.

Specified by:

queryLifeCycle in interface Item

Parameters:

itemUuid - The UUID of the Item to be queried.

agentUuid - The UUID the Agent requesting Jobs.

filter - If true, then only Activities which are currently active will be included.

Returns:

a Future that will be completed with the result.