Package com.microstrategy.web.objects.admin.monitors

Interface JobManipulator

All Superinterfaces:

MonitorManipulator

public interface JobManipulator
extends MonitorManipulator

The interface JobManipulator contains operations to kill jobs.

Since:

MicroStrategy Web 9.0.0

Method Summary

Modifier and Type	Method	Description
void	addDeletionTask(int jobID)	Adds a job ID to the deletion task list for batch operation.
void	addDeletionTask(int[] jobIDs)	Adds an array of jobID to the deletion task list for batch operation.
void	kill(int jobID)	Kills a job with the specified job ID.
void	kill(int[] jobIDs)	Kills an array of jobs.
void	kill(int[] jobIDs, java.lang.String nodeName)	Kills an array of jobs.
void	kill(int jobID, java.lang.String nodeName)	Kills a job with the specified job ID.

Methods inherited from interface com.microstrategy.web.objects.admin.monitors.MonitorManipulator

clear, submit

Method Detail

kill

void kill(int jobID)
   throws MonitorManipulationException,
          WebObjectsAdminException

Kills a job with the specified job ID.

Parameters:

jobID - a job ID.

Throws:

MonitorManipulationException - thrown if there is any failure in killing jobs.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

kill

void kill(int jobID,
          java.lang.String nodeName)
   throws MonitorManipulationException,
          WebObjectsAdminException

Kills a job with the specified job ID.

Parameters:

jobID - a job ID.

nodeName - the server node you want to connect refer to IDSSXMLClusterNode mNodeName, serverReportedNodeName are both OK

Throws:

MonitorManipulationException - thrown if there is any failure in killing jobs.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

kill

void kill(int[] jobIDs)
   throws MonitorManipulationException,
          WebObjectsAdminException

Kills an array of jobs.

Parameters:

jobIDs - an array of job ID.

Throws:

MonitorManipulationException - thrown if there is any failure in killing jobs.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

kill

void kill(int[] jobIDs,
          java.lang.String nodeName)
   throws MonitorManipulationException,
          WebObjectsAdminException

Kills an array of jobs.

Parameters:

jobIDs - an array of job ID.

nodeName - the server node you want to connect refer to IDSSXMLClusterNode mNodeName, serverReportedNodeName are both OK

Throws:

MonitorManipulationException - thrown if there is any failure in killing jobs.

WebObjectsAdminException - throwns if there is any fatal error preventing this operation, such as network error, server crash, etc.

addDeletionTask

void addDeletionTask(int jobID)

Adds a job ID to the deletion task list for batch operation.

Parameters:

jobID - a job ID.

addDeletionTask

void addDeletionTask(int[] jobIDs)

Adds an array of jobID to the deletion task list for batch operation.

Parameters:

jobIDs - an array of job ID.