org.pentaho.platform.scheduler.action
Class JobSchedulerComponent

java.lang.Object
  extended by org.pentaho.platform.engine.core.system.PentahoBase
      extended by org.pentaho.platform.engine.services.PentahoMessenger
          extended by org.pentaho.platform.engine.services.solution.ComponentBase
              extended by org.pentaho.platform.scheduler.action.JobSchedulerComponent
All Implemented Interfaces:
Serializable, IAuditable, IComponent, ILogger, IParameterResolver

public class JobSchedulerComponent
extends ComponentBase

Author:
wseyler TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates
See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.pentaho.platform.engine.services.solution.ComponentBase
COMPONENT_EXECUTE_FAIL, MISSING_SESSION
 
Fields inherited from class org.pentaho.platform.engine.core.system.PentahoBase
EMPTYLOGID, LOGID_MASK1, LOGID_MASK2, LOGID_SEPARATOR
 
Fields inherited from interface org.pentaho.platform.api.engine.ILogger
ACTIVITY_LOG, DEBUG, ERROR, FATAL, INFO, INSTANCE_LOG, SESSION_LOG, SOLUTION_LOG, TRACE, UNKNOWN, WARN
 
Constructor Summary
JobSchedulerComponent()
           
 
Method Summary
 boolean deleteJob(String jobName, String groupName)
           
 void done()
          Allows the component to perform any cleanup after the execution of the action.
 Log getLogger()
           
 boolean init()
          Initialize the Component.
 boolean resumeJob(String jobName, String groupName)
           
 boolean startJob(JobDetail jobDetail, Trigger trigger)
           
 boolean suspendJob(String jobName, String groupName)
           
 
Methods inherited from class org.pentaho.platform.engine.services.solution.ComponentBase
createFeedbackParameter, createFeedbackParameter, createNewInstance, execute, getActionDefinition, getActionName, getActionTitle, getComponentDefinition, getComponentDefinition, getId, getInitFailMessage, getInitOk, getInstanceId, getLogId, getObjectName, getProcessId, getResourceAsString, getRuntimeContext, getSession, inputMissingError, outputMissingError, promptNeeded, promptNow, resolveParameter, resourceComponentSettingError, resourceMissingError, setActionDefinition, setActionName, setComponentDefinition, setComponentDefinitionMap, setInstanceId, setProcessId, setRuntimeContext, setSession, validate
 
Methods inherited from class org.pentaho.platform.engine.services.PentahoMessenger
debug, debug, error, error, fatal, fatal, getMessages, getUserString, info, info, setMessages, trace, trace, warn, warn
 
Methods inherited from class org.pentaho.platform.engine.core.system.PentahoBase
genLogIdFromInfo, genLogIdFromInfo, genLogIdFromSession, getLoggingLevel, setLoggingLevel, setLogId
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.pentaho.platform.api.engine.IComponent
getMessages, setMessages
 
Methods inherited from interface org.pentaho.platform.api.engine.ILogger
debug, debug, error, error, fatal, fatal, getLoggingLevel, info, info, setLoggingLevel, trace, trace, warn, warn
 

Constructor Detail

JobSchedulerComponent

public JobSchedulerComponent()
Method Detail

init

public boolean init()
Description copied from interface: IComponent
Initialize the Component. This method is typically called on construction.

Specified by:
init in interface IComponent
Specified by:
init in class ComponentBase
Returns:
returns true if the Component initialized successfully, otherwise returns false

done

public void done()
Description copied from interface: IComponent
Allows the component to perform any cleanup after the execution of the action.

Specified by:
done in interface IComponent
Specified by:
done in class ComponentBase

getLogger

public Log getLogger()
Specified by:
getLogger in class PentahoBase

startJob

public boolean startJob(JobDetail jobDetail,
                        Trigger trigger)

suspendJob

public boolean suspendJob(String jobName,
                          String groupName)

deleteJob

public boolean deleteJob(String jobName,
                         String groupName)

resumeJob

public boolean resumeJob(String jobName,
                         String groupName)