Module org.cruk.clarity.api

Package org.cruk.clarity.api.automation.impl

Class ClarityProcessAutomationImpl

java.lang.Object

org.cruk.clarity.api.automation.impl.ClarityProcessAutomationImpl

All Implemented Interfaces:

ClarityProcessAutomation

public class ClarityProcessAutomationImpl
extends Object
implements ClarityProcessAutomation

Helper for moving Clarity processes through their stages using the "click through" newer methods rather than the API's ExecutableProcess end point.

Since:

2.31.2

Field Summary

Fields

Modifier and Type	Field	Description
protected ClarityAPI	api	Clarity API.
protected Logger	logger	Logger.

Constructor Summary

Constructors

Constructor	Description
ClarityProcessAutomationImpl()	Constructor.
ClarityProcessAutomationImpl(ClarityAPI api)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	advanceStep(ProcessStep step)	Move a process step on to the next stage.
ProcessStep	beginProcessStep(StepCreation stepCreation)	Start a protocol step as if running through Clarity.
Protocol	findProtocol(String name)	Find a protocol by name.
Stage	findStage(Workflow workflow, String name)	Find a stage in a work flow by name.
ProtocolStep	findStep(Protocol protocol, String name)	Find a step in a protocol by name.
Workflow	findWorkflow(String name)	Find a work flow by name.
int	getWait()	Get the time to wait between polls.
int	getWaitAttempts()	Get the number of times to ask for a state change before stopping.
void	setClarityAPI(ClarityAPI api)	Set the API.
void	setWait(int wait)	Set the wait time between polls.
void	setWaitAttempts(int waitAttempts)	Set the number of times to ask for a state change before stopping.
ProgramStatus	startProgram(AvailableProgram program)	Start execution of an EPP as part of a process step moving through Clarity.
void	waitUntilProcessInState(ProcessStep step, ProcessState desiredState)	Wait until a process has reached a certain state.
void	waitUntilProgramCompletes(AvailableProgram program, ProgramStatus status)	Wait for an EPP to finish running.

Methods inherited from class java.lang.Object

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

Field Details

logger

protected Logger logger

Logger.

api

protected ClarityAPI api

Clarity API.

Constructor Details

ClarityProcessAutomationImpl

public ClarityProcessAutomationImpl()

Constructor.

ClarityProcessAutomationImpl

public ClarityProcessAutomationImpl(ClarityAPI api)

Constructor.

Parameters:

api - The Clarity API.

Method Details

setClarityAPI

@Autowired
public void setClarityAPI(ClarityAPI api)

Set the API.

Parameters:

api - The Clarity API.

getWait

public int getWait()

Get the time to wait between polls.

Specified by:

getWait in interface ClarityProcessAutomation

Returns:

The wait time, in milliseconds.

setWait

public void setWait(int wait)

Set the wait time between polls.

Specified by:

setWait in interface ClarityProcessAutomation

Parameters:

wait - The wait time, in milliseconds.

getWaitAttempts

public int getWaitAttempts()

Get the number of times to ask for a state change before stopping.

Specified by:

getWaitAttempts in interface ClarityProcessAutomation

Returns:

The number of polls.

setWaitAttempts

public void setWaitAttempts(int waitAttempts)

Set the number of times to ask for a state change before stopping.

Specified by:

setWaitAttempts in interface ClarityProcessAutomation

Parameters:

waitAttempts - The number of polls.

beginProcessStep

public ProcessStep beginProcessStep(StepCreation stepCreation)

Start a protocol step as if running through Clarity. This is a call through to the same method on the Java client API, provided here to allow the whole process to be run through this utility.

Specified by:

beginProcessStep in interface ClarityProcessAutomation

Parameters:

stepCreation - The step creation object. See Genologics' API documentation.

Returns:

The ProcessStep object for the step started.

See Also:

• ClarityAPI.beginProcessStep(StepCreation)
• Clarity API documentation
• Starting a Protocol Step via the API

advanceStep

public void advanceStep(ProcessStep step)
                 throws InterruptedException

Move a process step on to the next stage. Tries this a number of times, testing and waiting for that change to complete.

Specified by:

advanceStep in interface ClarityProcessAutomation

Parameters:

step - The step to advance.

Throws:

InterruptedException - if the thread is interrupted while waiting for the state to change.

See Also:

• Clarity API documentation
• Actions documentation
• Advancing and Completing a Step via the API

waitUntilProcessInState

public void waitUntilProcessInState(ProcessStep step,
 ProcessState desiredState)
                             throws InterruptedException

Wait until a process has reached a certain state. Tries this a number of times, testing and waiting for the state to reach that asked for.

Specified by:

waitUntilProcessInState in interface ClarityProcessAutomation

Parameters:

step - The step to advance.

desiredState - The state we're waiting for.

Throws:

InterruptedException - if the thread is interrupted while waiting for the state to change.

startProgram

public ProgramStatus startProgram(AvailableProgram program)

Start execution of an EPP as part of a process step moving through Clarity. This is a call through to the same method on the Java client API, provide here to allow the whole program to be run through this utility.

Specified by:

startProgram in interface ClarityProcessAutomation

Parameters:

program - The program, as listed in the ProcessStep object.

Returns:

An updated program status structure.

See Also:

• Clarity API Documentation

waitUntilProgramCompletes

public void waitUntilProgramCompletes(AvailableProgram program,
 ProgramStatus status)
                               throws InterruptedException

Wait for an EPP to finish running. Tries this a number of times, testing and waiting for the program to finish.

Specified by:

waitUntilProgramCompletes in interface ClarityProcessAutomation

Parameters:

program - The program that is being run.

status - The program status object. This is updated in place.

Throws:

InterruptedException - if the thread is interrupted while waiting for the program to end.

findWorkflow

public Workflow findWorkflow(String name)

Find a work flow by name.

Specified by:

findWorkflow in interface ClarityProcessAutomation

Parameters:

name - The name of the work flow.

Returns:

The Workflow object.

findStage

public Stage findStage(Workflow workflow,
 String name)

Find a stage in a work flow by name.

Specified by:

findStage in interface ClarityProcessAutomation

Parameters:

workflow - The workflow object.

name - The name of the stage.

Returns:

The Stage object.

findProtocol

public Protocol findProtocol(String name)

Find a protocol by name.

Specified by:

findProtocol in interface ClarityProcessAutomation

Parameters:

name - The name of the protocol.

Returns:

The Protocol object.

findStep

public ProtocolStep findStep(Protocol protocol,
 String name)

Find a step in a protocol by name.

Specified by:

findStep in interface ClarityProcessAutomation

Parameters:

protocol - The protocol object.

name - The name of the step.

Returns:

The ProtocolStep object.