ClinicalCaseRegistries::Classes
Class API

Sub-File of ROR METADATA file 799.2.

Attributes
Integer apiCode apiCode

This field stores the code of the API. These codes are used by the corresponding routines of the search engine to distinguish between the APIs. Codes of the APIs are unique only in the file context. For example, the definition of any file can have a descriptor of the API #2.

Integer iaNumber iaNumber

The IA# field stores a reference number of the integration agreement that describes this API.

String routine routine

This field stores the name of the routine implementing the API.

String tag tag

This field contains a tag name inside the API routine. If the routine should be executed from the beginning, leave this field empty.


Properties:

Alias
businessRule[]
Classifier Behavior
dateAdded5/23/13
dateModified
fileNameAPI
fileNumber799.23
highLevelConcept
informationDomain
Is Abstractfalse
Is Activefalse
Is Leaffalse
KeywordsFile 799.23
modReason
NameAPI
Name Expression
NamespaceClasses
note
originalName
Owned Template Signature
OwnerClasses
Owning Template Parameter
PackageClasses
packageNameCLINICAL CASE REGISTRIES
projectID
Qualified NameHybrid::ClinicalCaseRegistries::Classes::API
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
Representation
requestedBy
rootClass
StereotypeClassDictionary, VistaClassDictionary
synonym
Template Parameter
VisibilityPublic

Attribute Details

 apiCode
Public Integer apiCode

This field stores the code of the API. These codes are used by the corresponding routines of the search engine to distinguish between the APIs. Codes of the APIs are unique only in the file context. For example, the definition of any file can have a descriptor of the API #2.

Constraints:
Properties:

absMaxLength2
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.23» API
dataTypeNUMERIC
Datatype
dateAdded05/23/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameAPI CODE
fieldNumber.01
fileNumber799.23
formatRule
formatString
generalDescriptionThis field stores the code of the API. These codes are used by the corresponding routines of the search engine to distinguish between the APIs. Codes of the APIs are unique only in the file context. For example, the definition of any file can have a descriptor of the API #2.
helpTextType a Number between 2 and 99, 0 Decimal Digits.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameapiCode
Name Expression
Namespace«File 799.23» API
note
Opposite
originalClass
originalName
Owner«File 799.23» API
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::API::apiCode
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescriptionInternal value of this field is used as the internal entry number of the record ('DINUM' feature).
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 iaNumber
Public Integer iaNumber

The IA# field stores a reference number of the integration agreement that describes this API.

Constraints:
Properties:

absMaxLength9
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.23» API
dataTypeNUMERIC
Datatype
dateAdded05/23/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameIA#
fieldNumber2
fileNumber799.23
formatRule
formatString
generalDescriptionThe IA# field stores a reference number of the integration agreement that describes this API.
helpTextType a Number between 1 and 999999999, 0 Decimal Digits.
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
NameiaNumber
Name Expression
Namespace«File 799.23» API
note
Opposite
originalClass
originalName
Owner«File 799.23» API
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::API::iaNumber
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeInteger
Upper1
Upper Value(1)
VisibilityPublic


 routine
Public String routine

This field stores the name of the routine implementing the API.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.23» API
dataTypeFREE TEXT
Datatype
dateAdded05/23/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameROUTINE
fieldNumber1.1
fileNumber799.23
formatRule
formatString
generalDescriptionThis field stores the name of the routine implementing the API.
helpTextAnswer must be a valid routine name (1-8 characters in length).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredTrue
Keywords
Lower1
Lower Value(1)
maxLength-
minLength-
modReason
Multiplicity1
Nameroutine
Name Expression
Namespace«File 799.23» API
note
Opposite
originalClass
originalName
Owner«File 799.23» API
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::API::routine
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic


 tag
Public String tag

This field contains a tag name inside the API routine. If the routine should be executed from the beginning, leave this field empty.

Constraints:
Properties:

absMaxLength30
AggregationNone
Alias
Association
Association End
businessRule[]
Class«File 799.23» API
dataTypeFREE TEXT
Datatype
dateAdded05/23/13
dateModified
Default
Default Value
enumeratedBaseDomain
externalMapLocation
externalMapType
fieldNameTAG
fieldNumber1.2
fileNumber799.23
formatRule
formatString
generalDescriptionThis field contains a tag name inside the API routine. If the routine should be executed from the beginning, leave this field empty.
helpTextAnswer must be a valid tag name (1-8 characters in length).
Is Compositefalse
Is Derivedfalse
Is Derived Unionfalse
Is Leaffalse
Is Orderedfalse
Is Read Onlyfalse
Is Staticfalse
Is Uniquetrue
isMultipleFalse
isNullableFalse
isRequiredFalse
Keywords
Lower0
Lower Value(0)
maxLength-
minLength-
modReason
Multiplicity0..1
Nametag
Name Expression
Namespace«File 799.23» API
note
Opposite
originalClass
originalName
Owner«File 799.23» API
Owning Association
Owning Template Parameter
permissableValueMeanings-
permissableValues-
pointerFileName-
pointerFileNumber-
Qualified NameHybrid::ClinicalCaseRegistries::Classes::API::tag
referenceDocumentHyperlink[]
referenceDocumentPage[]
referenceDocumentTitle[]
referenceInfo
requestedBy
StereotypeAttributeDictionary, VistaAttributeDictionary
subFileNumber-
synonym
technicalDescription-
Template Parameter
TypeString
Upper1
Upper Value(1)
VisibilityPublic