Publish.ExternalDirs
persistent class Publish.ExternalDirs extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Publish.ExternalDirs
Persistent class used to store data read from relinfo files. This class represents the information about external files we'll copy into $$$DEFAULTWEBAPPDIR.Property Inventory
- ComponentName
- FullName
- HomePageOverride
- HomePageOverrideType
- NOINDEX
- P4FinalDir
- ReleaseID
- TargetDirectoryName
- Version
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 ComponentName as %String (MAXLEN = 2000);
This is the display name for the component
Property methods: ComponentNameDisplayToLogical(), ComponentNameGet(), ComponentNameGetStored(), ComponentNameIsValid(), ComponentNameLogicalToDisplay(), ComponentNameLogicalToOdbc(), ComponentNameNormalize(), ComponentNameSet()
property FullName as %String (MAXLEN = 2000);
This is the display name for the doc
Property methods: FullNameDisplayToLogical(), FullNameGet(), FullNameGetStored(), FullNameIsValid(), FullNameLogicalToDisplay(), FullNameLogicalToOdbc(), FullNameNormalize(), FullNameSet()
property HomePageOverride as %String (MAXLEN = 2000);
This is the DocBookID or link to the item we'll use as the home page for this content (within generated
items such as KEY=ALL) if not the default (index.html).
Use HomePageOverrideType to indicate "URL" if the type of this is a link rather than a DocBookID.
If HomePageOverride is null, the default home is the file index.html in TargetDirectoryName.
Property methods: HomePageOverrideDisplayToLogical(), HomePageOverrideGet(), HomePageOverrideGetStored(), HomePageOverrideIsValid(), HomePageOverrideLogicalToDisplay(), HomePageOverrideLogicalToOdbc(), HomePageOverrideNormalize(), HomePageOverrideSet()
property HomePageOverrideType as %String (MAXLEN = 2000);
This indicates the type of the HomePageOverride.
Valid options are:
- DocBookID
- URL
Property methods: HomePageOverrideTypeDisplayToLogical(), HomePageOverrideTypeGet(), HomePageOverrideTypeGetStored(), HomePageOverrideTypeIsValid(), HomePageOverrideTypeLogicalToDisplay(), HomePageOverrideTypeLogicalToOdbc(), HomePageOverrideTypeNormalize(), HomePageOverrideTypeSet()
property NOINDEX as %Boolean;
If this is 1, we omit this item from the generated views of content.
Use case: we need to put a file on the website but don't want to advertise it in
those views.
Property methods: NOINDEXDisplayToLogical(), NOINDEXGet(), NOINDEXGetStored(), NOINDEXIsValid(), NOINDEXLogicalToDisplay(), NOINDEXLogicalToXSD(), NOINDEXNormalize(), NOINDEXSet(), NOINDEXXSDToLogical()
property P4FinalDir as %String);
This is the directory in P4 where we can find the files to copy
Property methods: P4FinalDirDisplayToLogical(), P4FinalDirGet(), P4FinalDirGetStored(), P4FinalDirIsValid(), P4FinalDirLogicalToDisplay(), P4FinalDirLogicalToOdbc(), P4FinalDirNormalize(), P4FinalDirSet()
property ReleaseID as %String;
Property methods: ReleaseIDDisplayToLogical(), ReleaseIDGet(), ReleaseIDGetStored(), ReleaseIDIsValid(), ReleaseIDLogicalToDisplay(), ReleaseIDLogicalToOdbc(), ReleaseIDNormalize(), ReleaseIDSet()
property TargetDirectoryName as %String (MAXLEN = 2000);
This is the name of the directory we'll create within /csp/docbook
Property methods: TargetDirectoryNameDisplayToLogical(), TargetDirectoryNameGet(), TargetDirectoryNameGetStored(), TargetDirectoryNameIsValid(), TargetDirectoryNameLogicalToDisplay(), TargetDirectoryNameLogicalToOdbc(), TargetDirectoryNameNormalize(), TargetDirectoryNameSet()
property Version as %String);
This is the version to use in search facets
Property methods: VersionDisplayToLogical(), VersionGet(), VersionGetStored(), VersionIsValid(), VersionLogicalToDisplay(), VersionLogicalToOdbc(), VersionNormalize(), VersionSet()
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.ExternalDirs)
^Publish.ExternalDirsD(ID) | = | %%CLASSNAME
Release
FullName
ComponentName
Version
TargetDirectoryName
HomePageOverride
HomePageOverrideType
P4FinalDir
NOINDEX
ReleaseID
|