Data Model version 2.0.6
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: ImportSample


    This experiment subtype is used for importing samples into the system.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link experimentStore to class ExperimentStore
Main key: serial
Mandatory Attributes: endDate, startDate, experimentType, supplier
Known Subclasses: None
Children:
link outputSamples to class OutputSample
link parameters to class Parameter
link sampleIos to class InputSample
Constructor: newObj = ImportSample( experimentStore,endDate=value, startDate=value, experimentType=value, supplier=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Details field for comments.  
endDate DateTime 1..1 The end date of the experiment step.  
isLocked Boolean 0..1 Is this experiment locked for read-only access after group leader cheked it?  
lastEditedDate DateTime 0..1 Last date experiment was edited.  
name Line 0..1 The name of the Experiment, for display purposes  
serial Int 1..1 Unique identifier.  
startDate DateTime 1..1 The start date of the experiment step (e.g. '2003-12-25', '2003-12-25:09:00').  
status Word 0..1 The status of the experiment. e.g. 'OK', 'Failed', 'In process' or 'To be run'.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
annotations ccp.api.general.Annotation.Annotation 0..* Annotations relevant to Experiment  
blueprintStatuss ccp.api.lims.ExpBlueprint.BlueprintStatus 0..*  
creator ccp.api.general.Affiliation.Person 0..1 The person who is in charge for this experiment or who created this experiment.  
expBlueprint ccp.api.lims.ExpBlueprint.ExpBlueprint 0..1 The trial on which this experiment is done. ExpBlueprint can therefore also be seen as way of logically grouping experiments.  
experimentGroup ExperimentGroup 0..1 The ExperimentGroup is used to associate Experiments of same group type.  
experimentStore ExperimentStore 1..1 (Parent link). parent link  
experimentType ccp.api.lims.Classification.ExperimentType 1..1 The experiment type: e.g. 'Cloning', 'Protein Expression', 'Protein Purification', 'Crystallogenesis', 'NMR', ...  
group ccp.api.general.Affiliation.Group 0..1 Group where experiment was carried out.  
instrument ccp.api.general.Instrument.Instrument 0..1 Instrument (e.g. robot, spectrometer) used for Experiment.  
lastEditor ccp.api.general.Affiliation.Person 0..1 Person who last modified Experiment.  
method ccp.api.general.Method.Method 0..1 Method used for an experiment.  
next Experiment 0..* The next experiments associated to the current on.  
outputSamples OutputSample 0..* (Child link). child link to class OutputSample  
parameters Parameter 0..* (Child link). child link to class Parameter  
parent ExperimentStore 1..1 link to parent object - synonym for experimentStore  
previous Experiment 0..* The previous experiments associated to the current on.  
protocol ccp.api.lims.Protocol.Protocol 0..1 The protocol used by the experiment.  
sampleIos InputSample 0..* (Child link). child link to class InputSample  
supplier ccp.api.general.Affiliation.Organisation 1..1 The supplier of the import sample.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
endDate
getEndDate DateTime -
setEndDate - DateTime
isLocked
getIsLocked Boolean -
setIsLocked - Boolean
lastEditedDate
getLastEditedDate DateTime -
setLastEditedDate - DateTime
name
getName Line -
setName - Line
serial
getSerial Int -
setSerial - Int
startDate
getStartDate DateTime -
setStartDate - DateTime
status
getStatus Word -
setStatus - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
annotations
getAnnotations ccp.api.general.Annotation.Annotation Set -
setAnnotations - ccp.api.general.Annotation.Annotation Set
sortedAnnotations ccp.api.general.Annotation.Annotation List -
addAnnotation - ccp.api.general.Annotation.Annotation
removeAnnotation - ccp.api.general.Annotation.Annotation
findFirstAnnotation ccp.api.general.Annotation.Annotation keyword=value pairs
findAllAnnotations ccp.api.general.Annotation.Annotation Set keyword=value pairs
blueprintStatuss
getBlueprintStatuss ccp.api.lims.ExpBlueprint.BlueprintStatus Set -
setBlueprintStatuss - ccp.api.lims.ExpBlueprint.BlueprintStatus Set
sortedBlueprintStatuss ccp.api.lims.ExpBlueprint.BlueprintStatus List -
addBlueprintStatus - ccp.api.lims.ExpBlueprint.BlueprintStatus
removeBlueprintStatus - ccp.api.lims.ExpBlueprint.BlueprintStatus
findFirstBlueprintStatus ccp.api.lims.ExpBlueprint.BlueprintStatus keyword=value pairs
findAllBlueprintStatuss ccp.api.lims.ExpBlueprint.BlueprintStatus Set keyword=value pairs
creator
getCreator ccp.api.general.Affiliation.Person -
setCreator - ccp.api.general.Affiliation.Person
expBlueprint
getExpBlueprint ccp.api.lims.ExpBlueprint.ExpBlueprint -
setExpBlueprint - ccp.api.lims.ExpBlueprint.ExpBlueprint
experimentGroup
getExperimentGroup ExperimentGroup -
setExperimentGroup - ExperimentGroup
experimentStore
getExperimentStore ExperimentStore -
experimentType
getExperimentType ccp.api.lims.Classification.ExperimentType -
setExperimentType - ccp.api.lims.Classification.ExperimentType
group
getGroup ccp.api.general.Affiliation.Group -
setGroup - ccp.api.general.Affiliation.Group
instrument
getInstrument ccp.api.general.Instrument.Instrument -
setInstrument - ccp.api.general.Instrument.Instrument
lastEditor
getLastEditor ccp.api.general.Affiliation.Person -
setLastEditor - ccp.api.general.Affiliation.Person
method
getMethod ccp.api.general.Method.Method -
setMethod - ccp.api.general.Method.Method
next
getNext Experiment Set -
setNext - Experiment Set
sortedNext Experiment List -
addNext - Experiment
removeNext - Experiment
findFirstNext Experiment keyword=value pairs
findAllNext Experiment Set keyword=value pairs
outputSamples
getOutputSamples OutputSample Set -
sortedOutputSamples OutputSample List -
findFirstOutputSample OutputSample keyword=value pairs
findAllOutputSamples OutputSample Set keyword=value pairs
parameters
getParameters Parameter Set -
sortedParameters Parameter List -
findFirstParameter Parameter keyword=value pairs
findAllParameters Parameter Set keyword=value pairs
parent
getParent ExperimentStore -
previous
getPrevious Experiment Set -
setPrevious - Experiment Set
sortedPrevious Experiment List -
addPrevious - Experiment
removePrevious - Experiment
findFirstPrevious Experiment keyword=value pairs
findAllPrevious Experiment Set keyword=value pairs
protocol
getProtocol ccp.api.lims.Protocol.Protocol -
setProtocol - ccp.api.lims.Protocol.Protocol
sampleIos
getSampleIos InputSample Set -
sortedSampleIos InputSample List -
findFirstSampleIo InputSample keyword=value pairs
findAllSampleIos InputSample Set keyword=value pairs
supplier
getSupplier ccp.api.general.Affiliation.Organisation -
setSupplier - ccp.api.general.Affiliation.Organisation

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey ImportSample memops.api.Implementation.MemopsObject, Any List static
getFullKey Any List Boolean
getLocalKey Any -
get Any String
set - String, Any

Factory Methods (in package)

Go to Top
Method Return Parameters
newInputSample InputSample ...
newOutputSample OutputSample ...
newParameter Parameter ...

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:44_00014

isImplicit:

False

Tag

Value
repositoryId $Id: ImportSample.xml,v 1.47 2011-01-13 14:40:33 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:50 2013    from data model package  ccp.api.lims.Experiment.ImportSample   revision 1.47  
  Work done by the CCPN team.
www.ccpn.ac.uk