Managed Object - ScheduledTask

Property of
EventFilterSpec, ScheduledTaskEventArgument, ScheduledTaskInfo, ScheduledTaskManager, TaskFilterSpec, TaskReasonSchedule
Returned by
CreateScheduledTask, RetrieveEntityScheduledTask
See also
ScheduledTaskInfo, ScheduledTaskSpec

Managed Object Description

The scheduled task object.

Properties

Name Type Description
infoScheduledTaskInfo Information about the current scheduled task.

Methods

Methods defined in this Managed Object
ReconfigureScheduledTask, RemoveScheduledTask, RunScheduledTask

ReconfigureScheduledTask

Reconfigures the scheduled task properties.
Required Privileges
ScheduledTask.Edit

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTask used to make the method call.
specScheduledTaskSpec The new specification for the scheduled task.

Return Value

Type Description
None

Faults

Type Description
DuplicateNameThrown if a scheduled task with the name already exists.
InvalidArgumentThrown if the specification is invalid.
InvalidNameThrown if the scheduled task name is empty or too long.
InvalidStateThrown if the scheduled task is running.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RemoveScheduledTask

Removes the scheduled task.
Required Privileges
ScheduledTask.Delete

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTask used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidStateThrown if the scheduled task is running.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RunScheduledTask

Runs the scheduled task immediately. The schedule for future runs remains in effect.
Required Privileges
ScheduledTask.Run

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTask used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidStateThrown if the scheduled task is running already.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition