com.sap.scheduler.runtime

Class Event

java.lang.Object
  com.sap.scheduler.runtime.Event

All Implemented Interfaces:

Serializable

public class Event
extends Object
implements Serializable

See Also:

EventConsumer, Scheduler.addEventListener(String[], EventConsumer), Scheduler.removeEventListener(EventConsumer), Serialized Form

Field Summary

static String	EVENT_JOB_CANCELLED Event raised by the job scheduler when a job is cancelled.
static String	EVENT_JOB_CANCELLED_DESC
static String	EVENT_JOB_DEFINITION_DEPLOYED Event raised when a job definition is deployed.
static String	EVENT_JOB_DEFINITION_DEPLOYED_DESC
static String	EVENT_JOB_DEFINITION_DEPLOYED1 Event raised when a job definition is deployed.
static String	EVENT_JOB_DEFINITION_DEPLOYED1_DESC
static String	EVENT_JOB_DEFINITION_REDEPLOYED Deprecated. event is not used
static String	EVENT_JOB_DEFINITION_UNDEPLOYED Event raised when a job definition is undeployed.
static String	EVENT_JOB_DEFINITION_UNDEPLOYED_DESC
static String	EVENT_JOB_DEFINITION_UNDEPLOYED1 Event raised when a job definition is undeployed.
static String	EVENT_JOB_DEFINITION_UNDEPLOYED1_DESC
static String	EVENT_JOB_FINISHED Event raised by the job scheduler when a job has finished.
static String	EVENT_JOB_FINISHED_DESC
static String	EVENT_JOB_HELD Deprecated. event is not used
static String	EVENT_JOB_HELD_DESC Deprecated. event is not used
static String	EVENT_JOB_RELEASED Deprecated. event is not used
static String	EVENT_JOB_RELEASED_DESC Deprecated. event is not used
static String	EVENT_JOB_REMOVED Deprecated. event is not used
static String	EVENT_JOB_REMOVED_DESC Deprecated. event is not used
static String	EVENT_JOB_STARTED Event raised by the job scheduler when a job is started.
static String	EVENT_JOB_STARTED_DESC
static String	EVENT_JOB_STARTING Event raised by the job scheduler when a job is starting.
static String	EVENT_JOB_STARTING_DESC
static String	EVENT_JOB_SUBMITTED Deprecated. event is not used
static String	EVENT_JOB_SUBMITTED_DESC Deprecated. event is not used
static String	EVENT_TASK_CANCELLED Event raised when a task has been cancelled.
static String	EVENT_TASK_CANCELLED_DESC
static String	EVENT_TASK_CREATED Event raised when a task has been created.
static String	EVENT_TASK_CREATED_DESC
static String	EVENT_TASK_FINISHED Event raised when a task has been finished.
static String	EVENT_TASK_FINISHED_DESC
static String	EVENT_TASK_HOLD Event raised when a task has been set to hold.
static String	EVENT_TASK_HOLD_DESC
static String	EVENT_TASK_RELEASED Event raised when a task has been set to release.
static String	EVENT_TASK_RELEASED_DESC
static String[]	JXBP_RUNTIME_EVENT_TYPES Represents the event types which are available for users of the JXBP API
static String[]	JXBP_RUNTIME_EVENT_TYPES_DESC Represents the event type descriptions which are available for users of the JXBP API
static String[]	RUNTIME_EVENT_TYPES Represents the event types which are available for users of the Scheduler API
static String[]	RUNTIME_EVENT_TYPES_DESC Represents the event type descriptions which are available for users of the Scheduler API
static String	RUNTIME_ROOT

Constructor Summary

Event(String type, String parameter, AbstractIdentifier raisedByDetails)
Deprecated.

Event(String type, String parameter, AbstractIdentifier raisedByDetails, Date raisedDate)
Deprecated.

Event(String type, String parameter, String additionalParameter, AbstractIdentifier raisedByDetails, Date raisedDate)
Deprecated.

Event(String type, String parameter, String additionalParameter, Date raisedDate)

Method Summary

String	getAdditionalParameter() Returns the additional parameter which is sent with some events.
byte[]	getId() Deprecated. Event id is not used
String	getParameter() Returns the parameter for this event
AbstractIdentifier	getRaisedByDetails() Further details about the source of this event.
Date	getRaisedDate() Returns the date when this event was raised
String	getType() Returns the type of this event.
void	setId(byte[] id) Deprecated. Event id is not used
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RUNTIME_ROOT

public static final String RUNTIME_ROOT

See Also:

Constant Field Values

EVENT_JOB_SUBMITTED

public static final String EVENT_JOB_SUBMITTED

Deprecated. event is not used

Event raised by the job scheduler when a job is submitted. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_SUBMITTED_DESC

public static final String EVENT_JOB_SUBMITTED_DESC

Deprecated. event is not used

See Also:

Constant Field Values

EVENT_JOB_HELD

public static final String EVENT_JOB_HELD

Deprecated. event is not used

Event raised by the job scheduler when a job is held. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_HELD_DESC

public static final String EVENT_JOB_HELD_DESC

Deprecated. event is not used

See Also:

Constant Field Values

EVENT_JOB_RELEASED

public static final String EVENT_JOB_RELEASED

Deprecated. event is not used

Event raised by the job scheduler when a job is released. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_RELEASED_DESC

public static final String EVENT_JOB_RELEASED_DESC

Deprecated. event is not used

See Also:

Constant Field Values

EVENT_JOB_STARTING

public static final String EVENT_JOB_STARTING

Event raised by the job scheduler when a job is starting. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_STARTING_DESC

public static final String EVENT_JOB_STARTING_DESC

See Also:

Constant Field Values

EVENT_JOB_STARTED

public static final String EVENT_JOB_STARTED

Event raised by the job scheduler when a job is started. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_STARTED_DESC

public static final String EVENT_JOB_STARTED_DESC

See Also:

Constant Field Values

EVENT_JOB_FINISHED

public static final String EVENT_JOB_FINISHED

Event raised by the job scheduler when a job has finished. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_FINISHED_DESC

public static final String EVENT_JOB_FINISHED_DESC

See Also:

Constant Field Values

EVENT_JOB_CANCELLED

public static final String EVENT_JOB_CANCELLED

Event raised by the job scheduler when a job is cancelled. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_CANCELLED_DESC

public static final String EVENT_JOB_CANCELLED_DESC

See Also:

Constant Field Values

EVENT_JOB_REMOVED

public static final String EVENT_JOB_REMOVED

Deprecated. event is not used

Event raised when a job is deleted. It does not matter is the job has already run or not. The parameter contains the job id.

See Also:

Constant Field Values

EVENT_JOB_REMOVED_DESC

public static final String EVENT_JOB_REMOVED_DESC

Deprecated. event is not used

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_DEPLOYED

public static final String EVENT_JOB_DEFINITION_DEPLOYED

Event raised when a job definition is deployed. The parameter contains the job definition name.

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_DEPLOYED_DESC

public static final String EVENT_JOB_DEFINITION_DEPLOYED_DESC

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_UNDEPLOYED

public static final String EVENT_JOB_DEFINITION_UNDEPLOYED

Event raised when a job definition is undeployed. The parameter contains the job definition name. See { @link #EVENT_JOB_DEFINITION_DEPLOYED } also.

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_UNDEPLOYED_DESC

public static final String EVENT_JOB_DEFINITION_UNDEPLOYED_DESC

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_DEPLOYED1

public static final String EVENT_JOB_DEFINITION_DEPLOYED1

Event raised when a job definition is deployed. The parameter contains the job definition id.

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_DEPLOYED1_DESC

public static final String EVENT_JOB_DEFINITION_DEPLOYED1_DESC

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_UNDEPLOYED1

public static final String EVENT_JOB_DEFINITION_UNDEPLOYED1

Event raised when a job definition is undeployed. The parameter contains the job definition id. See { @link EVENT_JOB_DEFINITION_DEPLOYED1} also.

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_UNDEPLOYED1_DESC

public static final String EVENT_JOB_DEFINITION_UNDEPLOYED1_DESC

See Also:

Constant Field Values

EVENT_JOB_DEFINITION_REDEPLOYED

public static final String EVENT_JOB_DEFINITION_REDEPLOYED

Deprecated. event is not used

Event raised when a job definition is redeployed. The parameter contains the job definition name. If there is no change to the job definition, no event will be raised.

See Also:

Constant Field Values

EVENT_TASK_CREATED

public static final String EVENT_TASK_CREATED

Event raised when a task has been created. The parameter contains the task id.

See Also:

Constant Field Values

EVENT_TASK_CREATED_DESC

public static final String EVENT_TASK_CREATED_DESC

See Also:

Constant Field Values

EVENT_TASK_HOLD

public static final String EVENT_TASK_HOLD

Event raised when a task has been set to hold. The parameter contains the task id.

See Also:

Constant Field Values

EVENT_TASK_HOLD_DESC

public static final String EVENT_TASK_HOLD_DESC

See Also:

Constant Field Values

EVENT_TASK_RELEASED

public static final String EVENT_TASK_RELEASED

Event raised when a task has been set to release. The parameter contains the task id.

See Also:

Constant Field Values

EVENT_TASK_RELEASED_DESC

public static final String EVENT_TASK_RELEASED_DESC

See Also:

Constant Field Values

EVENT_TASK_CANCELLED

public static final String EVENT_TASK_CANCELLED

Event raised when a task has been cancelled. The parameter contains the task id.

See Also:

Constant Field Values

EVENT_TASK_CANCELLED_DESC

public static final String EVENT_TASK_CANCELLED_DESC

See Also:

Constant Field Values

EVENT_TASK_FINISHED

public static final String EVENT_TASK_FINISHED

Event raised when a task has been finished. The parameter contains the task id.

See Also:

Constant Field Values

EVENT_TASK_FINISHED_DESC

public static final String EVENT_TASK_FINISHED_DESC

See Also:

Constant Field Values

JXBP_RUNTIME_EVENT_TYPES

public static final String[] JXBP_RUNTIME_EVENT_TYPES

Represents the event types which are available for users of the JXBP API

JXBP_RUNTIME_EVENT_TYPES_DESC

public static final String[] JXBP_RUNTIME_EVENT_TYPES_DESC

Represents the event type descriptions which are available for users of the JXBP API

RUNTIME_EVENT_TYPES

public static final String[] RUNTIME_EVENT_TYPES

Represents the event types which are available for users of the Scheduler API

RUNTIME_EVENT_TYPES_DESC

public static final String[] RUNTIME_EVENT_TYPES_DESC

Represents the event type descriptions which are available for users of the Scheduler API

Constructor Detail

Event

public Event(String type,
             String parameter,
             String additionalParameter,
             Date raisedDate)

Event

public Event(String type,
             String parameter,
             AbstractIdentifier raisedByDetails,
             Date raisedDate)

Deprecated.

Event

public Event(String type,
             String parameter,
             AbstractIdentifier raisedByDetails)

Deprecated.

Event

public Event(String type,
             String parameter,
             String additionalParameter,
             AbstractIdentifier raisedByDetails,
             Date raisedDate)

Deprecated.

Method Detail

getType

public String getType()

Returns the type of this event.

Returns:

Event type

getParameter

public String getParameter()

Returns the parameter for this event

Returns:

Event parameter

getAdditionalParameter

public String getAdditionalParameter()

Returns the additional parameter which is sent with some events.

Returns:

the additional parameter (can be null)

getRaisedDate

public Date getRaisedDate()

Returns the date when this event was raised

Returns:

The exact date then this event was raised.

getRaisedByDetails

public AbstractIdentifier getRaisedByDetails()

Further details about the source of this event.

Returns:

more details on this event

getId

public byte[] getId()

Deprecated. Event id is not used

setId

public void setId(byte[] id)

Deprecated. Event id is not used

toString

public String toString()

Overrides:

toString in class Object