Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [EnsLib] >  [Workflow] >  [RoleMembership]
Private  Storage   

persistent class EnsLib.Workflow.RoleMembership extends %Persistent, %XML.Adaptor

Manages the many-to-many relationship of workflow Users and Roles. Each instance represents the association of a specific User with a specific Role.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 4 1 2


Summary

Properties
Ranking Role Title User

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


Parameters

• parameter XMLNAME = "member";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property Ranking as %Integer(MINVAL=1,XMLNAME="ranking",XMLPROJECTION="attribute");
Defines a ranking value (1 is highest ranking) for members of a Role. The Workflow Engine uses this value to help with task distribution.
• property Role as RoleDefinition(XMLNAME="roleName",XMLPROJECTION="attribute",XMLREFERENCE="ID") [ SqlFieldName = RoleName ];
Role involved in the relationship.
• property Title as %String(MAXLEN=128,XMLNAME="title",XMLPROJECTION="attribute");
(Optional) Defines a title for a given user within a role.
For example, a role member could be designated as the "Manager" of the role. A Workflow can make use of this designation when distributing tasks.
• property User as UserDefinition(XMLNAME="userName",XMLPROJECTION="attribute",XMLREFERENCE="ID") [ SqlFieldName = UserName ];
User that belongs to the associated Role.

Indices

•index (ID on Role,User) [IdKey];

ForeignKeys

•foreignkey RoleKey (Role) references EnsLib.Workflow.RoleDefinition (ID) OnDelete: cascade; OnUpdate: noaction
•foreignkey UserKey (User) references EnsLib.Workflow.UserDefinition (ID) OnDelete: cascade; OnUpdate: noaction


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