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

Class: HolderType

The HolderType destructor includes non-standard actions.
    The information to describe a type of holder. A tube uses maxVolume, plate with one sample/well uses HolderTypePosition with no position set rather than A1.
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 holderTypePositions to class HolderTypePosition
Constructor: newObj = HolderType( holderStore,name=value, holderCategories=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
details String 0..1 Detail field for comments.  
holdHolderFlag Boolean 0..1 Is this holder can hold another holder?  
maxColumn Int 0..1 The maximum number of columns.  
maxRow Int 0..1 The maximum number of rows.  
maxSubPosition Int 0..1 The maximum number of sub-positions.  
maxVolume Float 0..1 The maximum volume.  
maxVolumeDisplayUnit Word 0..1 The display unit of the max volume.  
name Word 1..1 The reference holder name. e.g. '96 Deepweel plate', 'Plate', 'Screen', 'Gel', ...  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
holderCategories ccp.api.lims.Classification.HolderCategory 1..*  
holderStore HolderStore 1..1 (Parent link). parent link  
holderTypePositions HolderTypePosition 0..* (Child link). child link to class HolderTypePosition  
parent HolderStore 1..1 link to parent object - synonym for holderStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
details
getDetails String -
setDetails - String
holdHolderFlag
getHoldHolderFlag Boolean -
setHoldHolderFlag - Boolean
maxColumn
getMaxColumn Int -
setMaxColumn - Int
maxRow
getMaxRow Int -
setMaxRow - Int
maxSubPosition
getMaxSubPosition Int -
setMaxSubPosition - Int
maxVolume
getMaxVolume Float -
setMaxVolume - Float
maxVolumeDisplayUnit
getMaxVolumeDisplayUnit Word -
setMaxVolumeDisplayUnit - Word
name
getName Word -
setName - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
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
holderStore
getHolderStore HolderStore -
holderTypePositions
getHolderTypePositions HolderTypePosition Set -
sortedHolderTypePositions HolderTypePosition List -
findFirstHolderTypePosition HolderTypePosition keyword=value pairs
findAllHolderTypePositions HolderTypePosition Set keyword=value pairs
parent
getParent HolderStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey HolderType 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
newHolderTypePosition HolderTypePosition ...

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_00044

isImplicit:

False

Tag

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

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

for holder in self.holderStore.findAllHolders(holderType=self):
  holder.holderType = 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.HolderType   revision 1.48  
  Work done by the CCPN team.
www.ccpn.ac.uk