Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%SYS] >  [Portal] >  [Resources]
Private  Storage   

persistent class %SYS.Portal.Resources extends %Persistent, %XML.Adaptor, %SYSTEM.Help

This class will allow a user to associate resources with pages in the system management portal.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
10 1 1


Summary

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 Export
Help Import XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


Methods

• classmethod Export(FileName As %String = "CustomPortalResourcesExport.xml", ByRef NumExported As %Integer, Pages As %String = "*", Resources As %String = "*") as %Status
Export Custom Resource records to a file in XML format. The user must have USE permissions on the %Admin_Secure resource to perform the export.
Parameters:
  • Filename - Output file name.
  • NumExported (ByRef) - Returns the number of records exported.
  • Pages - Mask for the pages to return. See the List query for details on the format.
  • Resources - Mask for the resources to return. See the List query for details on the format.
• classmethod Import(FileName As %String = "ResourcesExport.xml", ByRef NumImported As %Integer, Flags As %Integer = 0) as %Status
Import Custom Resource records from an XML file. The user must have USE permissions on the %Admin_Secure resource to perform the import.
Parameters:
  • FileName - Filename to import Custom Resource records from.
  • NumImported (ByRef) - Returns the number of records imported.
  • InvalidRecords
  • Flags - Control whether to import the records in the file. The supported bit flags at present are:
    • Bit 0 - Do not import records, just return the count.
    • Bit 1 - Do not require that the resource exists.
Note: On failure, no records will be imported.

Queries

• query List(Pages As %String = "*", Resources As %String = "*")
Selects Page As %String, Resource As %String
List pages and associated resources. Note: the Page column lists the normalized page name.
Use the Pages and Resources arguments to restrict the list. The possible inputs for each argument is a comma-separated string with the following rules:
  • "*" - match all records.
  • "String,String1" - match all records that match an element in the string
  • "String*" - match all records starting with "String"
  • "String,String1*,String2" - match any record equal to "String" or "String2", or starting with "String1"
Note: This query may change in future versions.

Indices

•index (PageIndex on Page) [IdKey];


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.