Home > Class Reference > %SYS namespace > Provider.Instances
Private   Storage    

Provider.Instances

persistent class Provider.Instances extends %Persistent, %SYSTEM.Help

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
19 7 1 1

Summary

Properties
CacheGroup CachePassword CacheUser Description
Directory Error Installed InstanceName
InstanceNameLowerCase LastInstall LastInstallTime LastInstallUsername
MachineName MachineNameLowerCase ManagerGroup SecurityType
State Status Unicode
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 Create
Delete Exists Get Help
Install Modify Remove

Properties

property CacheGroup as %String [ InitialExpression = "cacheusr" ];
property CachePassword as %String [ InitialExpression = "SYS" ];
property CacheUser as %String [ InitialExpression = "cacheusr" ];
property Description as %String(MAXLEN=256,MINLEN=0);
Enter a description
property Directory as %SysPath;
property Error as %String(MAXLEN=255);
Readable version of Status property.
property Installed as %Boolean [ InitialExpression = 0 ];
0 - Not installed 1 - Installed
property InstanceName as %String(MAXLEN=64,MINLEN=1) [ Required ];
property InstanceNameLowerCase as %String(MAXLEN=64,MINLEN=1,XMLPROJECTION="NONE") [ Required,ReadOnly ];
property LastInstall as %String(MAXLEN=64,MINLEN=0);
property LastInstallTime as %String(MAXLEN=64) [ ReadOnly ];
property LastInstallUsername as %String(MAXLEN=64) [ ReadOnly ];
property MachineName as %String(MAXLEN=64,MINLEN=1) [ Required ];
property MachineNameLowerCase as %String(MAXLEN=64,MINLEN=1,XMLPROJECTION="NONE") [ Required,ReadOnly ];
property ManagerGroup as %String [ InitialExpression = "root" ];
property SecurityType as %String [ InitialExpression = "Minimal" ];
property State as %String [ InitialExpression = "Uninstalled" ];
property Status as %Status [ InitialExpression = $$$OK ];
property Unicode as %Boolean [ InitialExpression = 1 ];

Methods

classmethod Create(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Delete(MachineName As %String, InstanceName As %String) as %Status
classmethod Exists(MachineName As %String, InstanceName As %String, ByRef Instance As %ObjectHandle, ByRef Status As %Status) as %Boolean
Instance exists.
This method checks for the existence of an Event in the security database.
Parameters:
Source - Source of the Event. This may also contain an entire Event specificationin the format Source/Type/Name. If this is the case the Type and Name parameters are ignored.
Type - Type of the Event
Name - Name of the Event
Return values:
If Value of the method = 0 (Event does not exist, or some error occured)
Event = Null
Status = Event "x" does not exist, or other error message

If Value of the method = 1 (Event exists)
Event = Object handle to Event
Status = $$$OK
classmethod Get(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Install(MachineName As %String, InstanceName As %String) as %Status
classmethod Modify(MachineName As %String, InstanceName As %String, ByRef Properties As %String) as %Status
classmethod Remove(MachineName As %String, InstanceName As %String) as %Status

Queries

query List(Names As %String)
Selects MachineName As %String, InstanceName As %String, Directory As %String, Description As %String, LastInstall As %String, LastInstallTime As %String, LastInstallUsername As %String, State As %String, Status As %String, Error As %String, CacheGroup As %String, CacheUser As %String, ManagerGroup As %String, SecurityType As %String, Unicode As %Boolean
List Instances.

Parameters:
Names - Comma separated list of Device names
"*" - All records match
"String,String1" - Any records matching one of these elements
"String*" - Any record starting with "String"
"String,String1*,String2" - Any record mathing one of these elements, or starting with "String1"
Note: This query may change in future versions

Indices

•index (MachineNameInstanceNameLowerCaseIndex on MachineNameLowerCase,InstanceNameLowerCase) [IdKey,Unique];