Publish.WebsiteGroup
persistent class Publish.WebsiteGroup extends %Library.Persistent, %XML.Adaptor
SQL Table Name: Publish.WebsiteGroup
Persistent class used to store data read from groupinfo files.Property Inventory
- AdditionalSeeAlso
- AfterGroup
- CanonicalBaseURL
- CatalogPage
- CatalogPageJ
- GroupDescription
- GroupDescriptionLong
- GroupID
- INACTIVE
- IncludeInSiteMapIndex
- LatestPage
- LatestPageM
- NumId
- Product
- ProductForWebsiteLandingPage
- ProductIconClassname
- ProductIconFilename
- ProductNameForSearch
- ProductNoSymbols
- ProductPlain
- SiteMapOverrideBaseURL
- VersionDetailsText
- VersionLinkText
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 AdditionalSeeAlso as %String);
Any additional HTML to include in the "See also" section
Property methods: AdditionalSeeAlsoDisplayToLogical(), AdditionalSeeAlsoGet(), AdditionalSeeAlsoGetStored(), AdditionalSeeAlsoIsValid(), AdditionalSeeAlsoLogicalToDisplay(), AdditionalSeeAlsoLogicalToOdbc(), AdditionalSeeAlsoNormalize(), AdditionalSeeAlsoSet()
property AfterGroup as %String);
Optional text to display after the generated stuff for a group
Property methods: AfterGroupDisplayToLogical(), AfterGroupGet(), AfterGroupGetStored(), AfterGroupIsValid(), AfterGroupLogicalToDisplay(), AfterGroupLogicalToOdbc(), AfterGroupNormalize(), AfterGroupSet()
property CanonicalBaseURL as %String (MAXLEN = 200);
Property methods: CanonicalBaseURLDisplayToLogical(), CanonicalBaseURLGet(), CanonicalBaseURLGetStored(), CanonicalBaseURLIsValid(), CanonicalBaseURLLogicalToDisplay(), CanonicalBaseURLLogicalToOdbc(), CanonicalBaseURLNormalize(), CanonicalBaseURLSet()
property CatalogPage as %String (MAXLEN = 200);
Property methods: CatalogPageDisplayToLogical(), CatalogPageGet(), CatalogPageGetStored(), CatalogPageIsValid(), CatalogPageLogicalToDisplay(), CatalogPageLogicalToOdbc(), CatalogPageNormalize(), CatalogPageSet()
property CatalogPageJ as %String (MAXLEN = 200);
Property methods: CatalogPageJDisplayToLogical(), CatalogPageJGet(), CatalogPageJGetStored(), CatalogPageJIsValid(), CatalogPageJLogicalToDisplay(), CatalogPageJLogicalToOdbc(), CatalogPageJNormalize(), CatalogPageJSet()
property GroupDescription as %String);
Optional description to display after the product name on the home page card (index.html)
, but before the generated stuff
Property methods: GroupDescriptionDisplayToLogical(), GroupDescriptionGet(), GroupDescriptionGetStored(), GroupDescriptionIsValid(), GroupDescriptionLogicalToDisplay(), GroupDescriptionLogicalToOdbc(), GroupDescriptionNormalize(), GroupDescriptionSet()
property GroupDescriptionLong as %String);
Optional description to display after the product name on the catalog page,
before the generated stuff. If null, we use GroupDescription instead.
Property methods: GroupDescriptionLongDisplayToLogical(), GroupDescriptionLongGet(), GroupDescriptionLongGetStored(), GroupDescriptionLongIsValid(), GroupDescriptionLongLogicalToDisplay(), GroupDescriptionLongLogicalToOdbc(), GroupDescriptionLongNormalize(), GroupDescriptionLongSet()
property GroupID as %String [ Required ];
Unique identifier for the website group
Property methods: GroupIDDisplayToLogical(), GroupIDGet(), GroupIDGetStored(), GroupIDIsValid(), GroupIDLogicalToDisplay(), GroupIDLogicalToOdbc(), GroupIDNormalize(), GroupIDSet()
property INACTIVE as %Boolean [ InitialExpression = 0 ];
If 1, we exclude this group from index.html
Property methods: INACTIVEDisplayToLogical(), INACTIVEGet(), INACTIVEGetStored(), INACTIVEIsValid(), INACTIVELogicalToDisplay(), INACTIVELogicalToXSD(), INACTIVENormalize(), INACTIVESet(), INACTIVEXSDToLogical()
property IncludeInSiteMapIndex as %Boolean;
If 1, this group's sitemap file is included in SiteMapIndex.xml
Property methods: IncludeInSiteMapIndexDisplayToLogical(), IncludeInSiteMapIndexGet(), IncludeInSiteMapIndexGetStored(), IncludeInSiteMapIndexIsValid(), IncludeInSiteMapIndexLogicalToDisplay(), IncludeInSiteMapIndexLogicalToXSD(), IncludeInSiteMapIndexNormalize(), IncludeInSiteMapIndexSet(), IncludeInSiteMapIndexXSDToLogical()
property LatestPage as %String (MAXLEN = 200);
Property methods: LatestPageDisplayToLogical(), LatestPageGet(), LatestPageGetStored(), LatestPageIsValid(), LatestPageLogicalToDisplay(), LatestPageLogicalToOdbc(), LatestPageNormalize(), LatestPageSet()
property LatestPageM as %String (MAXLEN = 200);
Property methods: LatestPageMDisplayToLogical(), LatestPageMGet(), LatestPageMGetStored(), LatestPageMIsValid(), LatestPageMLogicalToDisplay(), LatestPageMLogicalToOdbc(), LatestPageMNormalize(), LatestPageMSet()
property NumId as %Integer;
Property methods: NumIdDisplayToLogical(), NumIdGet(), NumIdGetStored(), NumIdIsValid(), NumIdLogicalToDisplay(), NumIdNormalize(), NumIdSet(), NumIdXSDToLogical()
property Product as %String (MAXLEN = 200);
Property methods: ProductDisplayToLogical(), ProductGet(), ProductGetStored(), ProductIsValid(), ProductLogicalToDisplay(), ProductLogicalToOdbc(), ProductNormalize(), ProductSet()
property ProductForWebsiteLandingPage as %String (MAXLEN = 200);
Name of this product group as it should be included on the main documentation landing page
Property methods: ProductForWebsiteLandingPageDisplayToLogical(), ProductForWebsiteLandingPageGet(), ProductForWebsiteLandingPageGetStored(), ProductForWebsiteLandingPageIsValid(), ProductForWebsiteLandingPageLogicalToDisplay(), ProductForWebsiteLandingPageLogicalToOdbc(), ProductForWebsiteLandingPageNormalize(), ProductForWebsiteLandingPageSet()
property ProductIconClassname as %String (MAXLEN = 200);
Name of CSS class to use inside ![]()
tag
Property methods: ProductIconClassnameDisplayToLogical(), ProductIconClassnameGet(), ProductIconClassnameGetStored(), ProductIconClassnameIsValid(), ProductIconClassnameLogicalToDisplay(), ProductIconClassnameLogicalToOdbc(), ProductIconClassnameNormalize(), ProductIconClassnameSet()
property ProductIconFilename as %String (MAXLEN = 200);
Property methods: ProductIconFilenameDisplayToLogical(), ProductIconFilenameGet(), ProductIconFilenameGetStored(), ProductIconFilenameIsValid(), ProductIconFilenameLogicalToDisplay(), ProductIconFilenameLogicalToOdbc(), ProductIconFilenameNormalize(), ProductIconFilenameSet()
property ProductNameForSearch as %String (MAXLEN = 500);
Name of this product group to be used for search facets and other search-related use cases
Property methods: ProductNameForSearchDisplayToLogical(), ProductNameForSearchGet(), ProductNameForSearchGetStored(), ProductNameForSearchIsValid(), ProductNameForSearchLogicalToDisplay(), ProductNameForSearchLogicalToOdbc(), ProductNameForSearchNormalize(), ProductNameForSearchSet()
property ProductNoSymbols as %String (MAXLEN = 200);
Full product name, without any symbols.
Usually the same as the Product property but without any trademark or registered symbols.
Used, for example, in the list of products on the custom 404 error page.
Property methods: ProductNoSymbolsDisplayToLogical(), ProductNoSymbolsGet(), ProductNoSymbolsGetStored(), ProductNoSymbolsIsValid(), ProductNoSymbolsLogicalToDisplay(), ProductNoSymbolsLogicalToOdbc(), ProductNoSymbolsNormalize(), ProductNoSymbolsSet()
property ProductPlain as %String (MAXLEN = 200);
Short product name, without any inline HTML or entities.
Property methods: ProductPlainDisplayToLogical(), ProductPlainGet(), ProductPlainGetStored(), ProductPlainIsValid(), ProductPlainLogicalToDisplay(), ProductPlainLogicalToOdbc(), ProductPlainNormalize(), ProductPlainSet()
property SiteMapOverrideBaseURL as %String (MAXLEN = 200);
Property methods: SiteMapOverrideBaseURLDisplayToLogical(), SiteMapOverrideBaseURLGet(), SiteMapOverrideBaseURLGetStored(), SiteMapOverrideBaseURLIsValid(), SiteMapOverrideBaseURLLogicalToDisplay(), SiteMapOverrideBaseURLLogicalToOdbc(), SiteMapOverrideBaseURLNormalize(), SiteMapOverrideBaseURLSet()
property VersionDetailsText as %String);
We use this to contain added text on the catalog pages for HS and HC.
Property methods: VersionDetailsTextDisplayToLogical(), VersionDetailsTextGet(), VersionDetailsTextGetStored(), VersionDetailsTextIsValid(), VersionDetailsTextLogicalToDisplay(), VersionDetailsTextLogicalToOdbc(), VersionDetailsTextNormalize(), VersionDetailsTextSet()
property VersionLinkText as %String (MAXLEN = 200);
Property methods: VersionLinkTextDisplayToLogical(), VersionLinkTextGet(), VersionLinkTextGetStored(), VersionLinkTextIsValid(), VersionLinkTextLogicalToDisplay(), VersionLinkTextLogicalToOdbc(), VersionLinkTextNormalize(), VersionLinkTextSet()
Methods
Return the ProductNameForSearch property associated with the given GroupId.
Return "" if no such group exists or the group specified does not have a ProductNameForSearch.
Indexes
index (GroupIDIDX on GroupID) [IdKey, Type = key, Unique];
Index methods: GroupIDIDXCheck(), GroupIDIDXDelete(), GroupIDIDXExists(), GroupIDIDXOpen(), GroupIDIDXSQLCheckUnique(), GroupIDIDXSQLExists(), GroupIDIDXSQLFindPKeyByConstraint(), GroupIDIDXSQLFindRowIDByConstraint()
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.WebsiteGroup)
^Publish.WebsiteGroupD(ID) | = | %%CLASSNAME
NumId
Product
ProductPlain
ProductIconFilename
ProductIconClassname
VersionLinkText
CatalogPage
CatalogPageJ
LatestPage
LatestPageM
CanonicalBaseURL
SiteMapOverrideBaseURL
GroupDescription
AfterGroup
VersionDetailsText
INACTIVE
IncludeInSiteMapIndex
ProductForWebsiteLandingPage
GroupDescriptionLong
AdditionalSeeAlso
ProductNoSymbols
ProductNameForSearch
|