Publish.TrakDocSet
persistent class Publish.TrakDocSet extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Publish.TrakDocSet
Persistent class used to store data read from trakdoc files.Property Inventory
- COMPUTEDBaseURL
- COMPUTEDFinalDir
- COMPUTEDLiveURL
- COMPUTEDWorkDir
- Config
- ConfluenceRootPageID
- DocSetID
- FullName
- Icon
- P4FinalSubdir
- P4WorkSubdir
- TOCTitle
- Text
Method Inventory
- GetCOMPUTEDBaseURL()
- GetCOMPUTEDFinalDir()
- GetCOMPUTEDLiveURL()
- GetCOMPUTEDWorkDir()
- GetDocSet()
- NewP4Path()
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.
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 COMPUTEDBaseURL as %String) [ Calculated , Transient ];
Property methods: COMPUTEDBaseURLCompute(), COMPUTEDBaseURLDisplayToLogical(), COMPUTEDBaseURLGet(), COMPUTEDBaseURLIsValid(), COMPUTEDBaseURLLogicalToDisplay(), COMPUTEDBaseURLLogicalToOdbc(), COMPUTEDBaseURLNormalize(), COMPUTEDBaseURLSQLCompute()
property COMPUTEDFinalDir as %String) [ Calculated , Transient ];
Property methods: COMPUTEDFinalDirCompute(), COMPUTEDFinalDirDisplayToLogical(), COMPUTEDFinalDirGet(), COMPUTEDFinalDirIsValid(), COMPUTEDFinalDirLogicalToDisplay(), COMPUTEDFinalDirLogicalToOdbc(), COMPUTEDFinalDirNormalize(), COMPUTEDFinalDirSQLCompute()
property COMPUTEDLiveURL as %String) [ Calculated , Transient ];
Property methods: COMPUTEDLiveURLCompute(), COMPUTEDLiveURLDisplayToLogical(), COMPUTEDLiveURLGet(), COMPUTEDLiveURLIsValid(), COMPUTEDLiveURLLogicalToDisplay(), COMPUTEDLiveURLLogicalToOdbc(), COMPUTEDLiveURLNormalize(), COMPUTEDLiveURLSQLCompute()
property COMPUTEDWorkDir as %String) [ Calculated , Transient ];
Property methods: COMPUTEDWorkDirCompute(), COMPUTEDWorkDirDisplayToLogical(), COMPUTEDWorkDirGet(), COMPUTEDWorkDirIsValid(), COMPUTEDWorkDirLogicalToDisplay(), COMPUTEDWorkDirLogicalToOdbc(), COMPUTEDWorkDirNormalize(), COMPUTEDWorkDirSQLCompute()
relationship Config as Publish.TrakDocConfig [ Required , Inverse = DocSets , Cardinality = parent ];
The configuration/group to which this doc set belongs
Property methods: ConfigGet(), ConfigGetObject(), ConfigGetObjectId(), ConfigGetStored(), ConfigGetSwizzled(), ConfigIsValid(), ConfigNewObject(), ConfigOnDelete(), ConfigRClose(), ConfigRExec(), ConfigRFetch(), ConfigRelate(), ConfigSQLCompute(), ConfigSet(), ConfigSetObject(), ConfigSetObjectId(), ConfigUnRelate(), ConfigUnSwizzle()
property ConfluenceRootPageID as %Integer;
numeric ID of the confluence page that is the parent of all the guides
for this DocSet
Property methods: ConfluenceRootPageIDDisplayToLogical(), ConfluenceRootPageIDGet(), ConfluenceRootPageIDGetStored(), ConfluenceRootPageIDIsValid(), ConfluenceRootPageIDLogicalToDisplay(), ConfluenceRootPageIDNormalize(), ConfluenceRootPageIDSet(), ConfluenceRootPageIDXSDToLogical()
property DocSetID as %String);
ID of DocSet
Property methods: DocSetIDDisplayToLogical(), DocSetIDGet(), DocSetIDGetStored(), DocSetIDIsValid(), DocSetIDLogicalToDisplay(), DocSetIDLogicalToOdbc(), DocSetIDNormalize(), DocSetIDSet()
property FullName as %String);
Long name of DocSet
Property methods: FullNameDisplayToLogical(), FullNameGet(), FullNameGetStored(), FullNameIsValid(), FullNameLogicalToDisplay(), FullNameLogicalToOdbc(), FullNameNormalize(), FullNameSet()
property Icon as %String);
Property methods: IconDisplayToLogical(), IconGet(), IconGetStored(), IconIsValid(), IconLogicalToDisplay(), IconLogicalToOdbc(), IconNormalize(), IconSet()
property P4FinalSubdir as %String);
Property methods: P4FinalSubdirDisplayToLogical(), P4FinalSubdirGet(), P4FinalSubdirGetStored(), P4FinalSubdirIsValid(), P4FinalSubdirLogicalToDisplay(), P4FinalSubdirLogicalToOdbc(), P4FinalSubdirNormalize(), P4FinalSubdirSet()
property P4WorkSubdir as %String);
Property methods: P4WorkSubdirDisplayToLogical(), P4WorkSubdirGet(), P4WorkSubdirGetStored(), P4WorkSubdirIsValid(), P4WorkSubdirLogicalToDisplay(), P4WorkSubdirLogicalToOdbc(), P4WorkSubdirNormalize(), P4WorkSubdirSet()
property TOCTitle as %String);
Title for left TOC
Property methods: TOCTitleDisplayToLogical(), TOCTitleGet(), TOCTitleGetStored(), TOCTitleIsValid(), TOCTitleLogicalToDisplay(), TOCTitleLogicalToOdbc(), TOCTitleNormalize(), TOCTitleSet()
property Text as %String);
Property methods: TextDisplayToLogical(), TextGet(), TextGetStored(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextSet()
Methods
classmethod GetDocSet(Config As %String = "", DocSetID As %String = "") as Publish.TrakDocSet
Indexes
index (IDKEY on ) [IdKey, Type = key];
Index methods: IDKEYCheck(), IDKEYDelete(), IDKEYExists(), IDKEYOpen(), IDKEYSQLCheckUnique(), IDKEYSQLExists(), IDKEYSQLFindPKeyByConstraint(), IDKEYSQLFindRowIDByConstraint()
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %CheckConstraints()
- %CheckConstraintsForExtent()
- %ClassIsLatestVersion()
- %ClassName()
- %ComposeOid()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GUID()
- %GUIDSet()
- %GetLock()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Storage Model: CacheStorage (Publish.TrakDocSet)
{%%PARENT}("DocSets")(ID) | = | %%CLASSNAME
DocSetID
FullName
TOCTitle
ConfluenceRootPageID
P4WorkSubdir
P4FinalSubdir
Icon
Text
|