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

Class: Holder


    The information on the holder. It is a plastic labware that cannot be separated like plates, tubes,... that contain one or many sample(s) and that holds the bar code information for example. It can be also used to group holder together.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link holderStore to class HolderStore
Main key: name
Mandatory Attributes: name, holderCategories
Known Subclasses: None
Children:
link holderLocations to class HolderLocation
link refSamplePositions to class RefSamplePosition
Constructor: newObj = Holder( holderStore,name=value, holderCategories=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
colPosition Int 0..1 The column position of the current holder in the parent holder.  
details String 0..1 Detail field for comments.  
endDate DateTime 0..1  
name Line 1..1 The name of the holder or the code to identify it. It is the unique identifier.  
rowPosition Int 0..1 The row position of the current holder in the parent holder.  
startDate DateTime 0..1  
subPosition Int 0..1 The sub-position of the current holder in the parent holder.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
contents Holder 0..* List of sub holder contained in an holder. This is the contents of an holder.  
holder Holder 0..1 The holder to which the sub holders belong.  
holderCategories ccp.api.lims.Classification.HolderCategory 1..*  
holderLocations HolderLocation 0..* (Child link). child link to class HolderLocation  
holderStore HolderStore 1..1 (Parent link). parent link  
holderType AbstractHolderType 0..1 The type of holder associated to a holder.  
parent HolderStore 1..1 link to parent object - synonym for holderStore  
refSamplePositions RefSamplePosition 0..* (Child link). child link to class RefSamplePosition  
samples ccp.api.lims.Sample.Sample 0..* List of sample contained in an holder.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
colPosition
getColPosition Int -
setColPosition - Int
details
getDetails String -
setDetails - String
endDate
getEndDate DateTime -
setEndDate - DateTime
name
getName Line -
setName - Line
rowPosition
getRowPosition Int -
setRowPosition - Int
startDate
getStartDate DateTime -
setStartDate - DateTime
subPosition
getSubPosition Int -
setSubPosition - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
contents
getContents Holder Set -
setContents - Holder Set
sortedContents Holder List -
addContent - Holder
removeContent - Holder
findFirstContent Holder keyword=value pairs
findAllContents Holder Set keyword=value pairs
holder
getHolder Holder -
setHolder - Holder
holderCategories
getHolderCategories ccp.api.lims.Classification.HolderCategory Set -
setHolderCategories - ccp.api.lims.Classification.HolderCategory Set
sortedHolderCategories ccp.api.lims.Classification.HolderCategory List -
addHolderCategory - ccp.api.lims.Classification.HolderCategory
removeHolderCategory - ccp.api.lims.Classification.HolderCategory
findFirstHolderCategory ccp.api.lims.Classification.HolderCategory keyword=value pairs
findAllHolderCategories ccp.api.lims.Classification.HolderCategory Set keyword=value pairs
holderLocations
getHolderLocations HolderLocation Set -
sortedHolderLocations HolderLocation List -
findFirstHolderLocation HolderLocation keyword=value pairs
findAllHolderLocations HolderLocation Set keyword=value pairs
holderStore
getHolderStore HolderStore -
holderType
getHolderType AbstractHolderType -
setHolderType - AbstractHolderType
parent
getParent HolderStore -
refSamplePositions
getRefSamplePositions RefSamplePosition Set -
sortedRefSamplePositions RefSamplePosition List -
findFirstRefSamplePosition RefSamplePosition keyword=value pairs
findAllRefSamplePositions RefSamplePosition Set keyword=value pairs
samples
getSamples ccp.api.lims.Sample.Sample Set -
setSamples - ccp.api.lims.Sample.Sample Set
sortedSamples ccp.api.lims.Sample.Sample List -
addSample - ccp.api.lims.Sample.Sample
removeSample - ccp.api.lims.Sample.Sample
findFirstSample ccp.api.lims.Sample.Sample keyword=value pairs
findAllSamples ccp.api.lims.Sample.Sample Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Holder 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
newHolderLocation HolderLocation startDate, location, ...
newRefSamplePosition RefSamplePosition ...

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:52_00046

isImplicit:

False

Tag

Value
repositoryId $Id: Holder.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.5
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 26 16:58:14 2012    from data model package  ccp.api.lims.Holder.Holder   revision 1.47  
  Work done by the CCPN team.
www.ccpn.ac.uk