Class Hierarchy
Class Attributes
Class Qualifiers
Properties
Methods
Associations in which the class can participate
Sub Profiling Summary
CIM_UnitOfWork --> CIM_ManagedElement --> [top]
Class Declaration Attributes Name Value SUPERCLASS CIM_ManagedElement NAME CIM_UnitOfWork
Class CIM_UnitOfWork Qualifiers Name Type Value From Class Version string 2.7.0 CIM_UnitOfWork Description string Each instance of UnitOfWork identifies a transaction that is either in-process or already completed. Because instances of ’ in-process ’ UnitsOfWork can be very short-lived and there can be a great number of active ones, use of this class as an instrumentation source for determining response time may be incorrect or inefficient, unless the rate and duration of the UnitsOfWork are known. The intended use is to respond to queries about currently active or recently completed UnitsOfWork. The length of time that a UnitOfWork instance exists after the UnitOfWork completes is not defined and should be assumed to be implementation-dependent. This class is weak to its definition (CIM_UnitOfWorkDefintion). CIM_UnitOfWork Description string ManagedElement is an abstract class that provides a common superclass (or top of the inheritance tree) for the non-association classes in the CIM Schema. CIM_ManagedElement
Properties Name Type Value Qualifiers ClassOrigin Description string Override
DescriptionCIM_UnitOfWork Id sint64 Key
DescriptionCIM_UnitOfWork UoWDefId string Key
Propagated
Description
MaxLenCIM_UnitOfWork UserName string Description CIM_UnitOfWork StartTime datetime Description CIM_UnitOfWork ElapsedTime datetime Description CIM_UnitOfWork Status uint16 Description
ValueMap
ValuesCIM_UnitOfWork TraceLevel uint32 Description CIM_UnitOfWork MutualContextId string Description CIM_UnitOfWork Caption string Description
MaxLenCIM_ManagedElement ElementName string Description CIM_ManagedElement Property Qualifiers
Property Description Qualifiers Name Type Value From Class Override string Description CIM_UnitOfWork Description string Since UnitOfWork is designed to be an extremely lightweight object, it is recommended that this property not be used. The Description specified for the instance ’ s associated CIM_UnitOfWorkDefintion should apply. CIM_UnitOfWork
Property Id Qualifiers Name Type Value From Class Key boolean true CIM_UnitOfWork Description string The identifier of the UnitOfWork, within the context of the UnitOfWorkDefinition. CIM_UnitOfWork
Property UoWDefId Qualifiers Name Type Value From Class Key boolean true CIM_UnitOfWork Propagated string CIM_UnitOfWorkDefinition.Id CIM_UnitOfWork Description string A 16 byte value that uniquely identifies the UnitOfWork Definition. The use of OSF UUID/GUIDs is recommended. CIM_UnitOfWork MaxLen uint32 16 CIM_UnitOfWork
Property UserName Qualifiers Name Type Value From Class Description string The name of the user who initiated the UnitOfWork. This may be a real user ’ s login name or a logical name representing an application. CIM_UnitOfWork
Property StartTime Qualifiers Name Type Value From Class Description string The time that the UnitOfWork was started. CIM_UnitOfWork
Property ElapsedTime Qualifiers Name Type Value From Class Description string The elapsed time since the UnitOfWork was started. Upon completion of the UnitOfWork, this property contains the total amount of time taken in processing the entire UnitOfWork. CIM_UnitOfWork
Property Status Qualifiers Name Type Value From Class Description string An enumeration identifing the status of the UnitOfWork. Most of the property values are self-explanatory, but a few need additional text: 3= " Completed " - Should be used to represent a ’ completed ’ transaction whose status ( ’ good ’ , ’ failed ’ or ’ aborted ’ ) is unknown. 6= " Completed Aborted " - Should be used when a UnitOfWork has completed but was not allowed to end normally. An example would be when the Stop or Back buttons are selected from a web browser, before a page is fully loaded. CIM_UnitOfWork ValueMap string [See below.] CIM_UnitOfWork Values string Active
Suspended
Completed
Completed Good
Completed Failed
Completed AbortedCIM_UnitOfWork
Name Value 1 Active 2 Suspended 3 Completed 4 Completed Good 5 Completed Failed 6 Completed Aborted
Property TraceLevel Qualifiers Name Type Value From Class Description string Indicates the granularity at which traces are written for this particular instance of UnitOfWork. Traces allow providing more detailed information on the course of the execution of the UnitOfWork than just the status and the elapsed time. The trace level does not indicate where the traces are found (i.e. in which file or CIM instances). TraceLevel cannot be set (i.e. written) since an instance of UnitOfWork only publishes information. So, the application code that executes the unit of work must receive the desired trace level by its caller (e.g. the parent module, the user or some remote system that initiates the unit of work). If its value is 0, no traces are available. If its value is > 0, traces are available. Except 0, the possible values and their semantics are implementation dependent. Two instances of UnitOfWork (even with the same definition) may have different trace levels since the desired or required granularity of traces may be dependent on the execution context (detection of an error, analysis of an error, etc.) of the unit of work. The trace level can be encoded as a bit map (each individual bit indicates a certain trace type and/or level of detail) or numbers (that are further defined by a value map). No encoding scheme is imposed since no general rules or standards exist and in consequence, application developers could reuse their existing trace level scheme. CIM_UnitOfWork
Property MutualContextId Qualifiers Name Type Value From Class Description string A string that uniquely identifies the mutual context of UnitOfWork instances. The context is defined as an individual action that several UnitOfWork instances participate in. The use of Ids such as OSF UUID/GUIDs is recommended, although some implementations may require longer Ids. (This is the reason why no maxlen(16) qualifier has been used.) MutualContextId explicitly identifies the context for instances of UnitOfWork, that is otherwise provided implicitly by SubUoW association instances. In addition, one can query directly (i.e. without following the associations) for UnitOfWork instances that participate in some individual action (i.e., the mutual context). If no mutual context is needed or if it is not supported by the implementation, the value is NULL. Note that the MutualContextId value is to be transferred internally between the participating UnitOfWork implementations such that each UnitOfWork instance implementation receives its value from its predecessor/parent or initially creates the value if it is the first instance of the context. CIM_UnitOfWork
Property Caption Qualifiers Name Type Value From Class Description string The Caption property is a short textual description (one- line string) of the object. CIM_ManagedElement MaxLen uint32 64 CIM_ManagedElement
Property Description Qualifiers Name Type Value From Class Description string The Description property provides a textual description of the object. CIM_ManagedElement
Property ElementName Qualifiers Name Type Value From Class Description string A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. CIM_ManagedElement
Method Qualifiers
Parameters
Parameter Qualifiers