public class JobManager extends Object
The Job Manager is retrieved for a particular session by calling Session.getJobManager(). The types of jobs supported in the API are: Schedule, Level, Summarize, Apply Actuals, Recalculate Assignment Costs, and Store Period Performance. All jobs are asynchronous, that is, they are submitted and the client code does not wait for them to complete. You can check the status of an asynchronous job initiated by the Integration API by calling getJobStatus().
An internal job type exists that is invoked when setting Project.LinkActualToActualThisPeriod to true, causing all actual-this-period values to be recalculated for the entire project. Although this job is not invoked using the JobManager, its status may be checked using the getCurrentJobs() and getJobStatus() methods. The type of this internal job is JobType.SYNC_ACTUAL_THIS_PERIOD.
Modifier and Type | Method and Description |
---|---|
JobId |
applyActuals(Project project,
Date newDataDate)
Asynchronously applies actuals to a project.
|
JobStatus |
cancelJob(JobId jobId)
Cancels an asynchronous job initiated by the Integration API.
|
JobInfo[] |
getCurrentJobs()
Retrieves job information for current asynchronous jobs of this user.
|
String |
getJobLog(JobId jobId)
Retrieves the log of an asynchronous job initiated by the Integration API.
|
JobStatus |
getJobStatus(JobId jobId)
Retrieves the status of an asynchronous job initiated by the Integration API.
|
JobId |
level(Project project)
Asynchronously levels a project.
|
JobId |
level(Project[] projects)
Asynchronously levels multiple projects.
|
JobId |
recalculateAssignmentCosts(Project[] projects,
boolean syncOTFactor)
Asynchronously recalculates assignment costs for multiple projects if the price per unit
has changed for a resource or role and that assignment has been set to calculate cost from units.
|
JobId |
recalculateAssignmentCosts(Project project,
boolean syncOTFactor)
Asynchronously recalculates assignment costs for a single project if the price per unit
has changed for a resource or role and that assignment has been set to calculate cost from units.
|
JobId |
schedule(Project[] projects,
Date newDataDate)
Asynchronously schedules multiple projects.
|
JobId |
schedule(Project project,
Date newDataDate)
Asynchronously schedules a project.
|
JobId |
scheduleCheck(Project project)
Asynchronously perform check schedule of a project.
|
JobId |
scheduleCheck(Project[] projects)
Asynchronously perform check schedule of multiple projects.
|
JobId |
sendToUnifier(Project project)
Asynchronously sends a project to Unifier.
|
JobId |
sendToUnifier(Project[] projects)
Asynchronously sends multiple projects to Unifier.
|
JobId |
storePeriodPerformance(Project[] projects,
ObjectId finPerObjId)
Asynchronously stores period performance for multiple projects.
|
JobId |
storePeriodPerformance(Project project,
ObjectId finPerObjId)
Asynchronously stores period performance for a single project.
|
JobId |
summarize(EPS eps)
Asynchronously summarizes an EPS node.
|
JobId |
summarize(Project project)
Asynchronously summarizes a project.
|
JobId |
summarizeCBS(Project project)
Asynchronously summarizes a project by cbs.
|
JobId |
updateBaseline(String updateBaselineOptions,
Project p) |
public JobStatus getJobStatus(JobId jobId) throws ServerException, NetworkException
jobId
- the id of the jobServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerIllegalArgumentException
- if the job id parameter is nullpublic String getJobLog(JobId jobId) throws ServerException, NetworkException
jobId
- the id of the jobServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerIllegalArgumentException
- if the job id parameter is nullpublic JobInfo[] getCurrentJobs() throws ServerException, NetworkException
ServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerpublic JobStatus cancelJob(JobId jobId) throws ServerException, NetworkException
jobId
- the id of the jobServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerIllegalArgumentException
- if the job id parameter is nullpublic JobId schedule(Project project, Date newDataDate) throws ServerException, NetworkException, BusinessObjectException
project
- the projectnewDataDate
- the new data dateServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId schedule(Project[] projects, Date newDataDate) throws ServerException, NetworkException, ClientException
projects
- the projectsnewDataDate
- the new data dateServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptypublic JobId applyActuals(Project project, Date newDataDate) throws ServerException, NetworkException, BusinessObjectException
project
- the projectnewDataDate
- the new data dateServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setIllegalArgumentException
- if one of the parameters is nullpublic JobId summarize(Project project) throws ServerException, NetworkException, BusinessObjectException
project
- the projectServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setIllegalArgumentException
- if the project parameter is nullpublic JobId summarize(EPS eps) throws ServerException, NetworkException, BusinessObjectException
eps
- the EPSServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the EPS object's ObjectId field was not loaded or
specifiedIllegalArgumentException
- if the eps parameter is nullpublic JobId storePeriodPerformance(Project project, ObjectId finPerObjId) throws ServerException, NetworkException, BusinessObjectException
project
- the projectfinPerObjId
- the financial periodServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId storePeriodPerformance(Project[] projects, ObjectId finPerObjId) throws ServerException, NetworkException, ClientException
projects
- the projectsfinPerObjId
- the financial periodServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptypublic JobId recalculateAssignmentCosts(Project project, boolean syncOTFactor) throws ServerException, NetworkException, BusinessObjectException
project
- the project to recalculate assignment costssyncOTFactor
- the flag to synchronize the overtime factorServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptyBusinessObjectException
public JobId recalculateAssignmentCosts(Project[] projects, boolean syncOTFactor) throws ServerException, NetworkException, ClientException
projects
- the projectssyncOTFactor
- the flag to synchronize the overtime factorServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptypublic JobId level(Project project) throws ServerException, NetworkException, BusinessObjectException
project
- the projectServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId level(Project[] projects) throws ServerException, NetworkException, ClientException
projects
- the projectsServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptypublic JobId sendToUnifier(Project project) throws ServerException, NetworkException, BusinessObjectException
project
- the projectServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId sendToUnifier(Project[] projects) throws ServerException, NetworkException, ClientException
projects
- the projectsServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptypublic JobId updateBaseline(String updateBaselineOptions, Project p) throws ServerException, NetworkException, BusinessObjectException
public JobId summarizeCBS(Project project) throws ServerException, NetworkException, BusinessObjectException
project
- the projectServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId scheduleCheck(Project project) throws ServerException, NetworkException, BusinessObjectException
project
- the projectServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerBusinessObjectException
- if the project's ObjectId field was not loaded or setpublic JobId scheduleCheck(Project[] projects) throws ServerException, NetworkException, ClientException
projects
- the projectsServerException
- if a problem occurred on the server-sideNetworkException
- if a problem occurred in the network layerClientException
- if the Projects array parameter is emptyCopyright © 2003, 2020, Oracle and/or its affiliates.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.