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

Class: KeywordDefinition

Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: link keywordDefinitionStore to class KeywordDefinitionStore
Main key: keyword
Mandatory Attributes: keyword
Known Subclasses: None
Children: None
Constructor: newObj = KeywordDefinition( keywordDefinitionStore,keyword=value, ... )

Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
explanation String 0..1 Definition, examples, etc. to explain the parameter defined by the keyword.  
keyword Word 1..1  
name Line 0..1 A user-friendly synonym for the keyword  
targetNames Word 0..* qualified names for the CCPN classes that the keyword may be used to describe. If empty there are no limitations. Typically keywords are used as part of a keyword-value-object combination. targetNames refer to the allowed type for the object being described (*not* the object that contains the desctription)  

Inherited Attributes (not in package): applicationDataclassNamefieldNamesinConstructorisDeletedmetaclasspackageNamepackageShortNamequalifiedName

Link Attributes (in package)

Go to Top
Attribute Type Multiplicity Description
keywordDefinitionStore KeywordDefinitionStore 1..1 (Parent link). parent link  
parent KeywordDefinitionStore 1..1 link to parent object - synonym for keywordDefinitionStore  

Inherited Attributes (not in package): accessactiveAccessroottopObject

Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
explanation
getExplanation String -
setExplanation - String
keyword
getKeyword Word -
setKeyword - Word
name
getName Line -
setName - Line
targetNames
getTargetNames Word Set -
setTargetNames - Word Set
addTargetName - Word
removeTargetName - Word

Link Attribute Methods (in package)

Go to Top
Attribute Method Return Parameters Comment
keywordDefinitionStore
getKeywordDefinitionStore KeywordDefinitionStore -
parent
getParent KeywordDefinitionStore -

Class Methods (in package)

Go to Top
Method Return Parameters Comment
checkValid - Boolean
checkAllValid - Boolean
getByKey KeywordDefinition 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_2007-11-14-17:02:54_00002

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.molecule.Validation.ValidationResult.keywordDefinition
  Data Model Version 2.1.2
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Mon Mar 2 17:24:25 2015    from data model package  ccp.api.general.KeywordDefinition.KeywordDefinition   revision ?  
  Work done by the CCPN team.
www.ccpn.ac.uk