Primavera Integration API 7.0

com.primavera.integration.common
Class JobInfo

java.lang.Object
  extended by com.primavera.integration.common.JobInfo
All Implemented Interfaces:
java.io.Serializable

public class JobInfo
extends java.lang.Object
implements java.io.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
JobInfo(ObjectId jobId, JobType jobType, JobStatus jobStatus, java.util.Date submittedDate, java.util.Date lastRunDate, ObjectId[] projectObjIds, ObjectId[] epsObjIds)
          Class constructor, to be used internally.
 
Method Summary
 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
 java.util.Date getLastRunDate()
          Gets the date the job was last run
 ObjectId[] getProjectObjectIds()
          Gets the related Project ObjectIds
 java.util.Date getSubmittedDate()
          Gets the date the job was submitted
 
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,
               java.util.Date submittedDate,
               java.util.Date lastRunDate,
               ObjectId[] projectObjIds,
               ObjectId[] epsObjIds)
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 java.util.Date getSubmittedDate()
Gets the date the job was submitted

Returns:
java.util.Date the date the job was submitted

getLastRunDate

public java.util.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

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.