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

Class: Protocol


    The information on the protocol. A protocol is a series of procedures that contain steps.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link protocolStore to class ProtocolStore
Main key: serial
Mandatory Attributes: name, experimentType
Known Subclasses: None
Children:
link parameterDefinitions to class ParameterDefinition
link procedures to class Procedure
link refInputSamples to class RefInputSample
link refOutputSamples to class RefOutputSample
Constructor: newObj = Protocol( protocolStore,name=value, experimentType=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
creationDate DateTime 0..1 The creation date of the protocol.  
details String 0..1 Details field for comments.  
lastEditedDate DateTime 0..1 Last date protocol was edited.  
name Line 1..1 The name of the protocol.  
objective Text 0..1 The objective of the protocol.  
remarks String 0..* Some remarks on the reason why the protocol has been updated.  
serial Int 1..1 Unique identifier.  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
creator ccp.api.general.Affiliation.Person 0..1 The person who is in charge for this protocol or who created this protocol.  
experimentType ccp.api.lims.Classification.ExperimentType 1..1 The experiment type associated to a protocol.  
experiments ccp.api.lims.Experiment.Experiment 0..* The list of experiments associated to a given protocol.  
lastEditor ccp.api.general.Affiliation.Person 0..1 Person who last modified Protocol.  
parameterDefinitions ParameterDefinition 0..* (Child link). child link to class ParameterDefinition  
parent ProtocolStore 1..1 link to parent object - synonym for protocolStore  
procedures Procedure 0..* (Child link). child link to class Procedure  
protocolStore ProtocolStore 1..1 (Parent link). parent link  
refInputSamples RefInputSample 0..* (Child link). child link to class RefInputSample  
refOutputSamples RefOutputSample 0..* (Child link). child link to class RefOutputSample  
references ccp.api.general.Citation.Citation 0..* Reference where Protocol is citated.  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
creationDate
getCreationDate DateTime -
setCreationDate - DateTime
details
getDetails String -
setDetails - String
lastEditedDate
getLastEditedDate DateTime -
setLastEditedDate - DateTime
name
getName Line -
setName - Line
objective
getObjective Text -
setObjective - Text
remarks
getRemarks String Tuple -
setRemarks - String List
addRemark - String
removeRemark - String
serial
getSerial Int -
setSerial - Int

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
creator
getCreator ccp.api.general.Affiliation.Person -
setCreator - ccp.api.general.Affiliation.Person
experimentType
getExperimentType ccp.api.lims.Classification.ExperimentType -
setExperimentType - ccp.api.lims.Classification.ExperimentType
experiments
getExperiments ccp.api.lims.Experiment.Experiment Set -
setExperiments - ccp.api.lims.Experiment.Experiment Set
sortedExperiments ccp.api.lims.Experiment.Experiment List -
addExperiment - ccp.api.lims.Experiment.Experiment
removeExperiment - ccp.api.lims.Experiment.Experiment
findFirstExperiment ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllExperiments ccp.api.lims.Experiment.Experiment Set keyword=value pairs
lastEditor
getLastEditor ccp.api.general.Affiliation.Person -
setLastEditor - ccp.api.general.Affiliation.Person
parameterDefinitions
getParameterDefinitions ParameterDefinition Set -
sortedParameterDefinitions ParameterDefinition List -
findFirstParameterDefinition ParameterDefinition keyword=value pairs
findAllParameterDefinitions ParameterDefinition Set keyword=value pairs
parent
getParent ProtocolStore -
procedures
getProcedures Procedure Set -
sortedProcedures Procedure List -
findFirstProcedure Procedure keyword=value pairs
findAllProcedures Procedure Set keyword=value pairs
protocolStore
getProtocolStore ProtocolStore -
refInputSamples
getRefInputSamples RefInputSample Set -
sortedRefInputSamples RefInputSample List -
findFirstRefInputSample RefInputSample keyword=value pairs
findAllRefInputSamples RefInputSample Set keyword=value pairs
refOutputSamples
getRefOutputSamples RefOutputSample Set -
sortedRefOutputSamples RefOutputSample List -
findFirstRefOutputSample RefOutputSample keyword=value pairs
findAllRefOutputSamples RefOutputSample Set keyword=value pairs
references
getReferences ccp.api.general.Citation.Citation Set -
setReferences - ccp.api.general.Citation.Citation Set
sortedReferences ccp.api.general.Citation.Citation List -
addReference - ccp.api.general.Citation.Citation
removeReference - ccp.api.general.Citation.Citation
findFirstReference ccp.api.general.Citation.Citation keyword=value pairs
findAllReferences ccp.api.general.Citation.Citation Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Protocol 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
newParameterDefinition ParameterDefinition ...
newProcedure Procedure procNumber, ...
newRefInputSample RefInputSample ...
newRefOutputSample RefOutputSample ...

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_00018

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraint name:

procNumber_is_secondary_key_for_Procedure
Constraint code: ll = self.procedures
aSet = frozenset(x.procNumber for x in ll)
isValid = (len(aSet) == len(ll))
Known inward one-way links: None
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Fri Mar 28 11:18:22 2014    from data model package  ccp.api.lims.Protocol.Protocol   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk