# Class CIM_ConcreteJob
extends CIM_Job

A concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

CIM_ManagedElement
|
+--CIM_ManagedSystemElement
|
+--CIM_LogicalElement
|
+--CIM_Job
|
+--CIM_ConcreteJob

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | A concrete version of Job. This class represents a generic and instantiable unit of work, such as a batch or a print job.
UMLPackagePath | string | CIM::Core::CoreElements
Version | string | 2.38.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
InstanceID | string |

Description

string

Within the scope of the instantiating Namespace, InstanceID opaquely and uniquely identifies an instance of this class. In order to ensure uniqueness within the NameSpace, the value of InstanceID SHOULD be constructed using the following 'preferred' algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon ':', and where <OrgID> must include a copyrighted, trademarked or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID, or that is a registered ID that is assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness <OrgID> must not contain a colon (':'). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be re-used to identify different underlying (real-world) elements. If the above 'preferred' algorithm is not used, the defining entity must assure that the resulting InstanceID is not re-used across any InstanceIDs produced by this or other providers for the NameSpace of this instance. For DMTF defined instances, the 'preferred' algorithm must be used with the <OrgID> set to 'CIM'.

Key | boolean | true
Override | string | InstanceID
JobInParameters | string |

Description

string

The input (including inout), parameters of the job, formatted as an embedded instance with a class name of "__JobInParameters". In the case where a job represents an intrinsic operation or an extrinsic method call, that embedded instance contains properties representing the input parameters of that call. Each input parameter is mapped to a corresponding property of the same name and type. REF-typed parameters are represented as Reference-qualified properties of type string whose value is the instance path in WBEM URI format. The value of each property shall be the value of the corresponding input parameter at the time the job was started.

EmbeddedObject | boolean | true
JobOutParameters | string |

Description

string

The output (including inout), parameters of the job, formatted as an embedded instance with a class name of "__JobOutParameters". This property shall be NULL unless JobStatus has the value Completed (7). In the case where a job represents an intrinsic operation or an extrinsic method call, that embedded instance contains properties representing the output parameters and return value of that call. Each output parameter is mapped to a corresponding property of the same name and type, and the return value is mapped to a property with the name __ReturnValue of the same type. REF-typed parameters and return values are mapped to Reference-qualified properties of type string whose value is the instance path in WBEM URI format. The value of each such property shall be the value of the corresponding output parameter or return value at the time the job completed.

EmbeddedObject | boolean | true
JobState | uint16 |

Description

string

JobState is an integer enumeration that indicates the operational state of a Job. It can also indicate transitions between these states, for example, 'Shutting Down' and 'Starting'. Following is a brief description of the states: New (2) indicates that the job has never been started. Starting (3) indicates that the job is moving from the 'New', 'Suspended', or 'Service' states into the 'Running' state. Running (4) indicates that the Job is running. Suspended (5) indicates that the Job is stopped, but can be restarted in a seamless manner. Shutting Down (6) indicates that the job is moving to a 'Completed', 'Terminated', or 'Killed' state. Completed (7) indicates that the job has completed normally. Terminated (8) indicates that the job has been stopped by a 'Terminate' state change request. The job and all its underlying processes are ended and can be restarted (this is job-specific) only as a new job. Killed (9) indicates that the job has been stopped by a 'Kill' state change request. Underlying processes might have been left running, and cleanup might be required to free up resources. Exception (10) indicates that the Job is in an abnormal state that might be indicative of an error condition. Actual status might be displayed though job-specific objects. Service (11) indicates that the Job is in a vendor-specific state that supports problem discovery, or resolution, or both. Query pending (12) waiting for a client to resolve a query

ValueMap | string | 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13..32767, 32768..65535
Values | string | New, Starting, Running, Suspended, Shutting Down, Completed, Terminated, Killed, Exception, Service, Query Pending, DMTF Reserved, Vendor Reserved
Name | string |
Description | string | The user-friendly name for this instance of a Job. In addition, the user-friendly name can be used as a property for a search or query. (Note: Name does not have to be unique within a namespace.)
MaxLen | uint32 | 1024
Override | string | Name
Required | boolean | true
TimeBeforeRemoval | datetime | 00000000000500.000000:000
Description | string | The amount of time that the Job is retained after it has finished executing, either succeeding or failing in that execution. The job must remain in existence for some period of time regardless of the value of the DeleteOnCompletion property. The default is five minutes.
Required | boolean | true
Write | boolean | true
TimeOfLastStateChange | datetime |
Description | string | The date or time when the state of the Job last changed. If the state of the Job has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
DeleteOnCompletion | boolean | CIM_Job
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
ElapsedTime | datetime | CIM_Job
ElementName | string | CIM_ManagedElement
ErrorCode | uint16 | CIM_Job
ErrorDescription | string | CIM_Job
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
JobRunTimes | uint32 | CIM_Job
JobStatus | string | CIM_Job
LocalOrUtcTime | uint16 | CIM_Job
Notify | string | CIM_Job
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherRecoveryAction | string | CIM_Job
Owner | string | CIM_Job
PercentComplete | uint16 | CIM_Job
PrimaryStatus | uint16 | CIM_ManagedSystemElement
Priority | uint32 | CIM_Job
RecoveryAction | uint16 | CIM_Job
RunDay | sint8 | CIM_Job
RunDayOfWeek | sint8 | CIM_Job
RunMonth | uint8 | CIM_Job
RunStartInterval | datetime | CIM_Job
ScheduledStartTime | datetime | CIM_Job
StartTime | datetime | CIM_Job
Status | string | CIM_ManagedSystemElement
TimeSubmitted | datetime | CIM_Job
UntilTime | datetime | CIM_Job
OperationalStatus | uint16[] | CIM_ManagedSystemElement
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### RequestStateChange (uint32)

#### Method Qualifiers (RequestStateChange)

Name | Data Type | Value
--- | --- | ---
Description | string | Requests that the state of the job be changed to the value specified in the RequestedState parameter. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. If 0 is returned, then the task completed successfully. Any other return code indicates an error condition.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
Values | string | Completed with No Error, Not Supported, Unknown/Unspecified Error, Can NOT complete within Timeout Period, Failed, Invalid Parameter, In Use, DMTF Reserved, Method Parameters Checked - Transition Started, Invalid State Transition, Use of Timeout Parameter Not Supported, Busy, Method Reserved, Vendor Specific

#### Method Parameters (RequestStateChange)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
RequestedState | uint16

Description

string

RequestStateChange changes the state of a job. The possible values are as follows: Start (2) changes the state to 'Running'. Suspend (3) stops the job temporarily. The intention is to subsequently restart the job with 'Start'. It might be possible to enter the 'Service' state while suspended. (This is job-specific.) Terminate (4) stops the job cleanly, saving data, preserving the state, and shutting down all underlying processes in an orderly manner. Kill (5) terminates the job immediately with no requirement to save data or preserve the state. Service (6) puts the job into a vendor-specific service state. It might be possible to restart the job.

ValueMap | string | 2, 3, 4, 5, 6, 7..32767, 32768..65535
Values | string | Start, Suspend, Terminate, Kill, Service, DMTF Reserved, Vendor Reserved
TimeoutPeriod | datetime

Description

string

A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' must be returned.

#### GetError (uint32)

#### Method Qualifiers (GetError)

Name | Data Type | Value
--- | --- | ---
Deprecated | string | CIM_ConcreteJob.GetErrors
Description | string | GetError is deprecated because Error should be an array,not a scalar. When the job is executing or has terminated without error, then this method returns no CIM_Error instance. However, if the job has failed because of some internal problem or because the job has been terminated by a client, then a CIM_Error instance is returned.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specific

#### Method Parameters (GetError)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Error | string
Description | string | If the OperationalStatus on the Job is not "OK", then this method will return a CIM Error instance. Otherwise, when the Job is "OK", null is returned.
EmbeddedInstance | string | CIM_Error
OUT | boolean | true

#### GetErrors (uint32)

#### Method Qualifiers (GetErrors)

Name | Data Type | Value
--- | --- | ---

Description

string

If JobState is "Completed" and Operational Status is "Completed" then no instance of CIM_Error is returned. If JobState is "Exception" then GetErrors may return intances of CIM_Error related to the execution of the procedure or method invoked by the job. If Operatational Status is not "OK" or "Completed"then GetErrors may return CIM_Error instances related to the running of the job.

ValueMap | string | 0, 1, 2, 3, 4, 5, 6, .., 32768..65535
Values | string | Success, Not Supported, Unspecified Error, Timeout, Failed, Invalid Parameter, Access Denied, DMTF Reserved, Vendor Specific

#### Method Parameters (GetErrors)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Errors | string[]
Description | string | If the OperationalStatus on the Job is not "OK", then this method will return one or more CIM Error instance(s). Otherwise, when the Job is "OK", null is returned.
EmbeddedInstance | string | CIM_Error
OUT | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
KillJob | uint32 | CIM_Job