com.plumtree.server
Interface IPTScheduledOperation


public interface IPTScheduledOperation

IPTScheduledOperation is the internal interface used to run job operations. A job consists of a list of these operations and will run them in serial. A well-known list of objects that implement this interface is returned through a call to IPTSession.OpenGlobalObject( PT_GLOBALOBJECTS.PT_GLOBAL_SCHEDULED_AGENTS ). This API is provided to the Automation Server to call into the agent code. Customers should avoid using this interface directly as it will not be supported going forward. The one method that can be used outside the Automation Server context is ScheduleImmediateJob().

Version:
$Revision: #1 $
Author:
MichaelY
See Also:
IPTJob, IPTScheduler

Method Summary
 com.plumtree.openfoundation.util.IXPPropertyBag PerformOperationEx(java.lang.String bstrOperationUUID, IPTSession pSession)
          Deprecated. This method should not be implemented.
 int ScheduleImmediateJob()
          Called by applications to create a new job that should run immediately on the next available Automation Server running jobs stored in the intrinsic admin folder, whose folder id is well-known as PT_ADMIN_FOLDER_INTRINSICOPS.
 

Method Detail

ScheduleImmediateJob

int ScheduleImmediateJob()
Called by applications to create a new job that should run immediately on the next available Automation Server running jobs stored in the intrinsic admin folder, whose folder id is well-known as PT_ADMIN_FOLDER_INTRINSICOPS.

Note that the user must have activity rights to schedule jobs. Otherwise, -1 will be returned.

Returns:
the newly created job object id or -1 if a failure occurs

PerformOperationEx

com.plumtree.openfoundation.util.IXPPropertyBag PerformOperationEx(java.lang.String bstrOperationUUID,
                                                                   IPTSession pSession)
Deprecated. This method should not be implemented.