org.pentaho.platform.scheduler2.quartz
Class QuartzJobKey

java.lang.Object
  extended by org.pentaho.platform.scheduler2.quartz.QuartzJobKey

public class QuartzJobKey
extends Object

This class is the key by which we identify a quartz job. It provides the means to create a new key or derive a key from an existing job. This should be the only place in the Quartz scheduler that knows exactly how a jobId is constructed.

Author:
aphillips

Constructor Summary
QuartzJobKey(String jobName, String username)
          Use this constructor when you wish to create a new unique job key.
 
Method Summary
 String getJobName()
           
 String getUserName()
           
static QuartzJobKey parse(String jobId)
          Parses an existing jobId into a QuartzJobKey
 String toString()
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

QuartzJobKey

public QuartzJobKey(String jobName,
                    String username)
             throws SchedulerException
Use this constructor when you wish to create a new unique job key.

Parameters:
jobName - the user-provided job name
username - the user who is executing this job
Throws:
SchedulerException
Method Detail

parse

public static QuartzJobKey parse(String jobId)
                          throws SchedulerException
Parses an existing jobId into a QuartzJobKey

Parameters:
jobId - an existing jobId
Returns:
a quartz job key
Throws:
SchedulerException

getUserName

public String getUserName()

getJobName

public String getJobName()

toString

public String toString()
Overrides:
toString in class Object