Home > Class Reference > HSLIB namespace > HS.Registry.Document.RegistryPackage

HS.Registry.Document.RegistryPackage

persistent class HS.Registry.Document.RegistryPackage extends %Library.Persistent, %XML.Adaptor

SQL Table Name: HS_Registry_Document.RegistryPackage

Property Inventory

Method Inventory

Parameters

parameter XMLIGNOREINVALIDTAG = 1;
Inherited description: The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected elements in the XML input. The XMLIGNOREINVALIDTAG parameter will only take affect if XMLSEQUENCE = 0 (the default). By default (XMLIGNOREINVALIDTAG = 0), will treat an unexpected element as an error. If XMLIGNOREINVALIDTAG is set = 1 and XMLSEQUENCE = 0, then unexpected elements will be ignored.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.

Properties

property Attributes as array of %String (MAXLEN = 32000, STORAGEDEFAULT = "array", XMLNAME = "Attributes", XMLPROJECTION = "ELEMENT");
Property methods: AttributesBuildValueArray(), AttributesCollectionToDisplay(), AttributesCollectionToOdbc(), AttributesDisplayToCollection(), AttributesDisplayToLogical(), AttributesGet(), AttributesGetObject(), AttributesGetObjectId(), AttributesGetStored(), AttributesGetSwizzled(), AttributesIsValid(), AttributesLogicalToDisplay(), AttributesLogicalToOdbc(), AttributesNormalize(), AttributesOdbcToCollection(), AttributesSet(), AttributesSetObject(), AttributesSetObjectId()
relationship Classifications as array of HS.Registry.Document.Classification (SELECTIVITY = ".00067%", XMLNAME = "Classification", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("HS.Registry.Document.Classification","RegistryPackage",+$this,"many",1,1) , Transient , Inverse = RegistryPackage , Cardinality = many ];
Property methods: ClassificationsGet(), ClassificationsGetObject(), ClassificationsGetObjectId(), ClassificationsGetSwizzled(), ClassificationsIsEmpty(), ClassificationsIsValid(), ClassificationsNewObject(), ClassificationsRClose(), ClassificationsRExec(), ClassificationsRFetch(), ClassificationsRelate(), ClassificationsSQLCompute(), ClassificationsSet(), ClassificationsUnRelate()
property Comments as HS.Registry.Document.Type.ValueType (SELECTIVITY = "7%", XMLNAME = "Comments", XMLPROJECTION = "ELEMENT");
Property methods: CommentsGet(), CommentsGetObject(), CommentsGetObjectId(), CommentsGetStored(), CommentsGetSwizzled(), CommentsIsEmpty(), CommentsIsValid(), CommentsNewObject(), CommentsSet(), CommentsSetObject(), CommentsSetObjectId(), CommentsUnSwizzle()
property ContentTypeCode as HS.Types.IHE.XDSb.SerialClassification;
Property methods: ContentTypeCodeCodingSchemeIndexExists(), ContentTypeCodeGet(), ContentTypeCodeGetObject(), ContentTypeCodeGetObjectId(), ContentTypeCodeGetStored(), ContentTypeCodeGetSwizzled(), ContentTypeCodeIndexExists(), ContentTypeCodeIsEmpty(), ContentTypeCodeIsValid(), ContentTypeCodeNewObject(), ContentTypeCodeSet(), ContentTypeCodeSetObject(), ContentTypeCodeSetObjectId(), ContentTypeCodeUnSwizzle()
property Documents as list of HS.Registry.Document (SELECTIVITY = "99%", XMLNAME = "Document", XMLPROJECTION = "ELEMENT");
Property methods: DocumentsBuildValueArray(), DocumentsCollectionToDisplay(), DocumentsCollectionToOdbc(), DocumentsDisplayToCollection(), DocumentsGet(), DocumentsGetObject(), DocumentsGetObjectId(), DocumentsGetStored(), DocumentsGetSwizzled(), DocumentsIsValid(), DocumentsOdbcToCollection(), DocumentsSet(), DocumentsSetObject(), DocumentsSetObjectId()
property ExternalIdentifiers as list of HS.Registry.Document.ExternalIdentifier (SELECTIVITY = ".00067%", XMLNAME = "ExternalIdentifier", XMLPROJECTION = "ELEMENT");
Property methods: ExternalIdentifiersBuildValueArray(), ExternalIdentifiersCollectionToDisplay(), ExternalIdentifiersCollectionToOdbc(), ExternalIdentifiersDisplayToCollection(), ExternalIdentifiersGet(), ExternalIdentifiersGetObject(), ExternalIdentifiersGetObjectId(), ExternalIdentifiersGetStored(), ExternalIdentifiersGetSwizzled(), ExternalIdentifiersIsValid(), ExternalIdentifiersOdbcToCollection(), ExternalIdentifiersSet(), ExternalIdentifiersSetObject(), ExternalIdentifiersSetObjectId()
property IID as %String (MAXLEN = 256, SELECTIVITY = 1, XMLNAME = "id", XMLPROJECTION = "ATTRIBUTE");
Property methods: IIDDisplayToLogical(), IIDGet(), IIDGetStored(), IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint(), IIDIsValid(), IIDLogicalToDisplay(), IIDLogicalToOdbc(), IIDNormalize(), IIDSet()
property LogicalIID as %String (MAXLEN = 256, SELECTIVITY = ".000001%", XMLNAME = "lid", XMLPROJECTION = "ATTRIBUTE");
Property methods: LogicalIIDDisplayToLogical(), LogicalIIDGet(), LogicalIIDGetStored(), LogicalIIDIndexExists(), LogicalIIDIsValid(), LogicalIIDLogicalToDisplay(), LogicalIIDLogicalToOdbc(), LogicalIIDNormalize(), LogicalIIDSet()
property Node as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Type of registry package value is type
Property methods: NodeGet(), NodeGetObject(), NodeGetObjectId(), NodeGetStored(), NodeGetSwizzled(), NodeIsEmpty(), NodeIsValid(), NodeNewObject(), NodeSet(), NodeSetObject(), NodeSetObjectId(), NodeUnSwizzle()
property PatientIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Property methods: PatientIdentifierGet(), PatientIdentifierGetObject(), PatientIdentifierGetObjectId(), PatientIdentifierGetStored(), PatientIdentifierGetSwizzled(), PatientIdentifierIndexExists(), PatientIdentifierIsEmpty(), PatientIdentifierIsValid(), PatientIdentifierNewObject(), PatientIdentifierSet(), PatientIdentifierSetObject(), PatientIdentifierSetObjectId(), PatientIdentifierUnSwizzle()
relationship Slots as array of HS.Registry.Document.Slot (SELECTIVITY = ".00067%", XMLNAME = "Slot", XMLPROJECTION = "ELEMENT") [ InitialExpression = $listbuild("HS.Registry.Document.Slot","RegistryPackage",+$this,"many",1,1) , Transient , Inverse = RegistryPackage , Cardinality = many ];
Property methods: SlotsGet(), SlotsGetObject(), SlotsGetObjectId(), SlotsGetSwizzled(), SlotsIsEmpty(), SlotsIsValid(), SlotsNewObject(), SlotsRClose(), SlotsRExec(), SlotsRFetch(), SlotsRelate(), SlotsSQLCompute(), SlotsSet(), SlotsUnRelate()
property SourceIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Property methods: SourceIdentifierGet(), SourceIdentifierGetObject(), SourceIdentifierGetObjectId(), SourceIdentifierGetStored(), SourceIdentifierGetSwizzled(), SourceIdentifierIndexExists(), SourceIdentifierIsEmpty(), SourceIdentifierIsValid(), SourceIdentifierNewObject(), SourceIdentifierSet(), SourceIdentifierSetObject(), SourceIdentifierSetObjectId(), SourceIdentifierUnSwizzle()
property Status as HS.Types.IHE.Status (SELECTIVITY = "99%", XMLNAME = "Status", XMLPROJECTION = "Element") [ InitialExpression = "Submitted" ];
Property methods: StatusDisplayToLogical(), StatusGet(), StatusGetStored(), StatusIsValid(), StatusLogicalToDisplay(), StatusLogicalToOdbc(), StatusLogicalToXSD(), StatusNormalize(), StatusSet(), StatusXSDToLogical()
property SubmissionTime as %String;
For submission sets
Property methods: SubmissionTimeDisplayToLogical(), SubmissionTimeGet(), SubmissionTimeGetStored(), SubmissionTimeIndexExists(), SubmissionTimeIsValid(), SubmissionTimeLogicalToDisplay(), SubmissionTimeLogicalToOdbc(), SubmissionTimeNormalize(), SubmissionTimeSet()
property Title as HS.Registry.Document.Type.ValueType (SELECTIVITY = "50%", XMLNAME = "Title", XMLPROJECTION = "ELEMENT");
Property methods: TitleGet(), TitleGetObject(), TitleGetObjectId(), TitleGetStored(), TitleGetSwizzled(), TitleIsEmpty(), TitleIsValid(), TitleNewObject(), TitleSet(), TitleSetObject(), TitleSetObjectId(), TitleUnSwizzle()
property Type as %String (DISPLAYLIST = ",Folder,Submission Set", SELECTIVITY = "33%", VALUELIST = ",F,SS") [ InitialExpression = "SS" ];
Property methods: TypeDisplayToLogical(), TypeGet(), TypeGetStored(), TypeIsValid(), TypeLogicalToDisplay(), TypeLogicalToOdbc(), TypeNormalize(), TypeSet()
property UniqueIdentifier as HS.Types.IHE.XDSb.SerialExternalIdentifier;
Property methods: UniqueIdentifierGet(), UniqueIdentifierGetObject(), UniqueIdentifierGetObjectId(), UniqueIdentifierGetStored(), UniqueIdentifierGetSwizzled(), UniqueIdentifierIndexExists(), UniqueIdentifierIsEmpty(), UniqueIdentifierIsValid(), UniqueIdentifierNewObject(), UniqueIdentifierSet(), UniqueIdentifierSetObject(), UniqueIdentifierSetObjectId(), UniqueIdentifierUnSwizzle()
property Version as %Integer;
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionNormalize(), VersionSet(), VersionXSDToLogical()

Methods

classmethod %OnDelete(oid As %ObjectIdentity) as %Status [ Language = objectscript ]
Inherited description: This callback method is invoked by the %Delete() method to provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.

classmethod FoldersForPatient(pID As %String, ByRef pQueryParams, ByRef pSets As %String) as %Status [ Language = objectscript ]
classmethod ItemForEntryID(pID As %String, pType="SS") as %String [ Language = objectscript ]
classmethod ItemForIID(pIID As %String) as %String [ Language = objectscript ]
classmethod ItemForUniqueID(pID As %String, pType="SS") as %String [ Language = objectscript ]
classmethod ItemsForLogicalID(pID As %String, pType="F", Output pAry) as %Status [ Language = objectscript ]
method LastUpdateTime() as %String [ Language = objectscript ]
classmethod ObjectForIIDOfHighestVersion(pIID As %String, Output pFolder) as %Status [ Language = objectscript ]
method PatientIDForObject() as %String [ Language = objectscript ]
method SlotValueForObject(pSlotName="") as %String [ Language = objectscript ]
classmethod SubmissionSetsForPatient(pID As %String, ByRef pSets As %String, ByRef pQueryParams) as %Status [ Language = objectscript ]
method UpdateTime() as %Status [ Language = objectscript ]

Indexes

index (AttributesIndex on Attributes(ELEMENTS),Attributes(KEYS));
index (ContentTypeCodeCodingSchemeIndex on ContentTypeCode.CodingScheme);
Index methods: ContentTypeCodeCodingSchemeIndexExists()
index (ContentTypeCodeIndex on ContentTypeCode.Code);
Index methods: ContentTypeCodeIndexExists()
index (IIDIndex on IID) [Unique];
Index methods: IIDIndexCheck(), IIDIndexCheckUnique(), IIDIndexDelete(), IIDIndexExists(), IIDIndexOpen(), IIDIndexSQLCheckUnique(), IIDIndexSQLExists(), IIDIndexSQLFindPKeyByConstraint(), IIDIndexSQLFindRowIDByConstraint()
index (LogicalIIDIndex on LogicalIID,Version);
Index methods: LogicalIIDIndexExists()
index (PatientIdentifierIndex on PatientIdentifier.Value);
Index methods: PatientIdentifierIndexExists()
index (SourceIdentifierIndex on SourceIdentifier.Value);
Index methods: SourceIdentifierIndexExists()
index (SubmissionTimeIndex on SubmissionTime);
Index methods: SubmissionTimeIndexExists()
index (UniqueIdentifierIndex on UniqueIdentifier.Value);
Index methods: UniqueIdentifierIndexExists()

Inherited Members

Inherited Methods

Storage

Storage Model: Storage (HS.Registry.Document.RegistryPackage)

^HS.Registry.DocRegistryPackD(ID,"Attributes",n)
=
Attributes(n)

Storage Model: Storage (HS.Registry.Document.RegistryPackage)

^HS.Registry.DocRegistryPackD(ID,"Comments",n)
=
Comments(n)

Storage Model: Storage (HS.Registry.Document.RegistryPackage)

^HS.Registry.DocRegistryPackD(ID)
=
%%CLASSNAME
Documents
ExternalIdentifiers
IID
Status
Type
ContentTypeCode
PatientIdentifier
SourceIdentifier
SubmissionTime
UniqueIdentifier
Node
Title
LogicalIID
Version