Publish.TrakDocConfig
persistent class Publish.TrakDocConfig extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Publish.TrakDocConfig
Persistent class used to store data read from trakdoc files.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.
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 BaseURL as %String);
Root URL for the BASE environment where this content is served.
Includes URL up to the point that URLs for different doc sets diverge
Property methods: BaseURLDisplayToLogical(), BaseURLGet(), BaseURLGetStored(), BaseURLIsValid(), BaseURLLogicalToDisplay(), BaseURLLogicalToOdbc(), BaseURLNormalize(), BaseURLSet()
property ConfigID as %String) [ Required ];
Unique; must match filename
Property methods: ConfigIDDisplayToLogical(), ConfigIDGet(), ConfigIDGetStored(), ConfigIDIsValid(), ConfigIDLogicalToDisplay(), ConfigIDLogicalToOdbc(), ConfigIDNormalize(), ConfigIDSet()
relationship DocSets as array of Publish.TrakDocSet [ InitialExpression = $listbuild("Publish.TrakDocSet","Config",+$this,"children",1,1) , Transient , Inverse = Config , Cardinality = children ];
sets of documentation associated with this version.
Each set of doc. corresponds to ONE Confluence home page (and its children)
and each set also gets its own subdirectory within the working directory
and within the final directory.
Property methods: DocSetsGet(), DocSetsGetObject(), DocSetsGetObjectId(), DocSetsGetSwizzled(), DocSetsIsEmpty(), DocSetsIsValid(), DocSetsNewObject(), DocSetsRClose(), DocSetsRExec(), DocSetsRFetch(), DocSetsRelate(), DocSetsSQLCompute(), DocSetsSet(), DocSetsUnRelate()
property GroupNumber as %Integer;
Order of this group, with respect to other groups, on the generated
landing pages
Property methods: GroupNumberDisplayToLogical(), GroupNumberGet(), GroupNumberGetStored(), GroupNumberIsValid(), GroupNumberLogicalToDisplay(), GroupNumberNormalize(), GroupNumberSet(), GroupNumberXSDToLogical()
property GroupTitle as %String);
Name to use for this group of content on the generated landing pages
Property methods: GroupTitleDisplayToLogical(), GroupTitleGet(), GroupTitleGetStored(), GroupTitleIsValid(), GroupTitleLogicalToDisplay(), GroupTitleLogicalToOdbc(), GroupTitleNormalize(), GroupTitleSet()
property Icon as %String);
Property methods: IconDisplayToLogical(), IconGet(), IconGetStored(), IconIsValid(), IconLogicalToDisplay(), IconLogicalToOdbc(), IconNormalize(), IconSet()
property LiveURL as %String);
Root URL for the LIVE environment where this content is served.
Includes URL up to the point that URLs for different doc sets diverge
Property methods: LiveURLDisplayToLogical(), LiveURLGet(), LiveURLGetStored(), LiveURLIsValid(), LiveURLLogicalToDisplay(), LiveURLLogicalToOdbc(), LiveURLNormalize(), LiveURLSet()
property P4FinalDirRoot as %String);
Property methods: P4FinalDirRootDisplayToLogical(), P4FinalDirRootGet(), P4FinalDirRootGetStored(), P4FinalDirRootIsValid(), P4FinalDirRootLogicalToDisplay(), P4FinalDirRootLogicalToOdbc(), P4FinalDirRootNormalize(), P4FinalDirRootSet()
property P4WorkDirRoot as %String);
Property methods: P4WorkDirRootDisplayToLogical(), P4WorkDirRootGet(), P4WorkDirRootGetStored(), P4WorkDirRootIsValid(), P4WorkDirRootLogicalToDisplay(), P4WorkDirRootLogicalToOdbc(), P4WorkDirRootNormalize(), P4WorkDirRootSet()
property Text as %String);
Property methods: TextDisplayToLogical(), TextGet(), TextGetStored(), TextIsValid(), TextLogicalToDisplay(), TextLogicalToOdbc(), TextNormalize(), TextSet()
Methods
classmethod ChooseDocSet(verbose As %Boolean = 1)
classmethod Export(verbose As %Boolean = 0)
Initialize the tables from files
classmethod SetGlobalsForDocSet(ConfigID="", docsetid="", verbose As %Boolean = 1)
classmethod SpecifyAdHocWorkDir()
Indexes
index (MainIDX on ConfigID) [IdKey, Type = key, Unique];
Index methods: MainIDXCheck(), MainIDXDelete(), MainIDXExists(), MainIDXOpen(), MainIDXSQLCheckUnique(), MainIDXSQLExists(), MainIDXSQLFindPKeyByConstraint(), MainIDXSQLFindRowIDByConstraint()
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.TrakDocConfig)
^Publish.TrakDocConfigD(ID) | = | %%CLASSNAME
GroupTitle
GroupNumber
P4WorkDirRoot
P4FinalDirRoot
BaseURL
LiveURL
Icon
Text
|