Serialized Form

Package com.genologics.ri

Class com.genologics.ri.Address

class Address extends Object implements Serializable

serialVersionUID:

5343736859063068514L

Serialized Fields

city

String city

The city.

country

String country

The country.

department

String department

The department.

institution

String institution

The institution.

postalCode

String postalCode

The postal or zip code.

state

String state

The state or province.

street

String street

The street address.

Class com.genologics.ri.ContainerLink

class ContainerLink extends LimsEntityLinkBase<Container> implements Serializable

serialVersionUID:

4920381830737280136L

Serialized Fields

limsid

String limsid

The LIMS id of the container.

uri

URI uri

The URI of the container.

Class com.genologics.ri.ExternalId

class ExternalId extends Object implements Serializable

serialVersionUID:

-6268759708863731052L

Serialized Fields

id

URI id

The id referencing the external system.

uri

URI uri

The URI within the external system.

Class com.genologics.ri.Index

class Index extends Object implements Serializable

serialVersionUID:

-458228684534981324L

Serialized Fields

links

List<Link> links

The list of links in this index.

Class com.genologics.ri.LimsEntityLinkBase

class LimsEntityLinkBase extends LimsLinkBase<E extends LimsEntity<E>> implements Serializable

serialVersionUID:

1270112019741356772L

Class com.genologics.ri.LimsLinkBase

class LimsLinkBase extends Object implements Serializable

serialVersionUID:

-3855777262069587770L

Class com.genologics.ri.Link

class Link extends Object implements Serializable

serialVersionUID:

7144458168274015747L

Serialized Fields

relative

String relative

The relative part of the link.

uri

URI uri

The URI of the link.

Class com.genologics.ri.Links

class Links extends Object implements Serializable

serialVersionUID:

8838137119064380847L

Serialized Fields

linkList

List<Link> linkList

The list of links.

Class com.genologics.ri.Location

class Location extends LimsEntityLinkBase<Container> implements Serializable

serialVersionUID:

-2461753783129402323L

Serialized Fields

container

ContainerLink container

The container link.

wellPosition

String wellPosition

The well position within the container.

Class com.genologics.ri.Page

class Page extends Object implements Serializable

serialVersionUID:

-5699038454764689725L

Serialized Fields

uri

URI uri

The URI to the page.

Package com.genologics.ri.artifact

Class com.genologics.ri.artifact.Artifact

class Artifact extends Object implements Serializable

serialVersionUID:

4667019853212119178L

Serialized Fields

artifactGroups

List<ArtifactGroupLink> artifactGroups

The list of artifact groups this artifact belongs to.

controlType

ControlTypeLink controlType

The control type if this artifact is a control sample.

demux

DemuxLink demux

The demultiplexing information for this artifact if it is a pool.

Since:

2.26

fields

List<UDF> fields

The list of user-defined fields for this artifact.

file

ClarityFile file

The file associated with this artifact, if any.

limsid

String limsid

The LIMS id of the artifact.

location

Location location

The location of the artifact.

name

String name

The name of the artifact.

outputType

OutputType outputType

The output type of the artifact.

parentProcess

ParentProcessLink parentProcess

The parent process that produced this artifact.

qcFlag

QCFlag qcFlag

The quality control flag for this artifact.

reagentLabels

List<ReagentLabel> reagentLabels

The list of reagent labels applied to this artifact.

samples

List<SampleLink> samples

The list of samples associated with this artifact.

type

String type

The type of the artifact.

uri

URI uri

The URI of the artifact.

workflowStages

List<WorkflowStage> workflowStages

The workflow stages this artifact is associated with.

Since:

2.20

workingFlag

Boolean workingFlag

Flag indicating if this artifact is in a working state.

Class com.genologics.ri.artifact.ArtifactBatchFetchResult

class ArtifactBatchFetchResult extends Object implements Serializable

serialVersionUID:

-1280235468943933621L

Serialized Fields

artifacts

List<Artifact> artifacts

The list of artifacts in this batch.

Class com.genologics.ri.artifact.ArtifactGroupLink

class ArtifactGroupLink extends LimsLinkBase<ArtifactGroup> implements Serializable

serialVersionUID:

3815644574567253825L

Serialized Fields

name

String name

The name of this artifact group.

uri

URI uri

The URI of this artifact group.

Class com.genologics.ri.artifact.ArtifactLink

class ArtifactLink extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

-7338824559555981618L

Serialized Fields

limsid

String limsid

The LIMS id of this artifact.

uri

URI uri

The URI of this artifact.

Class com.genologics.ri.artifact.Artifacts

class Artifacts extends Object implements Serializable

serialVersionUID:

2523274106664095426L

Serialized Fields

artifacts

List<ArtifactLink> artifacts

The list of artifact links.

nextPage

Page nextPage

The next page of results.

previousPage

Page previousPage

The previous page of results.

Class com.genologics.ri.artifact.ControlTypeLink

class ControlTypeLink extends LimsLinkBase<ControlType> implements Serializable

serialVersionUID:

-4203696627970925073L

Serialized Fields

uri

URI uri

The URI of this control type.

Class com.genologics.ri.artifact.Demux

class Demux extends Object implements Serializable

serialVersionUID:

8873892961025197978L

Serialized Fields

artifact

DemuxSourceArtifact artifact

The source artifact being demultiplexed.

demuxDetails

DemuxDetails demuxDetails

The demux details of this demux.

uri

URI uri

The URI of this demux.

Class com.genologics.ri.artifact.DemuxArtifact

class DemuxArtifact extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

8205564798487086835L

Serialized Fields

demux

DemuxDetails demux

The demux details of this demux artifact.

name

String name

The name of this demux artifact.

reagentLabels

List<ReagentLabel> reagentLabels

The reagent labels in this demux artifact.

samples

List<DemuxArtifactSample> samples

The samples in this demux artifact.

uri

URI uri

The URI of this demux artifact.

Class com.genologics.ri.artifact.DemuxArtifactSample

class DemuxArtifactSample extends LimsEntityLinkBase<Sample> implements Serializable

serialVersionUID:

7139520312009522858L

Serialized Fields

limsid

String limsid

The LIMS id of this demux artifact sample.

uri

URI uri

The URI of this demux artifact sample.

Class com.genologics.ri.artifact.DemuxDetails

class DemuxDetails extends Object implements Serializable

serialVersionUID:

-6725351237693935651L

Serialized Fields

artifacts

List<DemuxArtifact> artifacts

The artifacts in this demux details.

poolStep

PoolStep poolStep

The pool step of this demux details.

Class com.genologics.ri.artifact.DemuxLink

class DemuxLink extends LimsLinkBase<DemuxArtifact> implements Serializable

serialVersionUID:

-3140263256856604670L

Serialized Fields

uri

URI uri

The URI of this demux artifact.

Class com.genologics.ri.artifact.DemuxSourceArtifact

class DemuxSourceArtifact extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

-3058956251238626047L

Serialized Fields

name

String name

The name of this demux source artifact.

uri

URI uri

The URI of this demux source artifact.

Class com.genologics.ri.artifact.ParentProcessLink

class ParentProcessLink extends LimsEntityLinkBase<ClarityProcess> implements Serializable

serialVersionUID:

-4561570030979835552L

Serialized Fields

limsid

String limsid

The LIMS id of this parent process.

uri

URI uri

The URI of this parent process.

Class com.genologics.ri.artifact.PoolStep

class PoolStep extends LimsLinkBase<ProcessStep> implements Serializable

serialVersionUID:

2462830072429085619L

Serialized Fields

name

String name

The name of this pool step.

uri

URI uri

The URI of this pool step.

Class com.genologics.ri.artifact.ReagentLabel

class ReagentLabel extends Object implements Serializable

serialVersionUID:

7859734987217470470L

Serialized Fields

name

String name

The name of this reagent label.

Class com.genologics.ri.artifact.SampleLink

class SampleLink extends LimsEntityLinkBase<Sample> implements Serializable

serialVersionUID:

-7708212302820162281L

Serialized Fields

limsid

String limsid

The LIMS id of this sample.

uri

URI uri

The URI of this sample.

Class com.genologics.ri.artifact.WorkflowStage

class WorkflowStage extends LimsLinkBase<Stage> implements Serializable

serialVersionUID:

8029803456211993608L

Serialized Fields

name

String name

The name of this workflow stage.

status

Status status

The status of this workflow stage.

uri

URI uri

The URI of this workflow stage.

Package com.genologics.ri.artifactgroup

Class com.genologics.ri.artifactgroup.ArtifactGroup

class ArtifactGroup extends Object implements Serializable

serialVersionUID:

2205878179459911556L

Serialized Fields

artifacts

Artifacts artifacts

Link to the artifacts contained in this group.

name

String name

The name of the artifact group.

uri

URI uri

The URI of this artifact group.

Class com.genologics.ri.artifactgroup.ArtifactGroupLink

class ArtifactGroupLink extends LimsLinkBase<ArtifactGroup> implements Serializable

serialVersionUID:

3168021328679428589L

Serialized Fields

name

String name

The name of the artifact group.

uri

URI uri

The URI of the artifact group.

Class com.genologics.ri.artifactgroup.ArtifactGroups

class ArtifactGroups extends Object implements Serializable

serialVersionUID:

2682947388238084051L

Serialized Fields

artifactGroups

List<ArtifactGroupLink> artifactGroups

The list of artifact group links.

nextPage

Page nextPage

Link to the next page of results.

previousPage

Page previousPage

Link to the previous page of results.

Class com.genologics.ri.artifactgroup.Artifacts

class Artifacts extends Object implements Serializable

serialVersionUID:

-2118023404939650487L

Serialized Fields

uri

URI uri

The URI of the artifacts in this group.

Package com.genologics.ri.automation

Class com.genologics.ri.automation.Automation

class Automation extends Object implements Serializable

serialVersionUID:

8888968017373728807L

Serialized Fields

channel

String channel

The channel for this automation.

context

Context context

The context in which this automation runs.

files

List<ClarityFile> files

The files associated with this automation.

name

String name

The name of this automation.

processTypes

List<ProcessTypeLink> processTypes

The process types associated with this automation.

runProgramPerEvent

Boolean runProgramPerEvent

Flag indicating whether the program should run per event.

script

String script

The script content for this automation.

uri

URI uri

The URI of this automation.

Class com.genologics.ri.automation.AutomationLink

class AutomationLink extends LimsLinkBase<Automation> implements Serializable

serialVersionUID:

3268594731404978793L

Serialized Fields

name

String name

The name of the automation.

uri

URI uri

The URI of the automation.

Class com.genologics.ri.automation.Automations

class Automations extends Object implements Serializable

serialVersionUID:

-3048084395718929498L

Serialized Fields

automations

List<AutomationLink> automations

The list of automation links.

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

uri

URI uri

The URI of this automations resource.

Class com.genologics.ri.automation.ProcessTypeLink

class ProcessTypeLink extends LimsLinkBase<ProcessType> implements Serializable

serialVersionUID:

1189833674343873526L

Serialized Fields

name

String name

The name of the process type.

uri

URI uri

The URI of the process type.

Package com.genologics.ri.configuration

Class com.genologics.ri.configuration.Field

class Field extends Object implements Serializable

serialVersionUID:

-1997333408044717019L

Serialized Fields

allowNonPresetValues

Boolean allowNonPresetValues

Whether values other than preset values are allowed.

attachToCategory

String attachToCategory

The category this field is attached to.

attachToName

String attachToName

The name of the entity type this field is attached to.

childUris

List<String> childUris

The URIs of child fields for hierarchical fields.

controlledVocabulary

Boolean controlledVocabulary

Whether this field uses a controlled vocabulary.

deviation

Boolean deviation

Whether this field represents a deviation.

dynamicPresets

Boolean dynamicPresets

Whether this field uses dynamic presets.

Since:

2.34

editable

Boolean editable

Whether this field is editable.

firstPresetIsDefaultValue

Boolean firstPresetIsDefaultValue

Whether the first preset value is the default.

maxValue

Double maxValue

The maximum value for numeric fields.

minValue

Double minValue

The minimum value for numeric fields.

name

String name

The name of the field.

parentUri

URI parentUri

The URI of the parent field for hierarchical fields.

precision

Integer precision

The display precision for numeric fields.

presets

List<String> presets

The list of preset values for this field.

required

Boolean required

Whether this field is required.

showInLablink

Boolean showInLablink

Whether this field should be shown in Lablink.

showInTables

Boolean showInTables

Whether this field should be shown in tables.

type

FieldType type

The type of this field.

typeDefinition

TypeDefinition typeDefinition

The type definition for complex types.

unitLabel

String unitLabel

The unit label for numeric fields.

uri

URI uri

The URI of this field configuration.

Class com.genologics.ri.configuration.FieldDynamicPreset

class FieldDynamicPreset extends Object implements Serializable

serialVersionUID:

-7014673523064270714L

Serialized Fields

value

String value

The preset value.

Class com.genologics.ri.configuration.FieldDynamicPresetDetails

class FieldDynamicPresetDetails extends Object implements Serializable

serialVersionUID:

-8814597927446111161L

Serialized Fields

presets

List<FieldDynamicPreset> presets

The list of field dynamic presets.

uri

URI uri

The URI of this preset details resource.

Class com.genologics.ri.configuration.FieldLink

class FieldLink extends LimsLinkBase<Field> implements Serializable

serialVersionUID:

5031274064780081067L

Serialized Fields

name

String name

The name of the field.

uri

URI uri

The URI of the field configuration.

Class com.genologics.ri.configuration.Type

class Type extends Object implements Serializable

serialVersionUID:

6975337629090720371L

Serialized Fields

attachToCategory

String attachToCategory

The category this user defined type is attached to.

attachToName

String attachToName

The name of the entity type this user defined type is attached to.

fieldDefinitions

List<FieldLink> fieldDefinitions

The list of field definitions for this type.

name

String name

The name of this type.

uri

URI uri

The URI of this type configuration.

Class com.genologics.ri.configuration.TypeDefinition

class TypeDefinition extends LimsLinkBase<Type> implements Serializable

serialVersionUID:

7368802583367288257L

Serialized Fields

name

String name

The name of the type.

uri

URI uri

The URI of the type definition.

Class com.genologics.ri.configuration.UdfConfigLink

class UdfConfigLink extends LimsLinkBase<Field> implements Serializable

serialVersionUID:

-164190204904044681L

Serialized Fields

attachToCategory

String attachToCategory

The category this field is attached to.

attachToName

String attachToName

The name of the entity type this field is attached to.

name

String name

The name of the field.

uri

URI uri

The URI of the field configuration.

Class com.genologics.ri.configuration.Udfs

class Udfs extends Object implements Serializable

serialVersionUID:

-5458422132487888319L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

udfConfigLinks

List<UdfConfigLink> udfConfigLinks

The list of user defined field configuration links.

Class com.genologics.ri.configuration.UdtConfigLink

class UdtConfigLink extends LimsLinkBase<Type> implements Serializable

serialVersionUID:

-9221186839753173309L

Serialized Fields

attachToCategory

String attachToCategory

The category this user defined type is attached to.

attachToName

String attachToName

The name of the entity type this user defined type is attached to.

name

String name

The name of the type.

uri

URI uri

The URI of the type configuration.

Class com.genologics.ri.configuration.Udts

class Udts extends Object implements Serializable

serialVersionUID:

-3512684674322879203L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

udtConfigLinks

List<UdtConfigLink> udtConfigLinks

The list of user defined type configuration links.

Package com.genologics.ri.container

Class com.genologics.ri.container.Container

class Container extends Object implements Serializable

serialVersionUID:

-5274665844559069140L

Serialized Fields

containerType

ContainerTypeLink containerType

Link to the container type.

fields

List<UDF> fields

The list of user-defined fields for the container.

limsid

String limsid

The LIMS id of the container.

name

String name

The name of the container.

occupiedWells

Long occupiedWells

The number of occupied wells in the container.

placements

List<Placement> placements

The list of placements in the container.

state

ContainerState state

Container state. Note this has changed from a string to an enum from release 2.31.6.

type

UDT type

The user-defined type for the container.

uri

URI uri

The URI of the container.

Class com.genologics.ri.container.ContainerBatchFetchResult

class ContainerBatchFetchResult extends Object implements Serializable

serialVersionUID:

3942410984112211790L

Serialized Fields

containers

List<Container> containers

The list of containers.

Class com.genologics.ri.container.ContainerLink

class ContainerLink extends LimsEntityLinkBase<Container> implements Serializable

serialVersionUID:

-3079266542140961317L

Serialized Fields

limsid

String limsid

The LIMS id of the container.

name

String name

The name of the container.

uri

URI uri

The URI of the container.

Class com.genologics.ri.container.Containers

class Containers extends Object implements Serializable

serialVersionUID:

-1488050342582879623L

Serialized Fields

containers

List<ContainerLink> containers

The list of container links.

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

Class com.genologics.ri.container.ContainerTypeLink

class ContainerTypeLink extends LimsLinkBase<ContainerType> implements Serializable

serialVersionUID:

8897150572324942993L

Serialized Fields

name

String name

The name of the container type.

uri

URI uri

The URI of the container type.

Class com.genologics.ri.container.Placement

class Placement extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

-4089394834813900531L

Serialized Fields

limsid

String limsid

The LIMS id of the artifact.

uri

URI uri

The URI of the artifact.

wellPosition

String wellPosition

The well position in the container.

Package com.genologics.ri.containertype

Class com.genologics.ri.containertype.CalibrantWell

class CalibrantWell extends Object implements Serializable

serialVersionUID:

218110772739169852L

Serialized Fields

name

String name

Deprecated.

The name of the calibrant well.

value

String value

Deprecated.

The value or content of the calibrant well.

Class com.genologics.ri.containertype.ContainerType

class ContainerType extends Object implements Serializable

serialVersionUID:

-3778472967085446652L

Serialized Fields

calibrantWells

List<CalibrantWell> calibrantWells

Deprecated.

This property is no longer supported and will be ignored if provided.

List of calibrant wells that are reserved for calibrants in containers of this type.

columns

Dimension columns

The x-dimension (horizontal/columns) of the container's coordinate system.

name

String name

The name of the container type.

rows

Dimension rows

The y-dimension (vertical/rows) of the container's coordinate system.

tube

Boolean tube

Indicates whether this container type represents a tube (single well) or a multi-well container.

unavailableWells

List<String> unavailableWells

List of well locations that are not available for storing samples or reagents. Well locations are specified using the coordinate system defined by the x-dimension and y-dimension.

uri

URI uri

The URI for accessing this container type resource.

Class com.genologics.ri.containertype.ContainerTypeLink

class ContainerTypeLink extends LimsLinkBase<ContainerType> implements Serializable

serialVersionUID:

7125345264225985052L

Serialized Fields

name

String name

The name of the container type.

uri

URI uri

The URI for accessing the container type resource.

Class com.genologics.ri.containertype.ContainerTypes

class ContainerTypes extends Object implements Serializable

serialVersionUID:

8642031910932251369L

Serialized Fields

containerTypes

List<ContainerTypeLink> containerTypes

The list of container type links.

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

Class com.genologics.ri.containertype.Dimension

class Dimension extends Object implements Serializable

serialVersionUID:

-1931190014491768673L

Serialized Fields

alpha

Boolean alpha

Whether numbering in this dimension is using letters (true) or numbers (false).

offset

Integer offset

The offset applied to the first element in this dimension. For example, an offset of 1 means the first element is numbered/lettered as 1 or B instead of 0 or A.

size

Integer size

The size (number of elements) in this dimension.

Package com.genologics.ri.controltype

Class com.genologics.ri.controltype.ControlType

class ControlType extends Object implements Serializable

serialVersionUID:

-3152986669595427342L

Serialized Fields

archived

Boolean archived

Flag indicating if the control type is archived.

catalogueNumber

String catalogueNumber

The catalogue number of the control type.

concentration

String concentration

The concentration of the control type.

Since:

2.20

name

String name

The name of the control type.

singleStep

Boolean singleStep

Flag indicating if the control type is for single step.

supplier

String supplier

The supplier of the control type.

uri

URI uri

The URI of the control type.

website

String website

The website URL for the control type.

Class com.genologics.ri.controltype.ControlTypeLink

class ControlTypeLink extends LimsLinkBase<ControlType> implements Serializable

serialVersionUID:

7850681628082855516L

Serialized Fields

name

String name

The name of the control type.

uri

URI uri

The URI of the control type.

Class com.genologics.ri.controltype.ControlTypes

class ControlTypes extends Object implements Serializable

serialVersionUID:

5668622843069816173L

Serialized Fields

controlTypes

List<ControlTypeLink> controlTypes

The list of control type links.

uri

URI uri

The URI of the control types collection.

Package com.genologics.ri.exception

Class com.genologics.ri.exception.Exception

class Exception extends Object implements Serializable

serialVersionUID:

8552752622433159544L

Serialized Fields

category

String category

The category of the exception.

code

String code

The HTTP response code corresponding to the error (e.g., 400 for bad request, 500 for internal server error).

message

String message

A textual summary of the error that occurred.

suggestedActions

String suggestedActions

Details on how to correct the problem that caused the exception.

Package com.genologics.ri.file

Class com.genologics.ri.file.ClarityFile

class ClarityFile extends LimsEntityLinkBase<ClarityFile> implements Serializable

serialVersionUID:

-6683975101172687186L

Serialized Fields

attachedTo

URI attachedTo

The URI of the resource that this file is attached to (e.g., a project, sample, process, or artifact).

contentLocation

URI contentLocation

The network location URI where the file content can be retrieved.

limsid

String limsid

The LIMS id of the file.

originalLocation

String originalLocation

The original name and location of the file before it was imported into the system.

originalName

String originalName

The original name of the file before it was imported into the system.

Since:

2.26

published

Boolean published

Indicates whether the file is displayed in LabLink.

uri

URI uri

The URI of the file resource.

Class com.genologics.ri.file.ClarityFileBatchFetchResult

class ClarityFileBatchFetchResult extends Object implements Serializable

serialVersionUID:

-536166874357106044L

Serialized Fields

files

List<ClarityFile> files

The list of file resources in this batch.

Class com.genologics.ri.file.ClarityFiles

class ClarityFiles extends Object implements Serializable

serialVersionUID:

-1824449685486824569L

Serialized Fields

files

List<FileLink> files

The list of file links.

nextPage

Page nextPage

A link to the next page of results, if available.

previousPage

Page previousPage

A link to the previous page of results, if available.

Class com.genologics.ri.file.FileLink

class FileLink extends LimsLinkBase<ClarityFile> implements Serializable

serialVersionUID:

-2151598768590902010L

Serialized Fields

limsid

String limsid

The LIMS id of the file.

uri

URI uri

The URI of the file resource.

Package com.genologics.ri.globaltoken

Class com.genologics.ri.globaltoken.GlobalToken

class GlobalToken extends Object implements Serializable

serialVersionUID:

8999326250541104054L

Serialized Fields

description

String description

The token description.

isCustom

Boolean isCustom

Flag indicating whether this is a custom token.

name

String name

The token name.

uri

URI uri

The URI of this global token.

value

String value

The token value.

Class com.genologics.ri.globaltoken.GlobalTokenLink

class GlobalTokenLink extends LimsLinkBase<GlobalToken> implements Serializable

serialVersionUID:

2340905402174078413L

Serialized Fields

name

String name

The token name.

uri

URI uri

The URI of the global token.

Class com.genologics.ri.globaltoken.GlobalTokens

class GlobalTokens extends Object implements Serializable

serialVersionUID:

-6362088116923564852L

Serialized Fields

globalTokens

List<GlobalTokenLink> globalTokens

The list of global token links.

nextPage

Page nextPage

The next page of results.

previousPage

Page previousPage

The previous page of results.

Package com.genologics.ri.instrument

Class com.genologics.ri.instrument.Instrument

class Instrument extends Object implements Serializable

serialVersionUID:

1517557403395348841L

Serialized Fields

archived

Boolean archived

Whether the instrument has been archived.

Since:

2.25

expiryDate

String expiryDate

The instrument expiry date.

Since:

2.25

limsid

String limsid

The LIMS id of this instrument as provided by the server.

Since:

2.25

name

String name

The instrument name.

serialNumber

String serialNumber

The instrument serial number.

Since:

2.25

type

String type

The instrument type.

uri

URI uri

The URI of this instrument.

Class com.genologics.ri.instrument.InstrumentLink

class InstrumentLink extends LimsEntityLinkBase<Instrument> implements Serializable

serialVersionUID:

4463465224415870496L

Serialized Fields

name

String name

The instrument name.

uri

URI uri

The URI of the instrument.

Class com.genologics.ri.instrument.Instruments

class Instruments extends Object implements Serializable

serialVersionUID:

-525885513170744397L

Serialized Fields

instruments

List<InstrumentLink> instruments

The list of instrument links.

nextPage

Page nextPage

The next page reference.

previousPage

Page previousPage

The previous page reference.

Package com.genologics.ri.instrumenttype

Class com.genologics.ri.instrumenttype.InstrumentType

class InstrumentType extends Object implements Serializable

serialVersionUID:

7273963191417975L

Serialized Fields

name

String name

The instrument type name.

processTypes

List<InstrumentTypeProcessType> processTypes

The list of process types associated with this instrument type.

uri

URI uri

The URI of the instrument type.

vendor

String vendor

The instrument vendor.

Class com.genologics.ri.instrumenttype.InstrumentTypeLink

class InstrumentTypeLink extends LimsLinkBase<InstrumentType> implements Serializable

serialVersionUID:

3927957034901059387L

Serialized Fields

name

String name

The instrument type name.

uri

URI uri

The URI of the instrument type.

vendor

String vendor

The instrument vendor.

Class com.genologics.ri.instrumenttype.InstrumentTypeProcessType

class InstrumentTypeProcessType extends Object implements Serializable

serialVersionUID:

89917917703984734L

Serialized Fields

name

String name

The process type name.

uri

URI uri

The process type URI.

Class com.genologics.ri.instrumenttype.InstrumentTypes

class InstrumentTypes extends Object implements Serializable

serialVersionUID:

1268811869773163450L

Serialized Fields

instrumentTypes

List<InstrumentTypeLink> instrumentTypes

The list of instrument type links.

nextPage

Page nextPage

The next page reference.

Since:

2.31

previousPage

Page previousPage

The previous page reference.

Since:

2.31

Package com.genologics.ri.lab

Class com.genologics.ri.lab.Lab

class Lab extends Object implements Serializable

serialVersionUID:

8559819171292932068L

Serialized Fields

billingAddress

Address billingAddress

The billing address for the lab.

externalIds

List<ExternalId> externalIds

The list of external identifiers for the lab.

fields

List<UDF> fields

The list of user-defined fields for the lab.

name

String name

The name of the lab.

shippingAddress

Address shippingAddress

The shipping address for the lab.

type

UDT type

The user-defined type for the lab.

uri

URI uri

The URI of the lab resource.

website

String website

The website URL of the lab.

Class com.genologics.ri.lab.LabLink

class LabLink extends LimsEntityLinkBase<Lab> implements Serializable

serialVersionUID:

5826900114630147822L

Serialized Fields

name

String name

The name of the lab.

uri

URI uri

The URI of the lab resource.

Class com.genologics.ri.lab.Labs

class Labs extends Object implements Serializable

serialVersionUID:

-2447458193812155143L

Serialized Fields

labs

List<LabLink> labs

The list of lab links.

nextPage

Page nextPage

The next page of results.

previousPage

Page previousPage

The previous page of results.

Package com.genologics.ri.permission

Class com.genologics.ri.permission.Permission

class Permission extends Object implements Serializable

serialVersionUID:

5000872708185118382L

Serialized Fields

action

String action

The permission action.

description

String description

The permission description.

name

String name

The permission name.

uri

URI uri

The URI of the permission.

Class com.genologics.ri.permission.PermissionLink

class PermissionLink extends LimsLinkBase<Permission> implements Serializable

serialVersionUID:

-1000854973822260389L

Serialized Fields

action

String action

The permission action.

name

String name

The permission name.

uri

URI uri

The URI of the permission.

Class com.genologics.ri.permission.Permissions

class Permissions extends Object implements Serializable

serialVersionUID:

-8403111885816697046L

Serialized Fields

permissions

List<PermissionLink> permissions

The list of permission links.

uri

String uri

The URI of the permissions collection.

Package com.genologics.ri.process

Class com.genologics.ri.process.ArtifactLink

class ArtifactLink extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

5173462831311577367L

Serialized Fields

limsid

String limsid

The LIMS id of the artifact.

outputGenerationType

OutputGenerationType outputGenerationType

The output generation type of the artifact.

outputType

OutputType outputType

The output type of the artifact.

parentProcess

ParentProcessLink parentProcess

The parent process link.

postProcessUri

URI postProcessUri

The post-process URI of the artifact.

uri

URI uri

The URI of the artifact.

Class com.genologics.ri.process.ClarityProcess

class ClarityProcess extends Object implements Serializable

serialVersionUID:

6767285324829996005L

Serialized Fields

dateRun

Date dateRun

The date the process was run.

fields

List<UDF> fields

The user defined fields.

files

List<ClarityFile> files

The files associated with the process.

inputOutputMaps

List<InputOutputMap> inputOutputMaps

The input-output mappings for the process.

instrument

InstrumentLink instrument

The instrument used to run the process.

limsid

String limsid

The LIMS id of the process.

parameter

Parameter parameter

The process parameter for external program integration.

processType

ProcessTypeLink processType

The type of the process.

protocolName

String protocolName

The protocol name.

technician

Technician technician

The technician who ran the process.

type

UDT type

The user defined type.

uri

URI uri

The URI of the process.

Class com.genologics.ri.process.ClarityProcesses

class ClarityProcesses extends Object implements Serializable

serialVersionUID:

-4214726592787580002L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

processes

List<ProcessLink> processes

The list of process links.

Class com.genologics.ri.process.InputOutputMap

class InputOutputMap extends Object implements Serializable

serialVersionUID:

1174916419431443420L

Serialized Fields

input

ArtifactLink input

The input artifact link.

output

ArtifactLink output

The output artifact link.

Class com.genologics.ri.process.InstrumentLink

class InstrumentLink extends LimsEntityLinkBase<Instrument> implements Serializable

serialVersionUID:

-5626088397896460506L

Serialized Fields

uri

URI uri

The URI of the instrument.

Class com.genologics.ri.process.Parameter

class Parameter extends Object implements Serializable

serialVersionUID:

3233972579407259573L

Serialized Fields

name

String name

The name of the parameter.

Class com.genologics.ri.process.ParentProcessLink

class ParentProcessLink extends LimsEntityLinkBase<ClarityProcess> implements Serializable

serialVersionUID:

-6557381570589306115L

Serialized Fields

limsid

String limsid

The LIMS id of the parent process.

uri

URI uri

The URI of the parent process.

Class com.genologics.ri.process.ProcessLink

class ProcessLink extends LimsEntityLinkBase<ClarityProcess> implements Serializable

serialVersionUID:

6298646614909486599L

Serialized Fields

limsid

String limsid

The LIMS id of the process.

uri

URI uri

The URI of the process.

Class com.genologics.ri.process.ProcessTypeLink

class ProcessTypeLink extends Object implements Serializable

serialVersionUID:

1852325206868769788L

Serialized Fields

name

String name

The name of the process type.

uri

URI uri

The URI of the process type.

Class com.genologics.ri.process.Technician

class Technician extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

7149503177948978718L

Serialized Fields

firstName

String firstName

The first name of the technician.

lastName

String lastName

The last name of the technician.

uri

URI uri

The URI of the technician.

Package com.genologics.ri.processexecution

Class com.genologics.ri.processexecution.ArtifactBase

class ArtifactBase extends Object implements Serializable

serialVersionUID:

-946571040944446567L

Serialized Fields

qcFlag

QCFlag qcFlag

The quality control flag for this artifact.

Class com.genologics.ri.processexecution.ExecutableInputOutputMap

class ExecutableInputOutputMap extends Object implements Serializable

serialVersionUID:

-5751963471358280360L

Serialized Fields

inputs

List<Input> inputs

List of input artifacts.

output

Output output

The output artifact.

shared

Boolean shared

Indicates whether the output is shared among multiple inputs.

Class com.genologics.ri.processexecution.ExecutableProcess

class ExecutableProcess extends Object implements Serializable

serialVersionUID:

-4582482597481524823L

Serialized Fields

dateRun

Date dateRun

The date the process was run.

fields

List<UDF> fields

The user-defined fields.

inputOutputMaps

List<ExecutableInputOutputMap> inputOutputMaps

The input-output mappings for the process.

instrument

InstrumentLink instrument

The instrument used for the process.

parameter

Parameter parameter

The process parameter for external program integration.

processType

String processType

The process type name.

technician

Technician technician

The technician who ran the process.

type

UDT type

The user-defined type.

Class com.genologics.ri.processexecution.Input

class Input extends ArtifactBase implements Serializable

serialVersionUID:

-8366721361957628940L

Serialized Fields

uri

URI uri

The URI of the input artifact.

Class com.genologics.ri.processexecution.InstrumentLink

class InstrumentLink extends LimsEntityLinkBase<Instrument> implements Serializable

serialVersionUID:

7189991495122756369L

Serialized Fields

uri

URI uri

The URI of the instrument.

Class com.genologics.ri.processexecution.Output

class Output extends ArtifactBase implements Serializable

serialVersionUID:

-923589090274221714L

Serialized Fields

location

Location location

The location of the output artifact.

type

OutputType type

The output type.

Class com.genologics.ri.processexecution.Parameter

class Parameter extends Object implements Serializable

serialVersionUID:

8161442493380982959L

Serialized Fields

name

String name

The name of the parameter.

Class com.genologics.ri.processexecution.Technician

class Technician extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

6342603327961394878L

Serialized Fields

uri

URI uri

The URI of the researcher acting as technician.

Package com.genologics.ri.processtemplate

Class com.genologics.ri.processtemplate.InstrumentLink

class InstrumentLink extends LimsEntityLinkBase<Instrument> implements Serializable

serialVersionUID:

-2255676271595073801L

Serialized Fields

uri

URI uri

The URI of the instrument.

Class com.genologics.ri.processtemplate.Parameter

class Parameter extends Object implements Serializable

serialVersionUID:

-8795139448974204288L

Serialized Fields

name

String name

The name of the parameter.

Class com.genologics.ri.processtemplate.ProcessTemplate

class ProcessTemplate extends Object implements Serializable

serialVersionUID:

3219761173873030207L

Serialized Fields

defaultTemplate

Boolean defaultTemplate

Indicates whether this is the default template for the associated process type.

fields

List<UDF> fields

The user-defined fields.

instrument

InstrumentLink instrument

The instrument configured to run processes created from this template.

name

String name

The name of this process template.

parameter

Parameter parameter

The process parameter for external program integration.

processType

ProcessTypeLink processType

The process type this template is associated with.

technician

Technician technician

The technician configured to run processes created from this template.

type

UDT type

The user-defined type.

uri

URI uri

The URI of this process template.

Class com.genologics.ri.processtemplate.ProcessTemplateLink

class ProcessTemplateLink extends LimsLinkBase<ProcessTemplate> implements Serializable

serialVersionUID:

-4745812706787102584L

Serialized Fields

name

String name

The name of the process template.

uri

URI uri

The URI of the process template.

Class com.genologics.ri.processtemplate.ProcessTemplates

class ProcessTemplates extends Object implements Serializable

serialVersionUID:

-1986524456179019901L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

processTemplates

List<ProcessTemplateLink> processTemplates

The list of process template links.

Class com.genologics.ri.processtemplate.ProcessTypeLink

class ProcessTypeLink extends Object implements Serializable

serialVersionUID:

-4446494931025385173L

Serialized Fields

name

String name

The name of the process type.

uri

URI uri

The URI of the process type.

Class com.genologics.ri.processtemplate.Technician

class Technician extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

-8798198413338733052L

Serialized Fields

firstName

String firstName

The first name of the technician.

lastName

String lastName

The last name of the technician.

uri

URI uri

The URI linking to the detailed representation of this technician in the system.

Package com.genologics.ri.processtype

Class com.genologics.ri.processtype.ContainerTypeLink

class ContainerTypeLink extends LimsLinkBase<Container> implements Serializable

serialVersionUID:

3628143663166434766L

Serialized Fields

name

String name

The name of the container type.

uri

URI uri

The URI of the container type.

Class com.genologics.ri.processtype.ControlTypeLink

class ControlTypeLink extends LimsLinkBase<ControlType> implements Serializable

serialVersionUID:

3029231159973544772L

Serialized Fields

name

String name

The name of the control type.

uri

URI uri

The URI of the control type.

Class com.genologics.ri.processtype.EppTrigger

class EppTrigger extends Object implements Serializable

serialVersionUID:

3481787346877063815L

Serialized Fields

name

String name

The name of the EPP trigger.

point

TriggerPoint point

The point at which the trigger executes (before or after).

status

TriggerStatus status

The status at which the trigger executes.

type

TriggerType type

The type of the trigger (manual, automatic, or unused).

Class com.genologics.ri.processtype.Field

class Field extends Object implements Serializable

serialVersionUID:

7870381376405702078L

Serialized Fields

attachTo

String attachTo

The entity to which this field is attached.

name

String name

The name of the field.

style

Style style

The style of the field (user-defined or built-in).

Class com.genologics.ri.processtype.IceBucketField

class IceBucketField extends Field implements Serializable

serialVersionUID:

8915614372544937283L

Serialized Fields

detail

Boolean detail

Indicates whether this field shows in the detail view.

Class com.genologics.ri.processtype.Parameter

class Parameter extends Object implements Serializable

serialVersionUID:

-803288179230938758L

Serialized Fields

channel

String channel

The channel on which the EPP runs.

file

String file

Deprecated.

This property is no longer supported.

The file of the parameter.

files

List<ClarityFile> files

Files associated with this parameter.

Since:

2.26

invocationType

InvocationType invocationType

Deprecated.

This property is no longer supported.

The invocation type of the EPP.

name

String name

The name of the parameter.

runProgramPerEvent

Boolean runProgramPerEvent

Deprecated.

This property is no longer supported.

Whether the EPP should run once for each process-related event.

script

String script

The EPP script text that will actually run.

Class com.genologics.ri.processtype.ProcessInput

class ProcessInput extends Object implements Serializable

serialVersionUID:

-2733188258573850043L

Serialized Fields

artifactType

String artifactType

The artifact type for the input.

displayName

String displayName

The display name for the input.

removeWorkingFlag

Boolean removeWorkingFlag

Deprecated.

This property is no longer supported.

Whether the working flag should be removed from the input when the process runs.

Class com.genologics.ri.processtype.ProcessOutput

class ProcessOutput extends Object implements Serializable

serialVersionUID:

3584171153300804850L

Serialized Fields

artifactType

String artifactType

The artifact type for the output.

assignWorkingFlag

Boolean assignWorkingFlag

Deprecated.

This property is no longer supported.

Whether the working flag should be assigned to the output when the process runs.

displayName

String displayName

The display name for the output.

fieldDefinitions

List<FieldLink> fieldDefinitions

Deprecated.

These field definitions are ignored as of Clarity LIMS 5.0.

Field definitions for the output.

numberOfOutputs

Integer numberOfOutputs

The number of outputs to generate (only applies if variabilityType is FIXED).

outputGenerationType

OutputGenerationType outputGenerationType

Specifies how the outputs are generated in relation to the inputs.

outputName

String outputName

Pattern for specifying how the output name is generated.

variabilityType

VariabilityType variabilityType

Specifies how the process determines the number of outputs to generate.

Class com.genologics.ri.processtype.ProcessType

class ProcessType extends Object implements Serializable

serialVersionUID:

3103866326222677563L

Serialized Fields

eppTriggers

List<EppTrigger> eppTriggers

EPP triggers for this process type.

Since:

2.25

fieldDefinitions

List<FieldLink> fieldDefinitions

Field definitions for user-defined fields.

iceBucketFields

List<IceBucketField> iceBucketFields

Fields displayed in the ice bucket view.

Since:

2.25

name

String name

The name of the process type.

parameters

List<Parameter> parameters

EPP parameters for this process type.

permittedContainers

List<ContainerTypeLink> permittedContainers

Permitted container types for this process.

Since:

2.25

permittedControlTypes

List<ControlTypeLink> permittedControlTypes

Permitted control types for this process.

Since:

2.25

permittedInstrumentTypes

List<String> permittedInstrumentTypes

Permitted instrument types for this process.

Since:

2.25

permittedReagentCategories

List<String> permittedReagentCategories

Permitted reagent categories for this process.

Since:

2.25

processInputs

List<ProcessInput> processInputs

Process input configurations.

processOutputs

List<ProcessOutput> processOutputs

Process output configurations.

processTypeAttributes

List<ProcessTypeAttribute> processTypeAttributes

Internal process type attributes.

queueFields

List<QueueField> queueFields

Fields displayed in the queue view.

Since:

2.25

requiredReagentKits

List<ReagentKitLink> requiredReagentKits

Required reagent kits for this process.

Since:

2.25

sampleFields

List<Field> sampleFields

Fields displayed for samples in the step view.

Since:

2.25

stepFields

List<Field> stepFields

Fields displayed in the step view.

Since:

2.25

stepProperties

List<StepProperty> stepProperties

Properties for the step configuration.

Since:

2.25

stepSetup

StepSetup stepSetup

Step setup configuration.

Since:

2.25

typeDefinitions

List<TypeDefinition> typeDefinitions

Type definitions for user-defined types.

uri

URI uri

The URI of the process type.

Class com.genologics.ri.processtype.ProcessTypeAttribute

class ProcessTypeAttribute extends Object implements Serializable

serialVersionUID:

2626426609413434344L

Serialized Fields

name

String name

The name of the attribute.

value

String value

The value of the attribute.

Class com.genologics.ri.processtype.ProcessTypeLink

class ProcessTypeLink extends LimsLinkBase<ProcessType> implements Serializable

serialVersionUID:

5914216290949476076L

Serialized Fields

name

String name

The name of the process type.

uri

URI uri

The URI of the process type.

Class com.genologics.ri.processtype.ProcessTypes

class ProcessTypes extends Object implements Serializable

serialVersionUID:

747260766479912084L

Serialized Fields

nextPage

Page nextPage

Link to the next page of results.

previousPage

Page previousPage

Link to the previous page of results.

processTypes

List<ProcessTypeLink> processTypes

The list of process type links.

Class com.genologics.ri.processtype.QueueField

class QueueField extends Field implements Serializable

serialVersionUID:

2849413901300410668L

Serialized Fields

detail

Boolean detail

Indicates whether this field shows in the detail view.

Class com.genologics.ri.processtype.ReagentKitLink

class ReagentKitLink extends LimsLinkBase<ReagentKit> implements Serializable

serialVersionUID:

7746715136563752804L

Serialized Fields

name

String name

The name of the reagent kit.

uri

URI uri

The URI of the reagent kit.

Class com.genologics.ri.processtype.SharedResultFile

class SharedResultFile extends Object implements Serializable

serialVersionUID:

-4934343881979066853L

Serialized Fields

message

String message

The message associated with this shared result file.

sharedResultFileIndex

String sharedResultFileIndex

The index of this shared result file.

Class com.genologics.ri.processtype.StepProperty

class StepProperty extends Object implements Serializable

serialVersionUID:

-4276491956024298591L

Serialized Fields

name

String name

The name of the step property.

value

String value

The value of the step property.

Class com.genologics.ri.processtype.StepSetup

class StepSetup extends Object implements Serializable

serialVersionUID:

2084961137587517113L

Serialized Fields

enabled

Boolean enabled

Whether the step setup view is enabled for this process type.

files

List<SharedResultFile> files

The list of shared result file configurations.

Class com.genologics.ri.processtype.TypeDefinition

class TypeDefinition extends LimsLinkBase<Field> implements Serializable

serialVersionUID:

2990437613974395091L

Serialized Fields

name

String name

The name of the field.

uri

URI uri

The URI of the field.

Package com.genologics.ri.project

Class com.genologics.ri.project.Project

class Project extends Object implements Serializable

serialVersionUID:

-7543006762891280018L

Serialized Fields

closeDate

Date closeDate

The date the project was closed.

externalIds

List<ExternalId> externalIds

The external identifiers for the project.

fields

List<UDF> fields

The user-defined fields for the project.

files

List<ClarityFile> files

The files attached to the project.

invoiceDate

Date invoiceDate

The date the project was invoiced.

limsid

String limsid

The LIMS id of the project.

name

String name

The name of the project.

openDate

Date openDate

The date the project was opened.

priority

String priority

The priority of the project.

Since:

2.34

researcher

ResearcherLink researcher

The researcher associated with the project.

type

UDT type

The user-defined type of the project.

uri

URI uri

The URI of the project.

Class com.genologics.ri.project.ProjectLink

class ProjectLink extends LimsEntityLinkBase<Project> implements Serializable

serialVersionUID:

5015998464762805841L

Serialized Fields

limsid

String limsid

The LIMS id of the project.

name

String name

The name of the project.

uri

URI uri

The URI of the project.

Class com.genologics.ri.project.Projects

class Projects extends Object implements Serializable

serialVersionUID:

-507792514854460064L

Serialized Fields

nextPage

Page nextPage

The next page of results.

previousPage

Page previousPage

The previous page of results.

projects

List<ProjectLink> projects

The list of project links.

Class com.genologics.ri.project.ResearcherLink

class ResearcherLink extends LimsEntityLinkBase<Researcher> implements Serializable

serialVersionUID:

-7754124824899651369L

Serialized Fields

uri

URI uri

The URI of the researcher.

Package com.genologics.ri.property

Class com.genologics.ri.property.Properties

class Properties extends Object implements Serializable

serialVersionUID:

-4193984606951017687L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

properties

List<PropertyLink> properties

The list of property links.

Class com.genologics.ri.property.PropertyLink

class PropertyLink extends Object implements Serializable

serialVersionUID:

-6134863203392574429L

Serialized Fields

name

String name

The name of the property.

uri

URI uri

The URI of the property.

value

String value

The value of the property.

Package com.genologics.ri.protocolconfiguration

Class com.genologics.ri.protocolconfiguration.Protocol

class Protocol extends Object implements Serializable

serialVersionUID:

-8872729950204682764L

Serialized Fields

index

Integer index

The index of the protocol.

name

String name

The name of the protocol.

protocolProperties

List<ProtocolProperty> protocolProperties

The list of protocol properties.

steps

List<ProtocolStep> steps

The list of steps in this protocol.

uri

URI uri

The URI of the protocol.

Class com.genologics.ri.protocolconfiguration.ProtocolLink

class ProtocolLink extends LimsLinkBase<Protocol> implements Serializable

serialVersionUID:

5561496957381579448L

Serialized Fields

name

String name

The name of the protocol.

uri

URI uri

The URI to the protocol.

Class com.genologics.ri.protocolconfiguration.ProtocolProperty

class ProtocolProperty extends Object implements Serializable

serialVersionUID:

-2121684009872156372L

Serialized Fields

name

String name

The name of the protocol property.

value

String value

The value of the protocol property.

Class com.genologics.ri.protocolconfiguration.Protocols

class Protocols extends Object implements Serializable

serialVersionUID:

-586199251176099998L

Serialized Fields

protocols

List<ProtocolLink> protocols

The list of protocol links.

Package com.genologics.ri.queue

Class com.genologics.ri.queue.ArtifactLink

class ArtifactLink extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

-531351200403814712L

Serialized Fields

limsid

String limsid

The LIMS id of the artifact.

location

Location location

The location of the artifact.

queueTime

Date queueTime

The time when the artifact was queued.

uri

URI uri

The URI of the artifact.

Class com.genologics.ri.queue.Queue

class Queue extends Object implements Serializable

serialVersionUID:

4372664462524847744L

Serialized Fields

artifacts

List<ArtifactLink> artifacts

The list of artifacts in the queue.

name

String name

The name of the queue.

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

protocolStepUri

URI protocolStepUri

The URI of the protocol step for this queue.

uri

URI uri

The URI of the queue.

Package com.genologics.ri.reagentkit

Class com.genologics.ri.reagentkit.ReagentKit

class ReagentKit extends Object implements Serializable

serialVersionUID:

7467244485974104986L

Serialized Fields

archived

Boolean archived

Whether the reagent kit is archived.

catalogueNumber

String catalogueNumber

The catalogue number of the reagent kit.

name

String name

The name of the reagent kit.

supplier

String supplier

The supplier of the reagent kit.

uri

URI uri

The URI of the reagent kit.

website

String website

The website of the reagent kit.

Class com.genologics.ri.reagentkit.ReagentKitLink

class ReagentKitLink extends LimsLinkBase<ReagentKit> implements Serializable

serialVersionUID:

-4850169731111210915L

Serialized Fields

name

String name

The name of the reagent kit.

uri

URI uri

The URI of the reagent kit.

Class com.genologics.ri.reagentkit.ReagentKits

class ReagentKits extends Object implements Serializable

serialVersionUID:

719305311109268363L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

reagentKits

List<ReagentKitLink> reagentKits

The list of reagent kit links.

uri

URI uri

The URI of the reagent kits list.

Package com.genologics.ri.reagentlot

Class com.genologics.ri.reagentlot.ReagentKitLink

class ReagentKitLink extends LimsLinkBase<ReagentKit> implements Serializable

serialVersionUID:

-5659881404760243462L

Serialized Fields

name

String name

The name of the reagent kit.

uri

URI uri

The URI of the reagent kit.

Class com.genologics.ri.reagentlot.ReagentLot

class ReagentLot extends Object implements Serializable

serialVersionUID:

8414977581247533239L

Serialized Fields

createdBy

ResearcherLink createdBy

Link to the researcher who created this reagent lot.

createdDate

Date createdDate

The date when this reagent lot was created in the system.

expiryDate

Date expiryDate

The expiry date of this reagent lot.

lastModifiedBy

ResearcherLink lastModifiedBy

Link to the researcher who last modified this reagent lot.

lastModifiedDate

Date lastModifiedDate

The date when this reagent lot was last modified.

limsid

String limsid

The LIMS id of this reagent lot.

lotNumber

String lotNumber

The lot number identifier for this reagent lot.

name

String name

The name of this reagent lot.

notes

String notes

Additional notes about this reagent lot.

reagentKit

ReagentKitLink reagentKit

Link to the reagent kit that this lot belongs to.

status

Status status

The current status of this reagent lot (e.g., ACTIVE, ARCHIVED).

storageLocation

String storageLocation

The physical storage location of this reagent lot.

uri

URI uri

The URI of this reagent lot resource.

usageCount

Long usageCount

The number of times this reagent lot has been used.

Since:

2.20

Class com.genologics.ri.reagentlot.ReagentLotLink

class ReagentLotLink extends LimsEntityLinkBase<ReagentLot> implements Serializable

serialVersionUID:

-5668438563329514777L

Serialized Fields

limsid

String limsid

The LIMS id of the reagent lot.

name

String name

The name of the Reagent Lot.

Since:

2.31

uri

URI uri

The URI of the reagent lot.

Class com.genologics.ri.reagentlot.ReagentLots

class ReagentLots extends Object implements Serializable

serialVersionUID:

-7760282244017305741L

Serialized Fields

nextPage

Page nextPage

Link to the next page of results, if available.

previousPage

Page previousPage

Link to the previous page of results, if available.

reagentLots

List<ReagentLotLink> reagentLots

The list of reagent lot links.

uri

String uri

The URI of this reagent lots collection.

Class com.genologics.ri.reagentlot.ResearcherLink

class ResearcherLink extends LimsEntityLinkBase<Researcher> implements Serializable

serialVersionUID:

-7080549970267921256L

Serialized Fields

uri

URI uri

The URI of the researcher.

Package com.genologics.ri.reagenttype

Class com.genologics.ri.reagenttype.Attribute

class Attribute extends Object implements Serializable

serialVersionUID:

-1114923515136408861L

Serialized Fields

name

String name

The name of the attribute.

value

String value

The value of the attribute.

Class com.genologics.ri.reagenttype.ReagentType

class ReagentType extends Object implements Serializable

serialVersionUID:

-7390347729777321516L

Serialized Fields

name

String name

The name of the reagent type.

reagentCategory

String reagentCategory

The category of this reagent.

specialType

SpecialType specialType

The special type of this reagent type.

uri

URI uri

The URI of the reagent type.

Class com.genologics.ri.reagenttype.ReagentTypeLink

class ReagentTypeLink extends LimsEntityLinkBase<ReagentType> implements Serializable

serialVersionUID:

-628102520150401023L

Serialized Fields

name

String name

The name of the reagent type.

uri

URI uri

The URI of the reagent type.

Class com.genologics.ri.reagenttype.ReagentTypes

class ReagentTypes extends Object implements Serializable

serialVersionUID:

-3173542275521810830L

Serialized Fields

nextPage

Page nextPage

Link to the next page of results.

previousPage

Page previousPage

Link to the previous page of results.

reagentTypes

List<ReagentTypeLink> reagentTypes

The list of reagent type links.

Class com.genologics.ri.reagenttype.SpecialType

class SpecialType extends Object implements Serializable

serialVersionUID:

2227997075421321531L

Serialized Fields

attributes

List<Attribute> attributes

The list of attributes for this special type.

name

String name

The name of the special type.

Package com.genologics.ri.researcher

Class com.genologics.ri.researcher.Credentials

class Credentials extends Object implements Serializable

serialVersionUID:

-2712902822454057343L

Serialized Fields

accountLocked

Boolean accountLocked

Whether the researcher's account is locked.

password

String password

The researcher's password.

roles

List<Role> roles

The roles assigned to the researcher.

username

String username

The researcher's username.

Class com.genologics.ri.researcher.LabLink

class LabLink extends LimsEntityLinkBase<Lab> implements Serializable

serialVersionUID:

-2199818978989305791L

Serialized Fields

uri

URI uri

The URI to the lab.

Class com.genologics.ri.researcher.Researcher

class Researcher extends Object implements Serializable

serialVersionUID:

2552745292977587999L

Serialized Fields

credentials

Credentials credentials

The researcher's credentials.

email

String email

The researcher's email address.

externalIds

List<ExternalId> externalIds

The external identifiers for the researcher.

fax

String fax

The researcher's fax number.

fields

List<UDF> fields

The user-defined fields for the researcher.

firstName

String firstName

The researcher's first name.

initials

String initials

The researcher's initials.

lab

LabLink lab

Link to the researcher's lab.

lastName

String lastName

The researcher's last name.

phone

String phone

The researcher's phone number.

type

UDT type

The user-defined type for the researcher.

uri

URI uri

The URI to the researcher.

Class com.genologics.ri.researcher.ResearcherLink

class ResearcherLink extends LimsEntityLinkBase<Researcher> implements Serializable

serialVersionUID:

5396333049575412661L

Serialized Fields

firstName

String firstName

The researcher's first name.

lastName

String lastName

The researcher's last name.

uri

URI uri

The URI to the researcher.

Class com.genologics.ri.researcher.Researchers

class Researchers extends Object implements Serializable

serialVersionUID:

1730166894555776245L

Serialized Fields

nextPage

Page nextPage

Link to the next page of results.

previousPage

Page previousPage

Link to the previous page of results.

researchers

List<ResearcherLink> researchers

The list of researcher links.

Class com.genologics.ri.researcher.Role

class Role extends LimsLinkBase<Role> implements Serializable

serialVersionUID:

-4641418115009008515L

Serialized Fields

name

String name

The user-facing name of the security role.

Since:

2.19

roleName

String roleName

Deprecated.

Deprecated from version 2.19.

The role name. Deprecated from version 2.19.

uri

URI uri

The URI to the role.

Since:

2.19

Package com.genologics.ri.role

Class com.genologics.ri.role.PermissionLink

class PermissionLink extends LimsLinkBase<Permission> implements Serializable

serialVersionUID:

6570314965797232412L

Serialized Fields

action

String action

The action associated with the permission.

name

String name

The name of the permission.

uri

URI uri

The URI of the permission.

Class com.genologics.ri.role.ResearcherLink

class ResearcherLink extends LimsEntityLinkBase<Researcher> implements Serializable

serialVersionUID:

-8690537907678526381L

Serialized Fields

firstName

String firstName

The first name of the researcher.

lastName

String lastName

The last name of the researcher.

uri

URI uri

The URI of the researcher.

Class com.genologics.ri.role.Role

class Role extends Object implements Serializable

serialVersionUID:

5417064490465819346L

Serialized Fields

builtIn

Boolean builtIn

Whether this is a built-in system role.

name

String name

The name of the role.

permissions

List<PermissionLink> permissions

The list of permissions assigned to this role.

researchers

List<ResearcherLink> researchers

The list of researchers assigned to this role.

uri

URI uri

The URI of the role.

Class com.genologics.ri.role.RoleLink

class RoleLink extends LimsLinkBase<Role> implements Serializable

serialVersionUID:

-6515590246139208584L

Serialized Fields

name

String name

The name of the role.

uri

URI uri

The URI of the role.

Class com.genologics.ri.role.Roles

class Roles extends Object implements Serializable

serialVersionUID:

-8997233724026640778L

Serialized Fields

roles

List<RoleLink> roles

The list of role links.

uri

URI uri

The URI of the roles list.

Package com.genologics.ri.routing

Class com.genologics.ri.routing.ArtifactLink

class ArtifactLink extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

-5098969484639468234L

Serialized Fields

uri

URI uri

The URI of the artifact.

Class com.genologics.ri.routing.ExtArtifactAssignments

class ExtArtifactAssignments extends Object implements Serializable

serialVersionUID:

5445690350646421054L

Serialized Fields

artifacts

List<ArtifactLink> artifacts

The list of artifact links.

stageUri

URI stageUri

The URI of the stage.

workflowUri

URI workflowUri

The URI of the workflow.

Class com.genologics.ri.routing.Routing

class Routing extends Object implements Serializable

serialVersionUID:

4810146731548918326L

Serialized Fields

assignedRoutes

List<ExtArtifactAssignments> assignedRoutes

The list of artifact assignments to assign to workflows/stages.

unassignedRoutes

List<ExtArtifactAssignments> unassignedRoutes

The list of artifact assignments to unassign from workflows/stages.

Package com.genologics.ri.sample

Class com.genologics.ri.sample.ArtifactLink

class ArtifactLink extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

3393329302381963246L

Serialized Fields

limsid

String limsid

The LIMS id of the artifact.

uri

URI uri

The URI of the artifact.

Class com.genologics.ri.sample.BioSource

class BioSource extends Object implements Serializable

serialVersionUID:

-4781585129823907022L

Serialized Fields

description

String description

Deprecated.

The description of the biosource.

fields

List<UDF> fields

Deprecated.

The user-defined fields for the biosource.

name

String name

Deprecated.

The name of the biosource.

Class com.genologics.ri.sample.ControlTypeLink

class ControlTypeLink extends LimsLinkBase<ControlType> implements Serializable

serialVersionUID:

4125221399101385098L

Serialized Fields

name

String name

The name of the control type.

uri

URI uri

The URI of the control type.

Class com.genologics.ri.sample.ProjectLink

class ProjectLink extends LimsEntityLinkBase<Project> implements Serializable

serialVersionUID:

-4874099265690719737L

Serialized Fields

limsid

String limsid

The LIMS id of the project.

uri

URI uri

The URI of the project.

Class com.genologics.ri.sample.Sample

class Sample extends SampleBase implements Serializable

serialVersionUID:

5852545940907097947L

Class com.genologics.ri.sample.SampleBase

class SampleBase extends Object implements Serializable

serialVersionUID:

7926341075019764297L

Serialized Fields

artifact

ArtifactLink artifact

The artifact associated with this sample.

bioSource

BioSource bioSource

Deprecated.

Biosource is not supported in Clarity.

The biosource of this sample.

controlType

ControlTypeLink controlType

The control type associated with this sample.

dateCompleted

Date dateCompleted

The date the sample was completed.

dateReceived

Date dateReceived

The date the sample was received.

externalIds

List<ExternalId> externalIds

The external identifiers for this sample.

fields

List<UDF> fields

The user-defined fields for this sample.

files

List<ClarityFile> files

The files associated with this sample.

limsid

String limsid

The LIMS id of this sample.

name

String name

The name of the sample.

project

ProjectLink project

The project associated with this sample.

submitter

Submitter submitter

The submitter of this sample.

type

UDT type

The user-defined type of this sample.

uri

URI uri

The URI of this sample.

Class com.genologics.ri.sample.SampleBatchFetchResult

class SampleBatchFetchResult extends Object implements Serializable

serialVersionUID:

8207729034543316762L

Serialized Fields

sampleCreations

List<SampleCreation> sampleCreations

The list of sample creations.

samples

List<Sample> samples

The list of samples.

Class com.genologics.ri.sample.SampleCreation

class SampleCreation extends SampleBase implements Serializable

serialVersionUID:

8233679374775813938L

Serialized Fields

location

Location location

The location where the sample will be created.

Class com.genologics.ri.sample.SampleLink

class SampleLink extends LimsEntityLinkBase<Sample> implements Serializable

serialVersionUID:

-5247716763134908401L

Serialized Fields

limsid

String limsid

The LIMS id of the sample.

uri

URI uri

The URI of the sample.

Class com.genologics.ri.sample.Samples

class Samples extends Object implements Serializable

serialVersionUID:

7481910467952402185L

Serialized Fields

nextPage

Page nextPage

The next page link for pagination.

previousPage

Page previousPage

The previous page link for pagination.

samples

List<SampleLink> samples

The list of sample links.

Class com.genologics.ri.sample.Submitter

class Submitter extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

1302200229944706575L

Serialized Fields

firstName

String firstName

The first name of the submitter.

lastName

String lastName

The last name of the submitter.

uri

URI uri

The URI of the submitter.

Package com.genologics.ri.savedquery

Class com.genologics.ri.savedquery.SavedQueries

class SavedQueries extends Object implements Serializable

serialVersionUID:

-1608597563242261675L

Serialized Fields

nextPage

Page nextPage

The link to the next page of results.

previousPage

Page previousPage

The link to the previous page of results.

savedQueries

List<SavedQueryLink> savedQueries

The list of saved query links.

Class com.genologics.ri.savedquery.SavedQuery

class SavedQuery extends Object implements Serializable

serialVersionUID:

-7815486399547221485L

Serialized Fields

id

String id

The unique identifier of the saved query.

name

String name

The name of the saved query.

uri

URI uri

The URI of the saved query.

Class com.genologics.ri.savedquery.SavedQueryLink

class SavedQueryLink extends LimsLinkBase<SavedQuery> implements Serializable

serialVersionUID:

-262825664905616405L

Serialized Fields

id

String id

The unique identifier of the saved query.

name

String name

The name of the saved query.

uri

URI uri

The URI of the saved query.

Package com.genologics.ri.stage

Class com.genologics.ri.stage.ProtocolLink

class ProtocolLink extends LimsLinkBase<Protocol> implements Serializable

serialVersionUID:

2132801688423667843L

Serialized Fields

uri

URI uri

The URI of the protocol.

Class com.genologics.ri.stage.ProtocolStepLink

class ProtocolStepLink extends LimsLinkBase<ProtocolStep> implements Serializable

serialVersionUID:

-8628711111931596088L

Serialized Fields

uri

URI uri

The URI of the protocol step.

Class com.genologics.ri.stage.Stage

class Stage extends Object implements Serializable

serialVersionUID:

-7190421220331989537L

Serialized Fields

index

Integer index

The index of the stage in the workflow.

name

String name

The name of the stage.

protocol

ProtocolLink protocol

Link to the protocol for this stage.

step

ProtocolStepLink step

Link to the protocol step for this stage.

uri

URI uri

The URI of the stage.

workflow

WorkflowLink workflow

Link to the workflow this stage belongs to.

Class com.genologics.ri.stage.WorkflowLink

class WorkflowLink extends LimsLinkBase<Workflow> implements Serializable

serialVersionUID:

7790581332424089347L

Serialized Fields

uri

URI uri

The URI of the workflow.

Package com.genologics.ri.step

Class com.genologics.ri.step.Actions

class Actions extends Object implements Serializable

serialVersionUID:

-8235969313191790414L

Serialized Fields

configuration

StepConfiguration configuration

Configuration of the step.

escalation

Escalation escalation

Escalation information for the step.

Since:

2.18

nextActions

List<NextAction> nextActions

List of next actions to be performed.

step

Link step

Link to the step.

uri

URI uri

URI of the actions resource.

Class com.genologics.ri.step.ActionsLink

class ActionsLink extends LimsLinkBase<Actions> implements Serializable

serialVersionUID:

3468768301588893685L

Serialized Fields

uri

URI uri

URI of the actions resource.

Class com.genologics.ri.step.Arrangements

class Arrangements extends Object implements Serializable

serialVersionUID:

-5065733682752946764L

Serialized Fields

configuration

StepConfiguration configuration

Configuration of the step.

outputArrangements

List<OutputArrangement> outputArrangements

List of output arrangements.

step

Link step

Link to the step.

uri

URI uri

URI of the arrangements resource.

Class com.genologics.ri.step.ArrangementsLink

class ArrangementsLink extends LimsLinkBase<Arrangements> implements Serializable

serialVersionUID:

3342543381947203376L

Serialized Fields

uri

URI uri

URI of the arrangements resource.

Class com.genologics.ri.step.ArtifactLink

class ArtifactLink extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

-3085489413319927673L

Serialized Fields

limsid

String limsid

LIMS id of the artifact.

outputGenerationType

OutputGenerationType outputGenerationType

The output generation type.

type

OutputType type

The type of the artifact output.

uri

URI uri

URI of the artifact.

Class com.genologics.ri.step.AutomaticNextStepLink

class AutomaticNextStepLink extends LimsLinkBase<ProcessStep> implements Serializable

serialVersionUID:

-7710114187126292590L

Serialized Fields

uri

URI uri

URI of the automatic next step.

Class com.genologics.ri.step.AvailableProgram

class AvailableProgram extends Object implements Serializable

serialVersionUID:

-4101189878995002052L

Serialized Fields

name

String name

Name of the available program.

uri

URI uri

URI of the available program.

Class com.genologics.ri.step.ContainerLink

class ContainerLink extends LimsLinkBase<Container> implements Serializable

serialVersionUID:

7495526539351739682L

Serialized Fields

uri

URI uri

URI of the container.

Class com.genologics.ri.step.CreationInput

class CreationInput extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

8275002091544701688L

Serialized Fields

controlTypeUri

URI controlTypeUri

URI of the control type.

replicates

Long replicates

Number of replicates.

uri

URI uri

URI of the input artifact.

Class com.genologics.ri.step.EscalatedArtifact

class EscalatedArtifact extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

3942629848997667695L

Serialized Fields

uri

URI uri

URI of the escalated artifact.

Class com.genologics.ri.step.Escalation

class Escalation extends Object implements Serializable

serialVersionUID:

-7363821101050828859L

Serialized Fields

escalatedArtifacts

List<EscalatedArtifact> escalatedArtifacts

List of escalated artifacts.

request

EscalationRequest request

The escalation request.

review

EscalationReview review

The escalation review.

Class com.genologics.ri.step.EscalationRequest

class EscalationRequest extends Object implements Serializable

serialVersionUID:

4381438520659390791L

Serialized Fields

author

UserLink author

The author of the escalation request.

comment

String comment

Comment for the escalation request.

date

Date date

The date of the escalation request.

reviewer

UserLink reviewer

The reviewer of the escalation request.

Class com.genologics.ri.step.EscalationReview

class EscalationReview extends Object implements Serializable

serialVersionUID:

-4529608991906508233L

Serialized Fields

author

UserLink author

The author of the escalation review.

comment

String comment

Comment for the escalation review.

date

Date date

The date of the escalation review.

Class com.genologics.ri.step.Input

class Input extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

-2525215280378480778L

Serialized Fields

replicates

Long replicates

Number of replicates for the input.

Since:

2.18

uri

URI uri

URI of the input artifact.

Class com.genologics.ri.step.InputOutputMap

class InputOutputMap extends Object implements Serializable

serialVersionUID:

-6553131277891392216L

Serialized Fields

input

ArtifactLink input

The input artifact link.

output

ArtifactLink output

The output artifact link.

Class com.genologics.ri.step.InstrumentLink

class InstrumentLink extends Object implements Serializable

serialVersionUID:

-8476139725814009464L

Serialized Fields

name

String name

Name of the instrument.

uri

URI uri

URI of the instrument.

Class com.genologics.ri.step.NextAction

class NextAction extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

-8061858911629830727L

Serialized Fields

action

ActionType action

The action type.

artifactUri

URI artifactUri

URI of the artifact.

reworkStepUri

URI reworkStepUri

URI of the rework step.

Since:

2.20

stepUri

URI stepUri

URI of the next step.

Class com.genologics.ri.step.Output

class Output extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

-5292196293632912589L

Serialized Fields

artifactUri

URI artifactUri

URI of the output artifact.

reagentLabels

List<ReagentLabel> reagentLabels

List of reagent labels for the output.

Class com.genologics.ri.step.OutputArrangement

class OutputArrangement extends LimsLinkBase<Container> implements Serializable

serialVersionUID:

-1273770265893773445L

Serialized Fields

rackLocation

RackLocation rackLocation

The rack location for the output arrangement.

uri

URI uri

URI of the output container.

Class com.genologics.ri.step.OutputPlacement

class OutputPlacement extends LimsLinkBase<Artifact> implements Serializable

serialVersionUID:

5187719712136408829L

Serialized Fields

location

Location location

The location of the output artifact in a container.

uri

URI uri

The URI of the output artifact.

Class com.genologics.ri.step.Placements

class Placements extends Object implements Serializable

serialVersionUID:

-1949893881292269955L

Serialized Fields

configuration

StepConfiguration configuration

The configuration for this step.

outputPlacements

List<OutputPlacement> outputPlacements

The list of output placements.

selectedContainers

List<ContainerLink> selectedContainers

The list of selected containers.

step

Link step

The link to the step.

uri

URI uri

The URI of this placements resource.

Class com.genologics.ri.step.PlacementsLink

class PlacementsLink extends LimsLinkBase<Placements> implements Serializable

serialVersionUID:

2017533453426861528L

Serialized Fields

uri

URI uri

The URI of the placements resource.

Class com.genologics.ri.step.PooledInputs

class PooledInputs extends Object implements Serializable

serialVersionUID:

-3807477794297469797L

Serialized Fields

inputs

List<Input> inputs

The list of input artifacts in this pool.

name

String name

The name of this pool.

outputUri

URI outputUri

The URI of the output artifact created from this pool.

Class com.genologics.ri.step.Pools

class Pools extends Object implements Serializable

serialVersionUID:

5682428399776236959L

Serialized Fields

availableInputs

List<Input> availableInputs

The list of available input artifacts that can be pooled.

configuration

StepConfiguration configuration

The configuration for this step.

pooledInputs

List<PooledInputs> pooledInputs

The list of pooled input groups.

step

Link step

The link to the step.

uri

URI uri

The URI of this pools resource.

Class com.genologics.ri.step.PoolsLink

class PoolsLink extends LimsLinkBase<Pools> implements Serializable

serialVersionUID:

130181334136851112L

Serialized Fields

uri

URI uri

The URI of the pools resource.

Class com.genologics.ri.step.ProcessStep

class ProcessStep extends Object implements Serializable

serialVersionUID:

8157777981636538216L

Serialized Fields

actions

ActionsLink actions

Link to the actions associated with this step.

arrangements

ArrangementsLink arrangements

Link to the arrangements associated with this step.

Since:

2.34

automaticNextStep

AutomaticNextStepLink automaticNextStep

Link to the next step that will be automatically triggered after this step.

Since:

2.22

availablePrograms

List<AvailableProgram> availablePrograms

The list of programs available for this step.

Since:

2.18

configuration

StepConfiguration configuration

The configuration of the step.

currentState

ProcessState currentState

The current state of the step. Now an enumeration since release 2.31.3 of the client.

Since:

2.18

dateCompleted

Date dateCompleted

The date and time the step was completed.

Since:

2.22

dateStarted

Date dateStarted

The date and time the step was started.

Since:

2.22

details

StepDetailsLink details

Link to the details associated with this step.

Since:

2.18

limsid

String limsid

The LIMS id of the step.

placements

PlacementsLink placements

Link to the placements associated with this step.

pools

PoolsLink pools

Link to the pools associated with this step.

programStatus

ProgramStatusLink programStatus

Link to the program status associated with this step.

reagentLots

ReagentLotsLink reagentLots

Link to the reagent lots associated with this step.

Since:

2.18

reagents

ReagentsLink reagents

Link to the reagents associated with this step.

setup

StepSetupLink setup

Link to the setup associated with this step.

Since:

2.18

technician

Technician technician

The technician assigned to this step.

Since:

2.34

uri

URI uri

The URI of the step.

Class com.genologics.ri.step.ProgramStatus

class ProgramStatus extends Object implements Serializable

serialVersionUID:

-3133977224031042653L

Serialized Fields

configuration

StepConfiguration configuration

The configuration of the step.

message

String message

The message associated with the program status.

status

Status status

The current status of the program.

step

Link step

Link to the step associated with this program status.

uri

URI uri

The URI of the program status.

Class com.genologics.ri.step.ProgramStatusLink

class ProgramStatusLink extends LimsLinkBase<ProgramStatus> implements Serializable

serialVersionUID:

1364271013485882177L

Serialized Fields

uri

URI uri

The URI of the program status.

Class com.genologics.ri.step.RackLocation

class RackLocation extends Object implements Serializable

serialVersionUID:

1531522948721112254L

Serialized Fields

rackColumn

Integer rackColumn

The column position within the rack.

rackIndex

Integer rackIndex

The index of the rack.

rackRow

Integer rackRow

The row position within the rack.

Class com.genologics.ri.step.ReagentLabel

class ReagentLabel extends Object implements Serializable

serialVersionUID:

-5256319945578711720L

Serialized Fields

name

String name

The name of the reagent label.

Class com.genologics.ri.step.ReagentLotLink

class ReagentLotLink extends LimsEntityLinkBase<ReagentLot> implements Serializable

serialVersionUID:

-5183820950832194933L

Serialized Fields

limsid

String limsid

The LIMS id of the reagent lot.

uri

URI uri

The URI of the reagent lot.

Class com.genologics.ri.step.ReagentLots

class ReagentLots extends Object implements Serializable

serialVersionUID:

27145430586603574L

Serialized Fields

configuration

StepConfiguration configuration

Provides a URI linking to the configuration resource that identifies the protocol step.

reagentLots

List<ReagentLotLink> reagentLots

The list of reagent lots associated with the step.

step

Link step

Provides a URI linking to the step resource.

uri

URI uri

The URI of the reagent lots resource.

Class com.genologics.ri.step.ReagentLotsLink

class ReagentLotsLink extends LimsLinkBase<ReagentLots> implements Serializable

serialVersionUID:

-2260570956329971986L

Serialized Fields

uri

URI uri

The URI of the reagent lots resource.

Class com.genologics.ri.step.Reagents

class Reagents extends Object implements Serializable

serialVersionUID:

4896945008573422890L

Serialized Fields

configuration

StepConfiguration configuration

Configuration of the step.

outputReagents

List<Output> outputReagents

List of output reagents.

reagentCategory

String reagentCategory

The reagent category for the step.

step

Link step

Link to the step.

uri

URI uri

URI of the reagents resource.

Class com.genologics.ri.step.ReagentsLink

class ReagentsLink extends LimsLinkBase<Reagents> implements Serializable

serialVersionUID:

606802593515729159L

Serialized Fields

uri

URI uri

The URI of the reagents resource.

Class com.genologics.ri.step.SharedResultFile

class SharedResultFile extends LimsEntityLinkBase<Artifact> implements Serializable

serialVersionUID:

-1481534271853089634L

Serialized Fields

artifactUri

URI artifactUri

The URI of the artifact representing the shared result file.

limsid

String limsid

The LIMS id of the artifact.

message

String message

Error message associated with the shared result file.

name

String name

The name of the artifact.

sharedResultFileIndex

String sharedResultFileIndex

Index of the shared result file in the configuration.

Class com.genologics.ri.step.StepConfiguration

class StepConfiguration extends Object implements Serializable

serialVersionUID:

7902167896883448736L

Serialized Fields

protocolStepUri

URI protocolStepUri

The URI of the protocol step configuration.

stepName

String stepName

The name of the protocol step.

Class com.genologics.ri.step.StepCreation

class StepCreation extends Object implements Serializable

serialVersionUID:

3624008363559662022L

Serialized Fields

configuration

StepConfiguration configuration

The configuration for the step.

containerType

String containerType

The name of the container type to be used for outputs.

inputs

List<CreationInput> inputs

The list of input artifacts for the step.

reagentCategory

String reagentCategory

The reagent category name.

Class com.genologics.ri.step.StepDetails

class StepDetails extends Object implements Serializable

serialVersionUID:

5865493881321340964L

Serialized Fields

configuration

StepConfiguration configuration

The configuration of the step.

fields

List<UDF> fields

The user-defined fields for the step.

inputOutputMaps

List<InputOutputMap> inputOutputMaps

The list of input to output artifact mappings for the step.

instrument

InstrumentLink instrument

Link to the instrument used for the step.

preset

String preset

The name of the preset configuration used for the step.

step

Link step

Link to the step this details object describes.

uri

URI uri

The URI of this step details resource.

Class com.genologics.ri.step.StepDetailsLink

class StepDetailsLink extends LimsLinkBase<StepDetails> implements Serializable

serialVersionUID:

-3461183102550868643L

Serialized Fields

uri

URI uri

The URI of the step details resource.

Class com.genologics.ri.step.StepSetup

class StepSetup extends Object implements Serializable

serialVersionUID:

1161115098255552451L

Serialized Fields

configuration

StepConfiguration configuration

The configuration of the step.

files

List<SharedResultFile> files

The list of shared result files for the step.

step

Link step

Link to the step this setup is for.

uri

URI uri

The URI of this step setup resource.

Class com.genologics.ri.step.StepSetupLink

class StepSetupLink extends LimsLinkBase<StepSetup> implements Serializable

serialVersionUID:

2029094616401964710L

Serialized Fields

uri

URI uri

The URI of the step setup resource.

Class com.genologics.ri.step.Technician

class Technician extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

-3531986232419228456L

Serialized Fields

firstName

String firstName

The first name of the technician.

lastName

String lastName

The last name of the technician.

uri

URI uri

The URI of the researcher resource representing the technician.

Class com.genologics.ri.step.UserLink

class UserLink extends LimsLinkBase<Researcher> implements Serializable

serialVersionUID:

-682022057659965784L

Serialized Fields

firstName

String firstName

The first name of the user.

lastName

String lastName

The last name of the user.

uri

URI uri

The URI of the researcher resource representing the user.

Package com.genologics.ri.stepconfiguration

Class com.genologics.ri.stepconfiguration.ControlTypeLink

class ControlTypeLink extends LockableSetting implements Serializable

serialVersionUID:

-6200561684960024319L

Serialized Fields

name

String name

The name of the control type.

uri

URI uri

The URI of the control type.

Class com.genologics.ri.stepconfiguration.EppTrigger

class EppTrigger extends LockableSetting implements Serializable

serialVersionUID:

8850458905996420686L

Serialized Fields

name

String name

The name of the EPP trigger.

point

TriggerPoint point

The point when the EPP trigger executes.

status

TriggerStatus status

The status at which the EPP trigger executes.

type

TriggerType type

The type of the EPP trigger.

Class com.genologics.ri.stepconfiguration.Field

class Field extends LockableSetting implements Serializable

serialVersionUID:

2627702301901466857L

Serialized Fields

attachTo

String attachTo

Defines what entity this field is attached to.

name

String name

The name of the field.

style

Style style

The style of the field (user-defined or built-in).

Since:

2.23

Class com.genologics.ri.stepconfiguration.GenericTypeLink

class GenericTypeLink extends Object implements Serializable

serialVersionUID:

-7599295833392440499L

Serialized Fields

locked

Boolean locked

Indicates whether this generic type link is locked.

value

String value

The value of the generic type link.

Class com.genologics.ri.stepconfiguration.IceBucketField

class IceBucketField extends Field implements Serializable

serialVersionUID:

-2716908183459254115L

Serialized Fields

detail

Boolean detail

Indicates whether this ice bucket field should be shown in detail view.

Class com.genologics.ri.stepconfiguration.LockableSetting

class LockableSetting extends Object implements Serializable

serialVersionUID:

1977151383272159438L

Serialized Fields

locked

Boolean locked

Indicates whether this setting is locked by the master step.

Class com.genologics.ri.stepconfiguration.NextStep

class NextStep extends LimsLinkBase<ProtocolStep> implements Serializable

serialVersionUID:

-955680094983735241L

Serialized Fields

name

String name

The name of the next step.

nextStepUri

URI nextStepUri

The URI of the next step.

sequence

Integer sequence

The sequence index of the next step.

Class com.genologics.ri.stepconfiguration.ProcessTypeLink

class ProcessTypeLink extends Object implements Serializable

serialVersionUID:

8671368236853188031L

Serialized Fields

name

String name

The name of the process type.

uri

URI uri

The URI of the process type.

Class com.genologics.ri.stepconfiguration.ProtocolStep

class ProtocolStep extends Object implements Serializable

serialVersionUID:

496185986542798015L

Serialized Fields

defaultGrouping

GenericTypeLink defaultGrouping

Deprecated.

Please use "<milestone>DefaultGrouping" in a StepProperty field instead.

Default field for grouping samples in the queue view.

Since:

2.18

eppTriggers

List<EppTrigger> eppTriggers

List of EPP triggers for this step.

iceBucketFields

List<IceBucketField> iceBucketFields

List of fields to display in the ice bucket view.

Since:

2.25

name

String name

The name of the protocol step.

permittedContainerTypes

List<GenericTypeLink> permittedContainerTypes

List of permitted container types for this step.

permittedControlTypes

List<ControlTypeLink> permittedControlTypes

List of permitted control types for this step.

permittedInstrumentTypes

List<GenericTypeLink> permittedInstrumentTypes

List of permitted instrument types for this step.

Since:

2.25

permittedReagentCategories

List<GenericTypeLink> permittedReagentCategories

List of permitted reagent categories for this step.

processType

ProcessTypeLink processType

The process type associated with this step.

protocolStepIndex

Integer protocolStepIndex

The index of this step within the protocol.

protocolUri

URI protocolUri

The URI of the protocol this step belongs to.

queueFields

List<QueueField> queueFields

List of fields to display in the queue view.

requiredReagentKits

List<ReagentKitLink> requiredReagentKits

List of required reagent kits for this step.

Since:

2.18

sampleFields

List<Field> sampleFields

List of fields to display for samples.

stepFields

List<Field> stepFields

List of fields to display on the step.

stepProperties

List<StepProperty> stepProperties

List of step properties.

stepSetup

StepSetup stepSetup

Configuration for the step setup view.

transitions

List<NextStep> transitions

List of transitions to next steps in the protocol.

uri

URI uri

The URI of the protocol step.

Class com.genologics.ri.stepconfiguration.QueueField

class QueueField extends Field implements Serializable

serialVersionUID:

-3020055581011697956L

Serialized Fields

detail

Boolean detail

Indicates whether this queue field should be shown in detail view.

Class com.genologics.ri.stepconfiguration.ReagentKitLink

class ReagentKitLink extends LockableSetting implements Serializable

serialVersionUID:

-6108166879985602695L

Serialized Fields

name

String name

The name of the reagent kit.

uri

URI uri

The URI of the reagent kit.

Class com.genologics.ri.stepconfiguration.SharedResultFile

class SharedResultFile extends Object implements Serializable

serialVersionUID:

5837529395773779245L

Serialized Fields

message

String message

The message associated with this shared result file.

sharedResultFileIndex

String sharedResultFileIndex

The index of this shared result file.

Class com.genologics.ri.stepconfiguration.StepProperty

class StepProperty extends LockableSetting implements Serializable

serialVersionUID:

-4406681767879834495L

Serialized Fields

name

String name

The name of the step property.

value

String value

The value of the step property.

Class com.genologics.ri.stepconfiguration.StepSetup

class StepSetup extends LockableSetting implements Serializable

serialVersionUID:

3706069288148584102L

Serialized Fields

enabled

boolean enabled

Indicates whether the step setup view is enabled.

files

List<SharedResultFile> files

List of shared result files for the step setup view.

Package com.genologics.ri.userdefined

Exception com.genologics.ri.userdefined.MissingUDFException

class MissingUDFException extends RuntimeException implements Serializable

serialVersionUID:

-4554179841298001722L

Serialized Fields

name

String name

The name of the missing UDF.

Class com.genologics.ri.userdefined.UDF

class UDF extends Object implements Serializable

serialVersionUID:

-3019516615900521203L

Serialized Fields

name

String name

The name of the user-defined field.

type

FieldType type

The data type of the user-defined field.

unit

String unit

The unit of the user-defined field (if applicable).

value

String value

The value of the user-defined field.

Class com.genologics.ri.userdefined.UDT

class UDT extends Object implements Serializable

serialVersionUID:

-6550385282803073762L

Serialized Fields

fields

List<UDF> fields

The list of user-defined fields in this type.

name

String name

The name of the user-defined type.

Package com.genologics.ri.version

Class com.genologics.ri.version.Version

class Version extends Object implements Serializable

serialVersionUID:

-28598435711579586L

Serialized Fields

major

String major

The major version number.

minor

String minor

The minor version number.

uri

URI uri

The URI of the version.

Class com.genologics.ri.version.Versions

class Versions extends Object implements Serializable

serialVersionUID:

-1555363240810423322L

Serialized Fields

versions

List<Version> versions

The list of versions.

Package com.genologics.ri.workflowconfiguration

Class com.genologics.ri.workflowconfiguration.ProtocolLink

class ProtocolLink extends LimsLinkBase<Protocol> implements Serializable

serialVersionUID:

2721431278437928217L

Serialized Fields

name

String name

The name of the protocol.

uri

URI uri

The URI of the protocol.

Class com.genologics.ri.workflowconfiguration.StageLink

class StageLink extends LimsLinkBase<Stage> implements Serializable

serialVersionUID:

-2216914758853864373L

Serialized Fields

name

String name

The name of the stage.

uri

URI uri

The URI of the stage.

Class com.genologics.ri.workflowconfiguration.Workflow

class Workflow extends Object implements Serializable

serialVersionUID:

-8884000036888230246L

Serialized Fields

name

String name

The name of the workflow.

protocols

List<ProtocolLink> protocols

The list of protocols associated with this workflow.

stages

List<StageLink> stages

The list of stages associated with this workflow.

status

Status status

The status of the workflow.

uri

URI uri

The URI of the workflow.

Class com.genologics.ri.workflowconfiguration.WorkflowLink

class WorkflowLink extends LimsLinkBase<Workflow> implements Serializable

serialVersionUID:

1335890809720204629L

Serialized Fields

name

String name

The name of the workflow.

status

Status status

The status of the workflow.

uri

URI uri

The URI of the workflow.

Class com.genologics.ri.workflowconfiguration.Workflows

class Workflows extends Object implements Serializable

serialVersionUID:

-7678105241108473919L

Serialized Fields

workflows

List<WorkflowLink> workflows

The list of workflow links.

Package org.cruk.clarity.api

Exception org.cruk.clarity.api.ClarityException

class ClarityException extends RuntimeException implements Serializable

serialVersionUID:

404952616991787238L

Serialized Fields

category

String category

The category of the error.

code

String code

The error code.

httpStatus

HttpStatusCode httpStatus

The HTTP status code returned from the server.

suggestedActions

String suggestedActions

Suggested actions to rectify the error, provided by the Clarity API.

Exception org.cruk.clarity.api.ClarityUpdateException

class ClarityUpdateException extends RuntimeException implements Serializable

serialVersionUID:

-2679585761524242033L

Exception org.cruk.clarity.api.IllegalSearchTermException

class IllegalSearchTermException extends IllegalArgumentException implements Serializable

serialVersionUID:

-1008444394159250460L

Serialized Fields

searchTerm

String searchTerm

Search term.

Exception org.cruk.clarity.api.InvalidURIException

class InvalidURIException extends IllegalArgumentException implements Serializable

serialVersionUID:

6541624754969322769L

Class org.cruk.clarity.api.SavedQuerySummary

class SavedQuerySummary extends Object implements Serializable

serialVersionUID:

3011564738031403103L

Serialized Fields

length

long length

The length in bytes of the response.

mediaType

MediaType mediaType

The mime type and character set returned from the server.

query

Linkable<SavedQuery> query

The query that was run.

Package org.cruk.clarity.api.automation

Exception org.cruk.clarity.api.automation.ClarityAutomationException

class ClarityAutomationException extends RuntimeException implements Serializable

serialVersionUID:

1609079834226439767L

Package org.cruk.clarity.api.playback

Exception org.cruk.clarity.api.playback.NoRecordingException

class NoRecordingException extends RuntimeException implements Serializable

serialVersionUID:

-8188977522747365074L

Package org.cruk.clarity.api.search

Class org.cruk.clarity.api.search.Search

class Search extends Object implements Serializable

serialVersionUID:

-6611443224550823943L

Serialized Fields

results

List<LimsLink<E extends Locatable>> results

The results of the search.

searchTerms

SearchTerms<E extends Locatable> searchTerms

The search terms used in this search.

Class org.cruk.clarity.api.search.SearchTerm

class SearchTerm extends Object implements Serializable

serialVersionUID:

-8406721186516589781L

Serialized Fields

param

String param

The parameter name.

values

List<String> values

The parameter's values to search for.

Class org.cruk.clarity.api.search.SearchTerms

class SearchTerms extends Object implements Serializable

serialVersionUID:

6086837837496759045L

Serialized Fields

entityClass

Class<E extends Locatable> entityClass

The class of the objects being searched for.

searchTerms

List<SearchTerm> searchTerms

The search terms (parameters) of the search.