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

Class: Person


    An individual person.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link affiliationStore to class AffiliationStore
Main key: serial
Mandatory Attributes: familyName
Known Subclasses: None
Children:
link personInGroups to class PersonInGroup
Constructor: newObj = Person( affiliationStore,familyName=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
familyName Line 1..1 Family name ('last name' for western names).  
familyTitle FamilyTitle 0..1 Family title (e.g. Jr.)  
firstInitial Word 0..1 Derived. First initial.  
givenName Line 0..1 Given name ('first name' for western names).  
middleInitials Word 0..* Middle initials (including first one).  
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  
title PersonTitle 0..1 Title, 'Mr.', 'Mrs.', 'Ms.', 'Dr.', 'Professor',...  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
affiliationStore AffiliationStore 1..1 (Parent link). parent link  
authorCitations ccp.api.general.Citation.Citation 0..* Citations where Person is author  
authoredEntries ccp.api.nmr.NmrEntry.Entry 0..* BMRBentries authored by person.  
contactEntries ccp.api.nmr.NmrEntry.Entry 0..* BMRBentries where person is contact person  
createdExps ccp.api.lims.Experiment.Experiment 0..* Experiments created by Person  
createdProtocols ccp.api.lims.Protocol.Protocol 0..* Protocols created by Person.  
currentPersonInGroup PersonInGroup 0..1 PersonInGroup record describing where the person is currently located. To get the current group, do self.currentPersonInGroup.group  
dropAnnotations ccp.api.lims.Crystallization.DropAnnotation 0..*  
editedExps ccp.api.lims.Experiment.Experiment 0..* Experiments last modified by Person  
editedProtocols ccp.api.lims.Protocol.Protocol 0..* Protocols last modified by Person.  
editorCitations ccp.api.general.Citation.Citation 0..* Citations wher Person is editor  
expBlueprints ccp.api.lims.ExpBlueprint.ExpBlueprint 0..* ExpBlueprints owned by a Person.  
parent AffiliationStore 1..1 link to parent object - synonym for affiliationStore  
personInGroups PersonInGroup 0..* (Child link). child link to class PersonInGroup  
targets ccp.api.lims.Target.Target 0..* Targets created by Person.  
users memops.api.AccessControl.User 0..* AcessControl.Users correponding to Person  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
familyName
getFamilyName Line -
setFamilyName - Line
familyTitle
getFamilyTitle FamilyTitle -
setFamilyTitle - FamilyTitle
firstInitial
getFirstInitial Word - non-std.
givenName
getGivenName Line -
setGivenName - Line
middleInitials
getMiddleInitials Word Tuple -
setMiddleInitials - Word List
addMiddleInitial - Word
removeMiddleInitial - Word
serial
getSerial Int -
setSerial - Int
title
getTitle PersonTitle -
setTitle - PersonTitle

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
affiliationStore
getAffiliationStore AffiliationStore -
authorCitations
getAuthorCitations ccp.api.general.Citation.Citation Set -
setAuthorCitations - ccp.api.general.Citation.Citation Set
sortedAuthorCitations ccp.api.general.Citation.Citation List -
addAuthorCitation - ccp.api.general.Citation.Citation
removeAuthorCitation - ccp.api.general.Citation.Citation
findFirstAuthorCitation ccp.api.general.Citation.Citation keyword=value pairs
findAllAuthorCitations ccp.api.general.Citation.Citation Set keyword=value pairs
authoredEntries
getAuthoredEntries ccp.api.nmr.NmrEntry.Entry Set -
setAuthoredEntries - ccp.api.nmr.NmrEntry.Entry Set
sortedAuthoredEntries ccp.api.nmr.NmrEntry.Entry List -
addAuthoredEntry - ccp.api.nmr.NmrEntry.Entry
removeAuthoredEntry - ccp.api.nmr.NmrEntry.Entry
findFirstAuthoredEntry ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllAuthoredEntries ccp.api.nmr.NmrEntry.Entry Set keyword=value pairs
contactEntries
getContactEntries ccp.api.nmr.NmrEntry.Entry Set -
setContactEntries - ccp.api.nmr.NmrEntry.Entry Set
sortedContactEntries ccp.api.nmr.NmrEntry.Entry List -
addContactEntry - ccp.api.nmr.NmrEntry.Entry
removeContactEntry - ccp.api.nmr.NmrEntry.Entry
findFirstContactEntry ccp.api.nmr.NmrEntry.Entry keyword=value pairs
findAllContactEntries ccp.api.nmr.NmrEntry.Entry Set keyword=value pairs
createdExps
getCreatedExps ccp.api.lims.Experiment.Experiment Set -
setCreatedExps - ccp.api.lims.Experiment.Experiment Set
sortedCreatedExps ccp.api.lims.Experiment.Experiment List -
addCreatedExp - ccp.api.lims.Experiment.Experiment
removeCreatedExp - ccp.api.lims.Experiment.Experiment
findFirstCreatedExp ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllCreatedExps ccp.api.lims.Experiment.Experiment Set keyword=value pairs
createdProtocols
getCreatedProtocols ccp.api.lims.Protocol.Protocol Set -
setCreatedProtocols - ccp.api.lims.Protocol.Protocol Set
sortedCreatedProtocols ccp.api.lims.Protocol.Protocol List -
addCreatedProtocol - ccp.api.lims.Protocol.Protocol
removeCreatedProtocol - ccp.api.lims.Protocol.Protocol
findFirstCreatedProtocol ccp.api.lims.Protocol.Protocol keyword=value pairs
findAllCreatedProtocols ccp.api.lims.Protocol.Protocol Set keyword=value pairs
currentPersonInGroup
getCurrentPersonInGroup PersonInGroup -
setCurrentPersonInGroup - PersonInGroup
dropAnnotations
getDropAnnotations ccp.api.lims.Crystallization.DropAnnotation Set -
setDropAnnotations - ccp.api.lims.Crystallization.DropAnnotation Set
sortedDropAnnotations ccp.api.lims.Crystallization.DropAnnotation List -
findFirstDropAnnotation ccp.api.lims.Crystallization.DropAnnotation keyword=value pairs
findAllDropAnnotations ccp.api.lims.Crystallization.DropAnnotation Set keyword=value pairs
editedExps
getEditedExps ccp.api.lims.Experiment.Experiment Set -
setEditedExps - ccp.api.lims.Experiment.Experiment Set
sortedEditedExps ccp.api.lims.Experiment.Experiment List -
addEditedExp - ccp.api.lims.Experiment.Experiment
removeEditedExp - ccp.api.lims.Experiment.Experiment
findFirstEditedExp ccp.api.lims.Experiment.Experiment keyword=value pairs
findAllEditedExps ccp.api.lims.Experiment.Experiment Set keyword=value pairs
editedProtocols
getEditedProtocols ccp.api.lims.Protocol.Protocol Set -
setEditedProtocols - ccp.api.lims.Protocol.Protocol Set
sortedEditedProtocols ccp.api.lims.Protocol.Protocol List -
addEditedProtocol - ccp.api.lims.Protocol.Protocol
removeEditedProtocol - ccp.api.lims.Protocol.Protocol
findFirstEditedProtocol ccp.api.lims.Protocol.Protocol keyword=value pairs
findAllEditedProtocols ccp.api.lims.Protocol.Protocol Set keyword=value pairs
editorCitations
getEditorCitations ccp.api.general.Citation.Citation Set -
setEditorCitations - ccp.api.general.Citation.Citation Set
sortedEditorCitations ccp.api.general.Citation.Citation List -
addEditorCitation - ccp.api.general.Citation.Citation
removeEditorCitation - ccp.api.general.Citation.Citation
findFirstEditorCitation ccp.api.general.Citation.Citation keyword=value pairs
findAllEditorCitations ccp.api.general.Citation.Citation Set keyword=value pairs
expBlueprints
getExpBlueprints ccp.api.lims.ExpBlueprint.ExpBlueprint Set -
setExpBlueprints - ccp.api.lims.ExpBlueprint.ExpBlueprint Set
sortedExpBlueprints ccp.api.lims.ExpBlueprint.ExpBlueprint List -
addExpBlueprint - ccp.api.lims.ExpBlueprint.ExpBlueprint
removeExpBlueprint - ccp.api.lims.ExpBlueprint.ExpBlueprint
findFirstExpBlueprint ccp.api.lims.ExpBlueprint.ExpBlueprint keyword=value pairs
findAllExpBlueprints ccp.api.lims.ExpBlueprint.ExpBlueprint Set keyword=value pairs
parent
getParent AffiliationStore -
personInGroups
getPersonInGroups PersonInGroup Set -
sortedPersonInGroups PersonInGroup List -
findFirstPersonInGroup PersonInGroup keyword=value pairs
findAllPersonInGroups PersonInGroup Set keyword=value pairs
targets
getTargets ccp.api.lims.Target.Target Set -
setTargets - ccp.api.lims.Target.Target Set
sortedTargets ccp.api.lims.Target.Target List -
addTarget - ccp.api.lims.Target.Target
removeTarget - ccp.api.lims.Target.Target
findFirstTarget ccp.api.lims.Target.Target keyword=value pairs
findAllTargets ccp.api.lims.Target.Target Set keyword=value pairs
users
getUsers memops.api.AccessControl.User Set -
setUsers - memops.api.AccessControl.User Set
sortedUsers memops.api.AccessControl.User List -
addUser - memops.api.AccessControl.User
removeUser - memops.api.AccessControl.User
findFirstUser memops.api.AccessControl.User keyword=value pairs
findAllUsers memops.api.AccessControl.User Set keyword=value pairs

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey Person 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
newPersonInGroup PersonInGroup group, ...

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:53_00018

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: ccp.api.general.Annotation.Annotation.authorccp.api.general.Instrument.AbstractInstrument.contactPersonccp.api.nmr.NmrCalc.Run.operator
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:28 2015    from data model package  ccp.api.general.Affiliation.Person   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk