org.cristalise.kernel.entity.AgentPOATie Maven / Gradle / Ivy
package org.cristalise.kernel.entity;
/**
* org/cristalise/kernel/entity/AgentPOATie.java .
* Generated by the IDL-to-Java compiler (portable), version "3.2"
* from /home/travis/build/cristal-ise/kernel/src/main/idl/Entity.idl
* Tuesday, June 26, 2018 6:11:44 PM UTC
*/
/**************************************************************************
* Agent is a ManageableEntity that represents an Activity executor in the
* system. It holds a job list, which are persistent requests for execution
* from waiting activities assigned to a role that has such Job pushing enabled.
**************************************************************************/
public class AgentPOATie extends AgentPOA
{
// Constructors
public AgentPOATie ( org.cristalise.kernel.entity.AgentOperations delegate ) {
this._impl = delegate;
}
public AgentPOATie ( org.cristalise.kernel.entity.AgentOperations delegate , org.omg.PortableServer.POA poa ) {
this._impl = delegate;
this._poa = poa;
}
public org.cristalise.kernel.entity.AgentOperations _delegate() {
return this._impl;
}
public void _delegate (org.cristalise.kernel.entity.AgentOperations delegate ) {
this._impl = delegate;
}
public org.omg.PortableServer.POA _default_POA() {
if(_poa != null) {
return _poa;
}
else {
return super._default_POA();
}
}
/** Supplies the new set of jobs for the given item and activity. The Agent should replace all existing jobs for that activity
* with the given set. This method should generally only be called by a workflow while performing an execution.
*
* @param itemKey the item which generated the jobs. The Agent should discard any existing jobs for that Item.
* @param stepPath the Activity within the lifecycle of the item which the jobs relate to
* @param newJobs an XML marshalled {@link org.cristalise.kernel.entity.agent.JobArrayList JobArrayList} containing the new Jobs
**/
public void refreshJobList (org.cristalise.kernel.common.SystemKey itemKey, String stepPath, String newJobs)
{
_impl.refreshJobList(itemKey, stepPath, newJobs);
} // refreshJobList
/** Add this Agent to the given role
* @param roleName the new role to add
* @throws ObjectNotFoundException when the role doesn't exist
* @throws CannotManageException when an error occurs writing the data to LDAP
**/
public void addRole (String roleName) throws org.cristalise.kernel.common.ObjectNotFoundException, org.cristalise.kernel.common.CannotManageException
{
_impl.addRole(roleName);
} // addRole
/** Remove this Agent from the given role
* @param the role name to remove
* @throws CannotManageException when an error occurs writing the data to LDAP
**/
public void removeRole (String roleName) throws org.cristalise.kernel.common.ObjectNotFoundException, org.cristalise.kernel.common.CannotManageException
{
_impl.removeRole(roleName);
} // removeRole
/**
* System generated unique key of the Entity. It is a 128 bit UUID, expressed as two 64 bit longs in the IDLs, but as a UUID object in the Java kernel. The ItemPath is used as the Item identifier in the kernel and its API,
which can be derived from either a UUID object or a SystemKey structure.
**/
public org.cristalise.kernel.common.SystemKey getSystemKey ()
{
return _impl.getSystemKey();
} // getSystemKey
/** Initialises a new Item. Initial properties and the lifecycle are supplied. They should come from the Item's description.
*
* @param agentKey the Agent doing the initialisation
* @param itemProps The XML marshalled {@link org.cristalise.kernel.Property.PropertyArrayList PropertyArrayList} containing the initial
* Property objects of the Item
* @param workflow The XML marshalled new lifecycle of the Item
* @param collection The XML marshalled CollectionArrayList of the initial state of the Item's collections
* @exception ObjectNotFoundException
**/
public void initialise (org.cristalise.kernel.common.SystemKey agentKey, String itemProps, String workflow, String collections) throws org.cristalise.kernel.common.AccessRightsException, org.cristalise.kernel.common.InvalidDataException, org.cristalise.kernel.common.PersistencyException, org.cristalise.kernel.common.ObjectNotFoundException, org.cristalise.kernel.common.InvalidCollectionModification
{
_impl.initialise(agentKey, itemProps, workflow, collections);
} // initialise
/**
* Returns a chunk of XML which may be a serialized C2KLocalObject, or in the case of Outcomes is merely a fragment of XML.
*
* @param path - All Entity data is arranged in a tree structure which uniquely identifies that object within the Entity it is contained, according to the following scheme:
* LifeCycle/workflow (Items only): The Workflow object for this Item, containing the graph of activities defining the Item's lifecycle, and the Predefined Step container for data modificationCollection/{Name} (Items only): Collection objects defining links between ItemsProperty/{Name}: Name value pairs to idenfity this Entity, define its type, and hold any other oft-changing indicators that would be heavy to extract from OutcomesAuditTrail/{ID} (Items only): Events describing all activity state changes in this Item.Outcome/{Schema name}/{Schema version}/{Event ID} (Items only): XML fragments resulting from the execution of an Activity, validated against the XML Schema defined by that activity.ViewPoint/{Schema name}/{Name} (Items only): A named pointer to the latest version of an Outcome, defined by the Activity.Job/{ID} (Agents only): A persistent Job, reflecting a request for execution of an Activity to this Agent. Not all roles create persistent Jobs like this, only those specifically flagged to do so.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy