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

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

This class will allow a user to specify and save favorite pages in the system management portal.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9 1 1


Summary

Properties
%Concurrency Data Page Username

Methods
%%OIDGet %1Check %AddFavorite %AddJrnObjToSyncSet
%AddToSaveSet %AddToSyncSet %BMEBuilt %BindExport
%BuildIndices %BuildIndicesSegment %BuildObjectGraph %CheckConstraints
%CheckConstraintsForExtent %ClassIsLatestVersion %ClassName %Close
%ComposeOid %ConstructClone %Delete %DeleteExtent
%DeleteId %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%DowngradeConcurrency %ExecuteAfterTriggers %ExecuteBeforeTriggers %Exists
%ExistsId %Extends %FileIndices %FileIndicesBuffered
%GUID %GUIDSet %GetFavoritesForUser %GetFavoritesForUsers
%GetLock %GetParameter %GetSwizzleObject %Id
%IncrementCount %InsertBatch %IsA %IsModified
%IsNull %JournalObject %KillExtent %KillExtentData
%LoadFromMemory %LockExtent %LockId %New
%NormalizeObject %ObjectIsNull %ObjectModified %Oid
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %PhysicalAddress %PurgeIndices
%Reload %RemoveFavorite %RemoveFavoritesForUser %RemoveFavoritesForUsers
%RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack %SQLAcquireLock
%SQLAcquireTableLock %SQLAfterTriggers %SQLBeforeTriggers %SQLBuildIndices
%SQLBuildPurgeIndexForRow %SQLBuildPurgeIndices %SQLCheckUnique %SQLCheckUniqueIndices
%SQLCheckUniqueKeys %SQLCopyIcolIntoName %SQLCopyNameIntoIcol %SQLCreateInsDelTables
%SQLDefineiDjVars %SQLDelete %SQLDeleteChildren %SQLDeleteTempStreams
%SQLEExit %SQLExists %SQLFKeyDelLock %SQLFastInsert
%SQLFieldValidate %SQLGetLock %SQLGetOld %SQLGetOldAll
%SQLGetOldIndex %SQLInsert %SQLInsertComputes %SQLInsertStreams
%SQLInvalid %SQLInvalid2 %SQLMVDelete %SQLMVIndexDelete
%SQLMVIndexInsert %SQLMVIndexUpdate %SQLMVInsert %SQLMVUpdate
%SQLMissing %SQLNormalizeCompFields %SQLNormalizeFields %SQLPurgeIndices
%SQLQuickBulkInsert %SQLQuickBulkLoad %SQLQuickBulkSave %SQLQuickBulkUpdate
%SQLQuickDelete %SQLQuickDeleteChildren %SQLQuickFindPKeyByRowID %SQLQuickFindRowIDByPKey
%SQLQuickInsert %SQLQuickLoad %SQLQuickLoadChildren %SQLQuickLogicalToOdbc
%SQLQuickOdbcToLogical %SQLQuickUpdate %SQLReleaseLock %SQLReleaseTableLock
%SQLStorageValidation %SQLTrigDelTab %SQLTrigInsTab %SQLUnlock
%SQLUnlock2 %SQLUnlockError %SQLUnlockRef %SQLUpdate
%SQLUpdateComputes %SQLUpdateStreams %SQLValidateCompFields %SQLValidateFields
%SQLicompView %SQLnBuild %Save %SaveDirect
%SaveIndices %SerializeObject %SetModified %SortBegin
%SortEnd %SyncObjectIn %SyncTransport %UnlockExtent
%UnlockId %UpgradeConcurrency %ValidateIndices %ValidateObject
%XMLGenerate Help ListClose ListExecute
ListFetch XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


Properties

• property Data as %List [ Required ];
Arbitray $list data.
• property Page as %String(MAXLEN=256) [ Required ];
Identifier for the page.
• property Username as %String(MAXLEN=128) [ Required ];
$username of the user saving the page.

Methods

• classmethod %AddFavorite(Page As %String, Data As %List) as %Status
Add a page favorite for the current $username.
If the page favorite already exists, return success.
Parameters:

Page - Identifier of the page.
Data - Data associated with the page.
• classmethod %GetFavoritesForUser(ByRef Favorites As %String) as %Status
Return the list of page favorites for the current $Username.
Parameters:

Favorites (byref) - Array of page favorites for the current $username.
Favorites(Page)=Data
• classmethod %GetFavoritesForUsers(Usernames As %String = "*", ByRef Favorites As %String) as %Status
Return the list of page favorites for the specified usernames.
Parameters:

Usernames - List of usernames in the same format passed to the List() query.
Favorites (byref) - Array of page favorites for the specified users.
Favorites(Username,Page)=Data
• classmethod %RemoveFavorite(Page As %String) as %Status
Remove a page favorite for the current $username.
Returns success if the page favorite does not exist.
Parameters:

Page - Identifier of the page favorite to remove for $username.
• classmethod %RemoveFavoritesForUser() as %Status
Remove all page favorites for the current $username.
• classmethod %RemoveFavoritesForUsers(Usernames As %String = $username) as %Status
Remove all favorites for the specified usernames.
Parameters:

Usernames - List of usernames in the same format passed to the List() query.
• classmethod ListClose(ByRef qHandle As %Binary) as %Status
• classmethod ListExecute(ByRef qHandle As %Binary, Usernames As %String = "*") as %Status
• classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status

Queries

• query List(Usernames As %String = "*")
Selects Username As %String, Page As %String, Data As %List
List of users and their page favorites.
Names - Comma separated list of users
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record matching one of these elements, or starting with "String1"
Note: This query may change in future versions

Indices

•index (UserNamePageIndex on Username,Page) [IdKey];


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