com.primavera.integration.common

Class JobInfo

java.lang.Object

com.primavera.integration.common.JobInfo

All Implemented Interfaces:

Serializable

public class JobInfo
extends Object
implements Serializable

Information for a server-side asynchronous job. This is used for scheduling, applying actuals, storing period performance, and summarizing projects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobInfo(ObjectId jobId, JobType jobType, JobStatus jobStatus, Date submittedDate, Date lastRunDate, ObjectId[] projectObjIds, ObjectId[] epsObjIds, String workerHost) Class constructor, to be used internally.

Method Summary

Modifier and Type	Method and Description
ObjectId[]	getEPSObjectIds() Gets the related EPS ObjectIds which apply to the job type 'Summarize' only.
JobId	getJobId() Gets the unique ID of the job
JobStatus	getJobStatus() Gets the status of the job.
JobType	getJobType() Gets the type of the job
Date	getLastRunDate() Gets the date the job was last run
ObjectId[]	getProjectObjectIds() Gets the related Project ObjectIds
Date	getSubmittedDate() Gets the date the job was submitted
String	getWorkerHost() Gets the host machine name that ran this job

Methods inherited from class java.lang.Object

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

Constructor Detail

JobInfo

public JobInfo(ObjectId jobId,
               JobType jobType,
               JobStatus jobStatus,
               Date submittedDate,
               Date lastRunDate,
               ObjectId[] projectObjIds,
               ObjectId[] epsObjIds,
               String workerHost)

Class constructor, to be used internally. Client code should have no reason to create instances of this class.

Parameters:

jobId - the id of the job

jobType - the tyupe of the job

jobStatus - the status of the job

submittedDate - the date the job was submitted

lastRunDate - the date the job was last run

projectObjIds - the projects on which to run the job

epsObjIds - the EPS nodes onwhich to run the job

Method Detail

getJobId

public JobId getJobId()

Gets the unique ID of the job

Returns:

JobId the ID of the job

getJobType

public JobType getJobType()

Gets the type of the job

Returns:

JobType the job type

getJobStatus

public JobStatus getJobStatus()

Gets the status of the job. This is useful for determining if the job has been serviced yet and if it was successful.

Returns:

JobStatus the status of the job

getSubmittedDate

public Date getSubmittedDate()

Gets the date the job was submitted

Returns:

java.util.Date the date the job was submitted

getLastRunDate

public Date getLastRunDate()

Gets the date the job was last run

Returns:

java.util.Date the date the job was last run

getProjectObjectIds

public ObjectId[] getProjectObjectIds()

Gets the related Project ObjectIds

Returns:

the related Project ObjectIds

getEPSObjectIds

public ObjectId[] getEPSObjectIds()

Gets the related EPS ObjectIds which apply to the job type 'Summarize' only.

Returns:

the related EPS ObjectIds

getWorkerHost

public String getWorkerHost()

Gets the host machine name that ran this job

Returns:

the WorkerHost