org.cristalise.kernel.entity

Interface AgentOperations

All Superinterfaces:

ItemOperations

All Known Subinterfaces:

Agent

All Known Implementing Classes:

_AgentStub, ActiveEntity, AgentImplementation, AgentPOA, AgentPOATie

public interface AgentOperations
extends ItemOperations

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.

Method Summary

Modifier and Type	Method and Description
void	addRole(String roleName) Add this Agent to the given role
void	refreshJobList(SystemKey itemKey, String stepPath, String newJobs) Supplies the new set of jobs for the given item and activity.
void	removeRole(String roleName) Remove this Agent from the given role

Methods inherited from interface org.cristalise.kernel.entity.ItemOperations

delegatedAction, getSystemKey, initialise, queryData, queryLifeCycle, requestAction

Method Detail

refreshJobList

void refreshJobList(SystemKey itemKey,
                    String stepPath,
                    String newJobs)

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.

Parameters:

itemKey - the item which generated the jobs. The Agent should discard any existing jobs for that Item.

stepPath - the Activity within the lifecycle of the item which the jobs relate to

newJobs - an XML marshalled JobArrayList containing the new Jobs

addRole

void addRole(String roleName)
      throws ObjectNotFoundException,
             CannotManageException

Add this Agent to the given role

Parameters:

roleName - the new role to add

Throws:

ObjectNotFoundException - when the role doesn't exist

CannotManageException - when an error occurs writing the data to LDAP

removeRole

void removeRole(String roleName)
         throws ObjectNotFoundException,
                CannotManageException

Remove this Agent from the given role

Parameters:

the - role name to remove

Throws:

CannotManageException - when an error occurs writing the data to LDAP

ObjectNotFoundException