com.plumtree.remote.prc
Interface IJobManager

All Superinterfaces:

IObjectManager

public interface IJobManager

extends IObjectManager

Interface that allows remote services to start Portal Jobs.

Method Summary

IJobProperties	queryJobProperties(int JobId) Queries and gets the properties of a given Job.
int	startJob(int jobID) Starts a portal job.

Methods inherited from interface com.plumtree.remote.prc.IObjectManager

lookupObjectID, lookupUUID, queryACL, queryCommunitiesForPortlet, queryExtendedData, queryObjects, queryObjects, queryObjects, queryObjects, queryObjects, querySingleObject, updateACL

Method Detail

startJob

public int startJob(int jobID)

Starts a portal job. The job start time will be set to the current (SOAP) server time. If the time could not be set the reason can be determined from the return code as a com.plumtree.remote.prc.LockStatus.

LockStatus.UNLOCKED this is 0 and indicates success.
LockStatus.LOCKED indicates that the job is currently locked and cannot be edited.
Other LockStatus's should not occur.

Parameters:

jobID - the ID of the job to start

Returns:

0 if sucessful, otherwise a LockStatus indicating why the job could not be started

queryJobProperties

public IJobProperties queryJobProperties(int JobId)

Queries and gets the properties of a given Job. IDocumentProperties returned by this method contains list of JobProperty values.

Parameters:

JobId - is the ID for the Job to query

Returns:

IJobProperties for given Job containing Name, Description, Created, LastModified, LastRuntime, NextRuntime and Status.

Throws:

java.lang.IllegalArgumentException - if JobId is <= 0.

PortalException - if the operation resulted in an error on the portal

RemoteException - if there was a communication problem during the execution of the remote method call