com.bmc.cmdb.api
Class CMDBREJobRunInfo

java.lang.Object
  com.bmc.cmdb.api.CMDBREJobRunInfo

public class CMDBREJobRunInfo
extends java.lang.Object

The CMDBREJobRunInfo class allows you to define information about a currently running Reconciliation Engine job.

Field Summary

static int	CMDBRE_JOB_RUN_STATUS_ABORTED Specifies that the Reconciliation Engine job is aborted.
static int	CMDBRE_JOB_RUN_STATUS_CANCELED Specifies that the Reconciliation Engine job is canceled.
static int	CMDBRE_JOB_RUN_STATUS_FAILED Specifies that the Reconciliation Engine job failed.
static int	CMDBRE_JOB_RUN_STATUS_PAUSED Specifies that the Reconciliation Engine job is paused.
static int	CMDBRE_JOB_RUN_STATUS_QUEUED Specifies that the Reconciliation Engine job is in a queue.
static int	CMDBRE_JOB_RUN_STATUS_STARTED Specifies that the Reconciliation Engine job is started.
static int	CMDBRE_JOB_RUN_STATUS_SUCCESS Specifies that the Reconciliation Engine job successfully completed.
static int	CMDBRE_JOB_RUN_STATUS_UNKNOWN Specifies that the status of the Reconciliation Engine job is unknown.

Constructor Summary

CMDBREJobRunInfo()
Default constructor that creates an empty CMDBREJobRunInfo object.

CMDBREJobRunInfo(java.lang.String aJobRunId, java.lang.String aJobName, java.lang.String aJobInstanceId, long aStartTime, long aEndTime, int aJobRunStatus)
/** Constructs a CMDBREJobRunInfo object using the specified job run ID, name, instance ID, start time, end time, and status.

Method Summary

static CMDBREJobRunInfo	CMDBREGetJobRun(ARServerUser context, java.lang.String jobRunId) Gets the job run information and the job log for the Reconciliation Engine job.
static CMDBREJobRunInfo[]	CMDBREGetListJobRun(ARServerUser context, QualifierInfo qualifierInfo, java.lang.Integer numMatch) Gets a list of Reconciliation Engine jobs that match the specified query information, including information related to the jobs but not the job log information.
static CMDBREJobRunInfo[]	CMDBREGetListJobRun(ARServerUser context, java.lang.String qualification, java.lang.Integer numMatch) Gets a list of Reconciliation Engine jobs that match the specified query string, including information related to the jobs but not the job log information.
Timestamp	getEndTime() Gets the end time of the Reconciliation Engine job.
java.lang.String	getJobInstanceId() Gets the instance ID of the Reconciliation Engine job.
java.lang.String	getJobLog() Gets the log information for the Reconciliation Engine job.
java.lang.String	getJobLog(ARServerUser context) Gets the log information for the Reconciliation Engine job using the specified context.
java.lang.String	getJobName() Gets the name of the Reconciliation Engine job.
java.lang.String	getJobRunId() Gets the job ID of the Reconciliation Engine job.
int	getJobRunStatus() Gets the status of the Reconciliation Engine job.
Timestamp	getStartTime() Gets the start time of the Reconciliation Engine job.
void	setEndTime(long aEndTime) Sets the end time for the Reconciliation Engine job.
void	setJobInstanceId(java.lang.String aJobInstanceId) Sets the instance ID for the Reconciliation Engine job.
void	setJobLog(java.lang.String aJobLog) Sets the job log for the Reconciliation Engine job.
void	setJobName(java.lang.String aJobName) Sets the job name for the Reconciliation Engine job.
void	setJobRunId(java.lang.String aJobRunId) Sets the job run ID for the Reconciliation Engine job.
void	setJobRunStatus(int aJobRunStatus) Sets the job status for the Reconciliation Engine job.
void	setStartTime(long aStartTime) Sets the start time for the Reconciliation Engine job.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CMDBRE_JOB_RUN_STATUS_STARTED

public static final int CMDBRE_JOB_RUN_STATUS_STARTED

Specifies that the Reconciliation Engine job is started.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_SUCCESS

public static final int CMDBRE_JOB_RUN_STATUS_SUCCESS

Specifies that the Reconciliation Engine job successfully completed.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_FAILED

public static final int CMDBRE_JOB_RUN_STATUS_FAILED

Specifies that the Reconciliation Engine job failed.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_CANCELED

public static final int CMDBRE_JOB_RUN_STATUS_CANCELED

Specifies that the Reconciliation Engine job is canceled.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_ABORTED

public static final int CMDBRE_JOB_RUN_STATUS_ABORTED

Specifies that the Reconciliation Engine job is aborted.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_QUEUED

public static final int CMDBRE_JOB_RUN_STATUS_QUEUED

Specifies that the Reconciliation Engine job is in a queue.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_PAUSED

public static final int CMDBRE_JOB_RUN_STATUS_PAUSED

Specifies that the Reconciliation Engine job is paused.

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_UNKNOWN

public static final int CMDBRE_JOB_RUN_STATUS_UNKNOWN

Specifies that the status of the Reconciliation Engine job is unknown.

See Also:

Constant Field Values

Constructor Detail

CMDBREJobRunInfo

public CMDBREJobRunInfo()

Default constructor that creates an empty CMDBREJobRunInfo object.

CMDBREJobRunInfo

public CMDBREJobRunInfo(java.lang.String aJobRunId,
                        java.lang.String aJobName,
                        java.lang.String aJobInstanceId,
                        long aStartTime,
                        long aEndTime,
                        int aJobRunStatus)

/** Constructs a CMDBREJobRunInfo object using the specified job run ID, name, instance ID, start time, end time, and status.

Parameters:

aJobRunId - job ID of the Reconciliation Engine job

aJobName - name of the Reconciliation Engine job

aJobInstanceId - instance ID of the Reconciliation Engine job

aStartTime - start time of the Reconciliation Engine job

aEndTime - end time of the Reconciliation Engine job

aJobRunStatus - status of the Reconciliation Engine job

Method Detail

getJobRunId

public java.lang.String getJobRunId()

Gets the job ID of the Reconciliation Engine job.

Returns:

the job ID of the Reconciliation Engine job.

getJobName

public java.lang.String getJobName()

Gets the name of the Reconciliation Engine job.

Returns:

the name of the Reconciliation Engine job

getJobInstanceId

public java.lang.String getJobInstanceId()

Gets the instance ID of the Reconciliation Engine job.

Returns:

the instance Id of the Reconciliation Engine job

getStartTime

public Timestamp getStartTime()

Gets the start time of the Reconciliation Engine job.

Returns:

the start time of the Reconciliation Engine job.

getEndTime

public Timestamp getEndTime()

Gets the end time of the Reconciliation Engine job.

Returns:

the end time of the Reconciliation Engine job

getJobRunStatus

public int getJobRunStatus()

Gets the status of the Reconciliation Engine job.

Returns:

the status of the Reconciliation Engine job

getJobLog

public java.lang.String getJobLog()

Gets the log information for the Reconciliation Engine job.

Returns:

the log information for the Reconciliation Engine job

getJobLog

public java.lang.String getJobLog(ARServerUser context)

Gets the log information for the Reconciliation Engine job using the specified context.

Parameters:

context - the AR Server User object return the Job Log for the JobRunInfo object

setJobRunId

public void setJobRunId(java.lang.String aJobRunId)

Sets the job run ID for the Reconciliation Engine job.

Parameters:

aJobRunId - the job run ID of the Reconciliation Engine job

Throws:

java.lang.IllegalArgumentException - if aJobRunId is empty

setJobName

public void setJobName(java.lang.String aJobName)

Sets the job name for the Reconciliation Engine job.

Parameters:

aJobName - the job name for the Reconciliation Engine job

Throws:

java.lang.IllegalArgumentException - if aJobName is empty

setJobInstanceId

public void setJobInstanceId(java.lang.String aJobInstanceId)

Sets the instance ID for the Reconciliation Engine job.

Parameters:

aJobInstanceId - the instance ID for the Reconciliation Engine job

Throws:

java.lang.IllegalArgumentException - if aJobInstanceId is empty

setStartTime

public void setStartTime(long aStartTime)

Sets the start time for the Reconciliation Engine job.

Parameters:

aStartTime - the start time for the Reconciliation Engine job

setEndTime

public void setEndTime(long aEndTime)

Sets the end time for the Reconciliation Engine job.

Parameters:

aEndTime - the end time for the Reconciliation Engine job

setJobRunStatus

public void setJobRunStatus(int aJobRunStatus)

Sets the job status for the Reconciliation Engine job.

Parameters:

aJobRunStatus - for the Reconciliation Engine job

setJobLog

public void setJobLog(java.lang.String aJobLog)

Sets the job log for the Reconciliation Engine job.

Parameters:

aJobLog - the job log for the Reconciliation Engine job

Throws:

java.lang.IllegalArgumentException - if aJobLog

CMDBREGetJobRun

public static CMDBREJobRunInfo CMDBREGetJobRun(ARServerUser context,
                                               java.lang.String jobRunId)
                                        throws ARException

Gets the job run information and the job log for the Reconciliation Engine job.

Parameters:

context - AR System user and host infomation

jobRunId - Job Id for the Reconciliation Engine job

Returns:

CMDBREGetJobRunInfo object which contains Reconciliation Engine job info and job log

Throws:

ARException - if Version Information cannot be retrieved

CMDBREGetListJobRun

public static CMDBREJobRunInfo[] CMDBREGetListJobRun(ARServerUser context,
                                                     java.lang.String qualification,
                                                     java.lang.Integer numMatch)
                                              throws ARException

Gets a list of Reconciliation Engine jobs that match the specified query string, including information related to the jobs but not the job log information.

Parameters:

context - AR System user and host information

qualification - qualifier string

numMatch - number of matches

Returns:

CMDBREGetJobRunInfo[] Returns Object Array which contains job information without JobLog

Throws:

ARException - if Version Information cannot be retrieved

CMDBREGetListJobRun

public static CMDBREJobRunInfo[] CMDBREGetListJobRun(ARServerUser context,
                                                     QualifierInfo qualifierInfo,
                                                     java.lang.Integer numMatch)
                                              throws ARException

Gets a list of Reconciliation Engine jobs that match the specified query information, including information related to the jobs but not the job log information.

Parameters:

context - AR System user and host infomation

qualifierInfo - AR Qualification Struct

numMatch - Number of Matches

Returns:

CMDBREGetJobRunInfo[] Returns Object Array which contains Job Info without JobLog

Throws:

ARException - if Version Information cannot be retrieved