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

Class: Task


    Abstract task - describing the kind of operation that can be done on data.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link wmsSegment to class WmsSegment
Main key: serial
Mandatory Attributes: None
Known Subclasses: None
Children: None
Constructor: newObj = Task( wmsSegment, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
dateCompleted DateTime 0..1  
dateStarted DateTime 0..1  
nmrCalcRunSerial PositiveInt 0..1 Serial for NmrCalc.Run where Task run information is stored  
nmrCalcStoreName Line 0..1 Name of NmrCalcStore where Task run information is stored  
operatorId Word 0..1 User Id for operator running the task.  
protocolName Word 0..1 Name of Wms protocol used for task. Key for derived link to Protocol  
serial Int 1..1 Serial number of object. Serves as object main key. Serial numbers of deleted objects are not re-used. Serial numbers can only be set by the implementation. Values are in practice always positive, since negative values are interpreted as a signal to set the next free serial  
status Line 0..1 Task status - to be turned into enumeration  
summary Line 0..1 One-line description of task  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
generatedVersion ProjectVersion 0..1  
inputVersion ProjectVersion 0..1  
nmrCalcRun ccp.api.nmr.NmrCalc.Run 0..1 Derived. NmrCalc Run object that describes task.  
operator memops.api.AccessControl.User 0..1 Derived. Operator carrying out task.  
parent WmsSegment 1..1 link to parent object - synonym for wmsSegment  
wmsProtocol cambridge.api.WmsProtocol.WmsProtocol 0..1 Derived. protocol used to perform task  
wmsSegment WmsSegment 1..1 (Parent link). parent link  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
dateCompleted
getDateCompleted DateTime -
setDateCompleted - DateTime
dateStarted
getDateStarted DateTime -
setDateStarted - DateTime
nmrCalcRunSerial
getNmrCalcRunSerial PositiveInt -
setNmrCalcRunSerial - PositiveInt
nmrCalcStoreName
getNmrCalcStoreName Line -
setNmrCalcStoreName - Line
operatorId
getOperatorId Word -
setOperatorId - Word
protocolName
getProtocolName Word -
setProtocolName - Word
serial
getSerial Int -
setSerial - Int
status
getStatus Line -
setStatus - Line
summary
getSummary Line -
setSummary - Line

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
generatedVersion
getGeneratedVersion ProjectVersion -
setGeneratedVersion - ProjectVersion
inputVersion
getInputVersion ProjectVersion -
setInputVersion - ProjectVersion
nmrCalcRun
getNmrCalcRun ccp.api.nmr.NmrCalc.Run - non-std.
setNmrCalcRun - ccp.api.nmr.NmrCalc.Run non-std.
operator
getOperator memops.api.AccessControl.User - non-std.
parent
getParent WmsSegment -
wmsProtocol
getWmsProtocol cambridge.api.WmsProtocol.WmsProtocol - non-std.
wmsSegment
getWmsSegment WmsSegment -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Task 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
None

Other Methods (in package)

Go to Top
Method Return Parameters Comment
None

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2009-01-29-15:16:52_00007

isImplicit:

False

Tag

Value
repositoryId $Id: $

Tag

Value
repositoryTag $Name: $

Special constructor code:

None

Special destructor code:

None

Special postDestructor code:

None

Constraints:

None
Known inward one-way links: cambridge.api.WmsQuery.TaskResult.task
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Thu Oct 2 16:09:59 2014    from data model package  cambridge.api.Wms.Task   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk