com.remedy.cmdb.api
Class CMDBREJobRunInfo

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

public class CMDBREJobRunInfo

extends java.lang.Object

The CMDBREJobRunInfo class defines an JobRunInfo

Field Summary

static int	CMDBRE_JOB_RUN_STATUS_ABORTED Job Aborted
static int	CMDBRE_JOB_RUN_STATUS_CANCELED Job Canceled
static int	CMDBRE_JOB_RUN_STATUS_FAILED Job Failed
static int	CMDBRE_JOB_RUN_STATUS_PAUSED Job is Paused
static int	CMDBRE_JOB_RUN_STATUS_QUEUED Job is Queued
static int	CMDBRE_JOB_RUN_STATUS_STARTED Job Started
static int	CMDBRE_JOB_RUN_STATUS_SUCCESS Job Successfully completed
static int	CMDBRE_JOB_RUN_STATUS_UNKNOWN Job status is not unknown

Constructor Summary

CMDBREJobRunInfo()
Constructs a JobRunInfo

CMDBREJobRunInfo(java.lang.String aJobRunId, java.lang.String aJobName, java.lang.String aJobInstanceId, long aStartTime, long aEndTime, int aJobRunStatus)
/** Constructs a Job Run Info.

Method Summary

static CMDBREJobRunInfo	CMDBREGetJobRun(ARServerUser context, java.lang.String jobRunId) Gets Job Run Information along with JobLog
static CMDBREJobRunInfo[]	CMDBREGetListJobRun(ARServerUser context, QualifierInfo qualifierInfo, java.lang.Integer numMatch) Gets List of Job Run Information
static CMDBREJobRunInfo[]	CMDBREGetListJobRun(ARServerUser context, java.lang.String qualification, java.lang.Integer numMatch) Gets List of Job Run Information without JobLog
Timestamp	getEndTime() Gets the Job End Time of the JobRunInfo object.
java.lang.String	getJobInstanceId() Gets the Job Instance Id of the JobRunInfo object.
java.lang.String	getJobLog() Gets the Job Log of the JobRunInfo object.
java.lang.String	getJobLog(ARServerUser context) Gets the Job Log of the JobRunInfo object
java.lang.String	getJobName() Gets the Job Name of the JobRunInfo object.
java.lang.String	getJobRunId() Gets the Job Run Id of the JobRunInfo object.
int	getJobRunStatus() Gets the status of the given job of JobRunInfo Object.
Timestamp	getStartTime() Gets the Job Start Time of the JobRunInfo object.
void	setEndTime(long aEndTime) Sets the End Time of the JobRunInfo object.
void	setJobInstanceId(java.lang.String aJobInstanceId) Sets the Job Instance Id of the JobRunInfo object.
void	setJobLog(java.lang.String aJobLog) Sets the JobLog of the JobRunInfo object.
void	setJobName(java.lang.String aJobName) Sets the Job Name of the JobRunInfo object.
void	setJobRunId(java.lang.String aJobRunId) Sets the Job Run Id of the JobRunInfo object.
void	setJobRunStatus(int aJobRunStatus) Sets the job status of given job for JobRunInfo Object.
void	setStartTime(long aStartTime) Sets the Start Time of the JobRunInfo object.

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

Job Started

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_SUCCESS

public static final int CMDBRE_JOB_RUN_STATUS_SUCCESS

Job Successfully completed

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_FAILED

public static final int CMDBRE_JOB_RUN_STATUS_FAILED

Job Failed

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_CANCELED

public static final int CMDBRE_JOB_RUN_STATUS_CANCELED

Job Canceled

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_ABORTED

public static final int CMDBRE_JOB_RUN_STATUS_ABORTED

Job Aborted

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_QUEUED

public static final int CMDBRE_JOB_RUN_STATUS_QUEUED

Job is Queued

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_PAUSED

public static final int CMDBRE_JOB_RUN_STATUS_PAUSED

Job is Paused

See Also:

Constant Field Values

CMDBRE_JOB_RUN_STATUS_UNKNOWN

public static final int CMDBRE_JOB_RUN_STATUS_UNKNOWN

Job status is not unknown

See Also:

Constant Field Values

Constructor Detail

CMDBREJobRunInfo

public CMDBREJobRunInfo()

Constructs a JobRunInfo

CMDBREJobRunInfo

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

/** Constructs a Job Run Info.

Parameters:

aJobRunId - is the JobId of the JobRunInfo

aJobName - is the Job Name of the JobRunInfo

aJobInstanceId - is the Job Instance of the JobRunInfo

aStartTime - is the Job Start Time of the JobRunInfo

aEndTime - is the Job End Time of the JobRunInfo

aJobRunStatus - is the Job status of the JobRunInfo

Method Detail

getJobRunId

public java.lang.String getJobRunId()

Gets the Job Run Id of the JobRunInfo object.

Returns:

the Job Run Id for the JobRunInfo object

getJobName

public java.lang.String getJobName()

Gets the Job Name of the JobRunInfo object.

Returns:

the Job Name for the JobRunInfo object

getJobInstanceId

public java.lang.String getJobInstanceId()

Gets the Job Instance Id of the JobRunInfo object.

Returns:

the Job Instance Id for the JobRunInfo object

getStartTime

public Timestamp getStartTime()

Gets the Job Start Time of the JobRunInfo object.

Returns:

the Job Start Time for the JobRunInfo object

getEndTime

public Timestamp getEndTime()

Gets the Job End Time of the JobRunInfo object.

Returns:

the Job End Time for the JobRunInfo object

getJobRunStatus

public int getJobRunStatus()

Gets the status of the given job of JobRunInfo Object.

Returns:

the Job run status

getJobLog

public java.lang.String getJobLog()

Gets the Job Log of the JobRunInfo object.

Returns:

the Job Log for the JobRunInfo object

getJobLog

public java.lang.String getJobLog(ARServerUser context)

Gets the Job Log of the JobRunInfo object

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 of the JobRunInfo object.

Parameters:

aJobRunId - the Job Run Id of JobRunInfo object

Throws:

java.lang.IllegalArgumentException - if aJobRunId is empty

setJobName

public void setJobName(java.lang.String aJobName)

Sets the Job Name of the JobRunInfo object.

Parameters:

aJobName - the Job Name of JobRunInfo object

Throws:

java.lang.IllegalArgumentException - if aJobName is empty

setJobInstanceId

public void setJobInstanceId(java.lang.String aJobInstanceId)

Sets the Job Instance Id of the JobRunInfo object.

Parameters:

aJobInstanceId - the Job Instance Id of JobRunInfo object

Throws:

java.lang.IllegalArgumentException - if aJobInstanceId is empty

setStartTime

public void setStartTime(long aStartTime)

Sets the Start Time of the JobRunInfo object.

Parameters:

aStartTime - the Start Time of JobRunInfo object

setEndTime

public void setEndTime(long aEndTime)

Sets the End Time of the JobRunInfo object.

Parameters:

aEndTime - the End Time of JobRunInfo object

setJobRunStatus

public void setJobRunStatus(int aJobRunStatus)

Sets the job status of given job for JobRunInfo Object.

Parameters:

aJobRunStatus - is the job status for JobRunInfo Object.

setJobLog

public void setJobLog(java.lang.String aJobLog)

Sets the JobLog of the JobRunInfo object.

Parameters:

aJobLog - the Job Log of JobRunInfo object

Throws:

java.lang.IllegalArgumentException - if aJobLog

CMDBREGetJobRun

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

Gets Job Run Information along with JobLog

Parameters:

context - AR System user and host infomation

jobRunId - Job Id

Returns:

CMDBREGetJobRunInfo Returns Object which contains Job Info & 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 List of Job Run Information without JobLog

Parameters:

context - AR System user and host infomation

qualification - AR Qualification String

numMatch - Number of Matches

Returns:

CMDBREGetJobRunInfo[] Returns Object Array which contains Job Info 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 List of Job Run 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