%Wallet.Collection
persistent class %Wallet.Collection extends %SYS.Wallet.Collection, %XML.Adaptor [ Final ]
SQL Table Name: %Wallet.Collection
This class defines a collection of secrets.Access to UseResource grants the ability to use the secrets in the collection.
Access to EditResource grants the ability to add or remove secrets from the collection and to edit secrets in the collection.
%Admin_Wallet:USE is required to create or edit collections.
Property Inventory
Method Inventory
- Create()
- Delete()
- EditResourceSet()
- Exists()
- Export()
- Import()
- Modify()
- ResourceSet()
- UseResourceSet()
Properties
property EditResource as %String (MAXLEN = 64) [ Required ];
Access to this resource is required to add secrets to, or to remove secrets from this collection,
and to edit secrets in the collection. Specified as ":". If is omitted "WRITE" is used.
Property methods: EditResourceDisplayToLogical(), EditResourceGet(), EditResourceGetStored(), EditResourceIsValid(), EditResourceLogicalToDisplay(), EditResourceLogicalToOdbc(), EditResourceNormalize()
property Name as %String (MAXLEN = 64, PATTERN = "1(1""%"",1A).(1AN,1""-"",1""_"")") [ Required ];
The name of the collection. This may contain alphanumeric characters, "-" or "_" and may start with a "%".
Property methods: NameDisplayToLogical(), NameGet(), NameGetStored(), NameIsValid(), NameLogicalToDisplay(), NameLogicalToOdbc(), NameNormalize(), NameSet()
property Resource as %String (MAXLEN = 64, XMLPROJECTION = "none") [ Transient ];
Input only. Use this property to set UseResource and EditResource to the same resource.
Specified as ":". If is omitted "READ" is used for UseResource and
"WRITE" is used for EditResource. If is specified EditResource and
UseResource will be the same.
Property methods: ResourceDisplayToLogical(), ResourceGet(), ResourceIsValid(), ResourceLogicalToDisplay(), ResourceLogicalToOdbc(), ResourceNormalize()
property UseResource as %String (MAXLEN = 64) [ Required ];
Access to this resource is required to use secrets in this collection.
Specified as ":". If is omitted "READ" is used.
Property methods: UseResourceDisplayToLogical(), UseResourceGet(), UseResourceGetStored(), UseResourceIsValid(), UseResourceLogicalToDisplay(), UseResourceLogicalToOdbc(), UseResourceNormalize()
Methods
Create a new new collection with the given name and resource.
Delete the named collection. All secrets in the collection will also be deleted.
method EditResourceSet(val) as %Status
classmethod Exists(name As %String, obj As %Wallet.Collection, sc As %Status) as %Boolean
Returns true if the named collection exists.
If true, a reference to the collection will be returned in obj.
If false sc will contain the error details.
If true, a reference to the collection will be returned in obj.
If false sc will contain the error details.
classmethod Export(file As %String, Output numCollections As %Integer, Output numSecrets, collections As %String = "*", secrets As %String = "*") as %Status
Export a set of Collections and Secrets to the given file.
The number of Collections and Secrets exported are returned by numCollections and numSecrets.
collections - comma separated list of collections to export (default is "*" - all).
secrets - comma separated list of secret names to export (default is "*" - all).
This operation requires %Admin_Wallet:USE.
The number of Collections and Secrets exported are returned by numCollections and numSecrets.
collections - comma separated list of collections to export (default is "*" - all).
secrets - comma separated list of secret names to export (default is "*" - all).
This operation requires %Admin_Wallet:USE.
classmethod Import(file As %String, Output numCollections As %Integer, Output numSecrets As %Integer) as %Status
Import a set of Collections and Secrets from the given file.
The number of Collections and Secrets imported are returned by numCollections and numSecrets. This operation requires %Admin_Wallet:USE.
The number of Collections and Secrets imported are returned by numCollections and numSecrets. This operation requires %Admin_Wallet:USE.
Modify an existing collection with the given name.
method ResourceSet(val) as %Status
method UseResourceSet(val) as %Status
Indexes
index (NameIdx on Name) [IdKey, Type = key];
Index methods: NameIdxCheck(), NameIdxDelete(), NameIdxExists(), NameIdxOpen(), NameIdxSQLCheckUnique(), NameIdxSQLExists(), NameIdxSQLFindPKeyByConstraint(), NameIdxSQLFindRowIDByConstraint()
Triggers
trigger OnDelete (BEFORE event DELETE);
Inherited Members
Inherited Methods
- %%CLASSNAMELogicalToStorage()
- %%CLASSNAMEStorageToLogical()
- %AddToSaveSet()
- %AddToSyncSet()
- %BMEBuilt()
- %BuildIndicesAsync()
- %BuildIndicesAsyncResponse()
- %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()
- %InitExtentData()
- %InsertBatch()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %KillExtentData()
- %LoadFromMemory()
- %LockExtent()
- %LockId()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %Oid()
- %OnBeforeAddToSync()
- %OnDeleteFinally()
- %OnDetermineClass()
- %OnOpenFinally()
- %OnSaveFinally()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %PhysicalAddress()
- %PurgeIndices()
- %Reload()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %RollBack()
- %Save()
- %SaveDirect()
- %SaveIndices()
- %SerializeObject()
- %SetModified()
- %SortBegin()
- %SortEnd()
- %SyncObjectIn()
- %SyncTransport()
- %UnlockExtent()
- %UnlockId()
- %ValidateIndices()
- %ValidateObject()
- %ValidateTable()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
Storage
Gray indicates storage defined by superclasses.
Storage Model: Storage (%Wallet.Collection)
^|$$$SecurityMapWallet|WALLET("CollectionD")(ID) |
= | %%CLASSNAME
Name
Version
EditResource
UseResource
|