Module org.cruk.clarity.api

Package com.genologics.ri.step

Class ProcessStep

java.lang.Object

com.genologics.ri.step.ProcessStep

All Implemented Interfaces:

LimsEntity<ProcessStep>, LimsEntityLinkable<ProcessStep>, Linkable<ProcessStep>, Locatable, Serializable

public class ProcessStep
extends Object
implements LimsEntity<ProcessStep>, Serializable

The detailed representation of a step.

Since API version 2.27, the step can be deleted to cancel a process. Requires the current status of step to be "in progress".

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ActionsLink	actions
protected AutomaticNextStepLink	automaticNextStep
protected List<AvailableProgram>	availablePrograms
protected StepConfiguration	configuration
protected ProcessState	currentState	Now an enumeration since release 2.31.3 of the client.
protected Date	dateCompleted
protected Date	dateStarted
protected StepDetailsLink	details
protected String	limsid
protected PlacementsLink	placements
protected PoolsLink	pools
protected ProgramStatusLink	programStatus
protected ReagentLotsLink	reagentLots
protected ReagentsLink	reagents
protected StepSetupLink	setup
protected URI	uri

Constructor Summary

Constructors

Constructor	Description
ProcessStep()
ProcessStep(URI uri)
ProcessStep(URI uri, String limsid)

Method Summary

Modifier and Type	Method	Description
AvailableProgram	addAvailableProgram(AvailableProgram ap)
ActionsLink	getActions()
AutomaticNextStepLink	getAutomaticNextStep()
List<AvailableProgram>	getAvailablePrograms()
StepConfiguration	getConfiguration()
ProcessState	getCurrentState()
Date	getDateCompleted()
Date	getDateStarted()
String	getLimsid()	Get the LIMS id for this object.
PlacementsLink	getPlacements()
PoolsLink	getPools()
ProgramStatusLink	getProgramStatus()
ReagentLotsLink	getReagentLots()
ReagentsLink	getReagents()
StepSetupLink	getSetup()
StepDetailsLink	getStepDetails()
URI	getUri()	Get the URI of this object.
void	setActions(ActionsLink actions)
void	setAutomaticNextStep(Linkable<ProcessStep> step)
void	setConfiguration(StepConfiguration configuration)
void	setCurrentState(ProcessState currentState)
void	setDateCompleted(Date dateCompleted)
void	setDateStarted(Date dateStarted)
void	setDetails(Linkable<StepDetails> link)
void	setLimsid(String limsid)	Set the LIMS id for this object.
void	setPlacements(Linkable<Placements> placements)
void	setPools(Linkable<Pools> pools)
void	setProgramStatus(Linkable<ProgramStatus> programStatus)
void	setReagentLots(Linkable<ReagentLots> link)
void	setReagents(Linkable<Reagents> reagents)
void	setSetup(Linkable<StepSetup> link)
void	setUri(URI uri)	Set the URI of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.genologics.ri.LimsEntityLinkable

getLimsId, setLimsId

Field Details

dateStarted

protected Date dateStarted

Since:

2.22

dateCompleted

protected Date dateCompleted

Since:

2.22

configuration

protected StepConfiguration configuration

actions

protected ActionsLink actions

reagents

protected ReagentsLink reagents

pools

protected PoolsLink pools

placements

protected PlacementsLink placements

reagentLots

protected ReagentLotsLink reagentLots

Since:

2.18

programStatus

protected ProgramStatusLink programStatus

setup

protected StepSetupLink setup

Since:

2.18

details

protected StepDetailsLink details

Since:

2.18

availablePrograms

protected List<AvailableProgram> availablePrograms

Since:

2.18

automaticNextStep

protected AutomaticNextStepLink automaticNextStep

Since:

2.22

uri

protected URI uri

limsid

protected String limsid

currentState

protected ProcessState currentState

Now an enumeration since release 2.31.3 of the client.

Since:

2.18

Constructor Details

ProcessStep

public ProcessStep()

ProcessStep

public ProcessStep(URI uri)

ProcessStep

public ProcessStep(URI uri,
 String limsid)

Method Details

getDateStarted

public Date getDateStarted()

setDateStarted

public void setDateStarted(Date dateStarted)

getDateCompleted

public Date getDateCompleted()

setDateCompleted

public void setDateCompleted(Date dateCompleted)

getConfiguration

public StepConfiguration getConfiguration()

setConfiguration

public void setConfiguration(StepConfiguration configuration)

getActions

public ActionsLink getActions()

setActions

public void setActions(ActionsLink actions)

getReagents

public ReagentsLink getReagents()

setReagents

public void setReagents(Linkable<Reagents> reagents)

getPools

public PoolsLink getPools()

setPools

public void setPools(Linkable<Pools> pools)

getPlacements

public PlacementsLink getPlacements()

setPlacements

public void setPlacements(Linkable<Placements> placements)

getProgramStatus

public ProgramStatusLink getProgramStatus()

setProgramStatus

public void setProgramStatus(Linkable<ProgramStatus> programStatus)

getUri

public URI getUri()

Description copied from interface: Locatable

Get the URI of this object.

Specified by:

getUri in interface Locatable

Returns:

The URI.

setUri

public void setUri(URI uri)

Description copied from interface: Locatable

Set the URI of this object.

Specified by:

setUri in interface Locatable

Parameters:

uri - The new URI.

getLimsid

public String getLimsid()

Description copied from interface: LimsEntityLinkable

Get the LIMS id for this object.

Specified by:

getLimsid in interface LimsEntityLinkable<ProcessStep>

Returns:

The LIMS id.

setLimsid

public void setLimsid(String limsid)

Description copied from interface: LimsEntityLinkable

Set the LIMS id for this object.

Specified by:

setLimsid in interface LimsEntityLinkable<ProcessStep>

Parameters:

limsid - The new LIMS id.

getReagentLots

public ReagentLotsLink getReagentLots()

setReagentLots

public void setReagentLots(Linkable<ReagentLots> link)

getSetup

public StepSetupLink getSetup()

setSetup

public void setSetup(Linkable<StepSetup> link)

getStepDetails

public StepDetailsLink getStepDetails()

setDetails

public void setDetails(Linkable<StepDetails> link)

getAvailablePrograms

public List<AvailableProgram> getAvailablePrograms()

addAvailableProgram

public AvailableProgram addAvailableProgram(AvailableProgram ap)

getCurrentState

public ProcessState getCurrentState()

setCurrentState

public void setCurrentState(ProcessState currentState)

getAutomaticNextStep

public AutomaticNextStepLink getAutomaticNextStep()

setAutomaticNextStep

public void setAutomaticNextStep(Linkable<ProcessStep> step)