A B C D E F G H I J L M N O P R S T U V W

A

AbstractIdentifier - Class in com.sap.scheduler.runtime

XML Serializable

AbstractIdentifier() - Constructor for class com.sap.scheduler.runtime.AbstractIdentifier

AbstractIdentifier.ConcreteInstanceFactory - Interface in com.sap.scheduler.runtime

A helper interface.

active - Static variable in class com.sap.scheduler.api.TaskStatus

TaskStatus active

addEventListener(String[], EventConsumer) - Method in interface com.sap.scheduler.api.Scheduler

This method registers a EventConsumer for Jobs and /or tasks.

addFilters(SchedulerTaskID, Filter[]) - Method in interface com.sap.scheduler.api.Scheduler

Adds a filter to the list of filters currently associated to the given task.

B

BOOLEAN - Static variable in class com.sap.scheduler.runtime.JobParameterType

C

cancelJob(JobID) - Method in interface com.sap.scheduler.api.Scheduler

This method cancels a job.

CANCELLED - Static variable in class com.sap.scheduler.runtime.JobStatus

A job has been cancelled while it was in state SCHEDULED, STARTING, or HOLD.

cancelTask(SchedulerTaskID) - Method in interface com.sap.scheduler.api.Scheduler

Cancels a scheduled task with id specified by the taskId parameter.

clone() - Method in class com.sap.scheduler.runtime.AbstractIdentifier

Clones this AbstractIdentifier This is a deep copy operation.

com.sap.scheduler.api - package com.sap.scheduler.api

com.sap.scheduler.api.fields - package com.sap.scheduler.api.fields

com.sap.scheduler.runtime - package com.sap.scheduler.runtime

com.sap.scheduler.runtime.mdb - package com.sap.scheduler.runtime.mdb

compareCronEntry(CronEntry) - Method in class com.sap.scheduler.api.CronEntry

Compares a CronEntry with this.

compareFilter(Filter) - Method in class com.sap.scheduler.api.Filter

Compares a Filter with this.

compareJobParameter(JobParameter) - Method in class com.sap.scheduler.runtime.JobParameter

Compares a JobParameter with this.

compareRecurringEntry(RecurringEntry) - Method in class com.sap.scheduler.api.RecurringEntry

Compares a RecurringEntry with this.

compareSchedulerTask(SchedulerTask) - Method in class com.sap.scheduler.api.SchedulerTask

Compares a SchedulerTask with this.

compareTo(Object) - Method in class com.sap.scheduler.api.SchedulerTime

Compares two scheduler time objects

COMPLETED - Static variable in class com.sap.scheduler.runtime.JobStatus

The job has completed.

createNotInitialized() - Method in interface com.sap.scheduler.runtime.AbstractIdentifier.ConcreteInstanceFactory

Creates a new instance of the given heir class.

createSchedulerTask(JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[], Filter[], int, String, String, String) - Static method in class com.sap.scheduler.api.SchedulerTask

Creates a new SchedulerTask instance with the specified parameters.

CronDOMField - Class in com.sap.scheduler.api.fields

This class represents a Cron day of month field.

CronDOMField(String) - Constructor for class com.sap.scheduler.api.fields.CronDOMField

Constructs a day of month field from given cron

CronDOMField(int) - Constructor for class com.sap.scheduler.api.fields.CronDOMField

Constructs a day of month field from given single value

CronDOMField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronDOMField

Constructs a day of month field from given range, e.g.

CronDOMField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronDOMField

Constructs a day of month field from given range and step, e.g.

CronDOWField - Class in com.sap.scheduler.api.fields

This class represents a Cron day of week field.

CronDOWField(String) - Constructor for class com.sap.scheduler.api.fields.CronDOWField

Constructs a day of week field from given cron

CronDOWField(int) - Constructor for class com.sap.scheduler.api.fields.CronDOWField

Constructs a day of week field from given single value

CronDOWField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronDOWField

Constructs a day of week field from given value range, e.g.

CronDOWField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronDOWField

Constructs a day of week field from given value range and step, e.g.

CronEntry - Class in com.sap.scheduler.api

This class represents a cron entry

CronEntry(String) - Constructor for class com.sap.scheduler.api.CronEntry

Constructs a cron entry object from given cron entry with the default time zone

CronEntry(String, TimeZone) - Constructor for class com.sap.scheduler.api.CronEntry

Constructs a cron entry object from given cron entry and specified time zone

CronEntry(CronYearField, CronMonthField, CronDOMField, CronDOWField, CronHourField, CronMinuteField) - Constructor for class com.sap.scheduler.api.CronEntry

Constructs a cron entry object from given fields and the default time zone

CronEntry(CronYearField, CronMonthField, CronDOMField, CronDOWField, CronHourField, CronMinuteField, TimeZone) - Constructor for class com.sap.scheduler.api.CronEntry

Constructs a cron entry object from given fields and specified time zone

CronField - Class in com.sap.scheduler.api

This class is the base cron field class

CronField(int, String) - Constructor for class com.sap.scheduler.api.CronField

Constructs and validates a cron field from given cron

CronField(int, int) - Constructor for class com.sap.scheduler.api.CronField

Constructs and validates a cron field from given single value

CronField(int, int, int) - Constructor for class com.sap.scheduler.api.CronField

Constructs and validates a cron field from given value range, e.g.

CronField(int, int, int, int) - Constructor for class com.sap.scheduler.api.CronField

Constructs and validates a cron field from given value range and step, e.g.

CronHourField - Class in com.sap.scheduler.api.fields

This class represents a Cron hour field.

CronHourField(String) - Constructor for class com.sap.scheduler.api.fields.CronHourField

Constructs a hour field from given cron

CronHourField(int) - Constructor for class com.sap.scheduler.api.fields.CronHourField

Constructs a hour field from given single value

CronHourField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronHourField

Constructs a hour field from given value range, e.g.

CronHourField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronHourField

Constructs a hour field from given value range and step, e.g.

CronMinuteField - Class in com.sap.scheduler.api.fields

This class represents a Cron minute field.

CronMinuteField(String) - Constructor for class com.sap.scheduler.api.fields.CronMinuteField

Constructs a minute field from given cron

CronMinuteField(int) - Constructor for class com.sap.scheduler.api.fields.CronMinuteField

Constructs a minute field from given single value

CronMinuteField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronMinuteField

Constructs a minute field from given value range , e.g.

CronMinuteField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronMinuteField

Constructs a minute field from given value range , e.g.

CronMonthField - Class in com.sap.scheduler.api.fields

This class represents a Cron month field.

CronMonthField(String) - Constructor for class com.sap.scheduler.api.fields.CronMonthField

Constructs a month field from given cron

CronMonthField(int) - Constructor for class com.sap.scheduler.api.fields.CronMonthField

Constructs a month field from given single value

CronMonthField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronMonthField

Constructs a month field from given value range, e.g.

CronMonthField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronMonthField

Constructs a month field from given single value and step, e.g.

CronYearField - Class in com.sap.scheduler.api.fields

This class represents a Cron year field.

CronYearField(String) - Constructor for class com.sap.scheduler.api.fields.CronYearField

Constructs a year field from given cron

CronYearField(int) - Constructor for class com.sap.scheduler.api.fields.CronYearField

Constructs a month field from given single value

CronYearField(int, int) - Constructor for class com.sap.scheduler.api.fields.CronYearField

Constructs a month field from given value range, e.g [start - end]

CronYearField(int, int, int) - Constructor for class com.sap.scheduler.api.fields.CronYearField

Constructs a month field from given value range, e.g [start - end]/step

D

DATE - Static variable in class com.sap.scheduler.runtime.JobParameterType

DEFAULT_RETENTION_PERIOD - Static variable in class com.sap.scheduler.runtime.JobDefinition

This constant represents the default retention period if no value is specified.

DESCRIPTION_UNDEFINED - Static variable in class com.sap.scheduler.api.TaskStatus

DOUBLE - Static variable in class com.sap.scheduler.runtime.JobParameterType

E

ejbCreate() - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

ejbRemove() - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

equals(Object) - Method in class com.sap.scheduler.api.SchedulerTime

Checks if the object is the same

equals(Object) - Method in class com.sap.scheduler.api.TaskStatus

Is equal if m_value is equal.

equals(Object) - Method in class com.sap.scheduler.runtime.AbstractIdentifier

Compares another object to this AbstractIdentifier instance.

equals(Object) - Method in class com.sap.scheduler.runtime.JobDefinitionName

Returns true if the provided object represents the same application name.

equals(Object) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

equals(Object) - Method in class com.sap.scheduler.runtime.JobParameterType

equals(Object) - Method in class com.sap.scheduler.runtime.JobStatus

ERROR - Static variable in class com.sap.scheduler.runtime.JobStatus

The job has completed but threw an exception during execution or it is clear that the job failed (e.g. for a http job the http message could not be sent).

Event - Class in com.sap.scheduler.runtime

Event(String, String, String, Date) - Constructor for class com.sap.scheduler.runtime.Event

Event(String, String, AbstractIdentifier, Date) - Constructor for class com.sap.scheduler.runtime.Event

Deprecated.

Event(String, String, AbstractIdentifier) - Constructor for class com.sap.scheduler.runtime.Event

Deprecated.

Event(String, String, String, AbstractIdentifier, Date) - Constructor for class com.sap.scheduler.runtime.Event

Deprecated.

EVENT_JOB_CANCELLED - Static variable in class com.sap.scheduler.runtime.Event

Event raised by the job scheduler when a job is cancelled.

EVENT_JOB_CANCELLED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_DEFINITION_DEPLOYED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a job definition is deployed.

EVENT_JOB_DEFINITION_DEPLOYED1 - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a job definition is deployed.

EVENT_JOB_DEFINITION_DEPLOYED1_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_DEFINITION_DEPLOYED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_DEFINITION_REDEPLOYED - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_DEFINITION_UNDEPLOYED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a job definition is undeployed.

EVENT_JOB_DEFINITION_UNDEPLOYED1 - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a job definition is undeployed.

EVENT_JOB_DEFINITION_UNDEPLOYED1_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_DEFINITION_UNDEPLOYED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_FINISHED - Static variable in class com.sap.scheduler.runtime.Event

Event raised by the job scheduler when a job has finished.

EVENT_JOB_FINISHED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_HELD - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_HELD_DESC - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_RELEASED - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_RELEASED_DESC - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_REMOVED - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_REMOVED_DESC - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_STARTED - Static variable in class com.sap.scheduler.runtime.Event

Event raised by the job scheduler when a job is started.

EVENT_JOB_STARTED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_STARTING - Static variable in class com.sap.scheduler.runtime.Event

Event raised by the job scheduler when a job is starting.

EVENT_JOB_STARTING_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_JOB_SUBMITTED - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_JOB_SUBMITTED_DESC - Static variable in class com.sap.scheduler.runtime.Event

Deprecated. event is not used

EVENT_TASK_CANCELLED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a task has been cancelled.

EVENT_TASK_CANCELLED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_TASK_CREATED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a task has been created.

EVENT_TASK_CREATED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_TASK_FINISHED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a task has been finished.

EVENT_TASK_FINISHED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_TASK_HOLD - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a task has been set to hold.

EVENT_TASK_HOLD_DESC - Static variable in class com.sap.scheduler.runtime.Event

EVENT_TASK_RELEASED - Static variable in class com.sap.scheduler.runtime.Event

Event raised when a task has been set to release.

EVENT_TASK_RELEASED_DESC - Static variable in class com.sap.scheduler.runtime.Event

EventConsumer - Interface in com.sap.scheduler.runtime

Event consumers can implement this interface in order to get callbacks.

executeJob(JobDefinitionID) - Method in interface com.sap.scheduler.runtime.JobContext

Submit a job for immediate execution.

executeJob(String) - Method in interface com.sap.scheduler.runtime.JobContext

Submit a job for immediate execution.

executeJob(JobDefinitionID, JobParameter[]) - Method in interface com.sap.scheduler.runtime.JobContext

Submit a job for immediate execution.

executeJob(String, JobParameter[]) - Method in interface com.sap.scheduler.runtime.JobContext

Submit a job for immediate execution.

F

FIELD_HOUR - Static variable in class com.sap.scheduler.api.CronField

FIELD_MINUTE - Static variable in class com.sap.scheduler.api.CronField

FIELD_MONTH - Static variable in class com.sap.scheduler.api.CronField

FIELD_MONTH_DAY - Static variable in class com.sap.scheduler.api.CronField

FIELD_OK - Static variable in class com.sap.scheduler.api.CronField

FIELD_WEEK_DAY - Static variable in class com.sap.scheduler.api.CronField

FIELD_YEAR - Static variable in class com.sap.scheduler.api.CronField

fieldCodesToErrMsgs - Static variable in class com.sap.scheduler.api.CronField

Filter - Class in com.sap.scheduler.api

Instances of this class are used by the scheduler to filter out timeout events.

Filter(SchedulerTime, SchedulerTime) - Constructor for class com.sap.scheduler.api.Filter

Creates new instance of Filter for the specified time period

filtered - Variable in class com.sap.scheduler.api.Scheduler.FireTimeEvent

Indicates whether the current set of filters has filtered this expiration out.

filterOut(SchedulerTime) - Method in class com.sap.scheduler.api.Filter

Checks if the given time is to be filtered out

filterOut(long) - Method in class com.sap.scheduler.api.Filter

Checks if the given time is to be filtered out

finished - Static variable in class com.sap.scheduler.api.TaskStatus

TaskStatus finished

fldCode - Variable in class com.sap.scheduler.api.CronField

FLOAT - Static variable in class com.sap.scheduler.runtime.JobParameterType

G

getAdditionalParameter() - Method in class com.sap.scheduler.runtime.Event

Returns the additional parameter which is sent with some events.

getAllSchedulerTaskIDs() - Method in interface com.sap.scheduler.api.Scheduler

Obtains all currently scheduled scheduler tasks which are in state active or hold.

getApplication() - Method in class com.sap.scheduler.runtime.JobDefinition

getApplicationName() - Method in class com.sap.scheduler.runtime.JobDefinitionName

Returns the application name.

getBooleanValue() - Method in class com.sap.scheduler.runtime.JobParameter

getBytes() - Method in class com.sap.scheduler.runtime.AbstractIdentifier

Obtains a byte representation of this id.

getCancelRequest() - Method in class com.sap.scheduler.runtime.Job

getCategory() - Method in interface com.sap.scheduler.runtime.JobContext

Get the category for this job which can be used to log messages in the context of the job.

getChildJobById(JobID) - Method in interface com.sap.scheduler.runtime.JobContext

Get an existing job instance by its job id.

getChildJobs(JobID) - Method in interface com.sap.scheduler.api.Scheduler

Get all child jobs for a given job id.

getCPUTime() - Method in class com.sap.scheduler.runtime.Job

Returns the CPU time required to run this job.

getCronEntries() - Method in class com.sap.scheduler.api.SchedulerTask

getCustomData() - Method in class com.sap.scheduler.api.SchedulerTask

getDateValue() - Method in class com.sap.scheduler.runtime.JobParameter

getDays_of_month() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getDays_of_week() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getDefaultData() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

getDelegate() - Static method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

getDescription() - Method in class com.sap.scheduler.api.SchedulerTask

getDescription() - Method in class com.sap.scheduler.api.TaskStatus

Returns the description.

getDescription() - Method in class com.sap.scheduler.runtime.JobDefinition

Obtains a text description of this job definition

getDescription() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

getDescriptionValue() - Method in class com.sap.scheduler.api.TaskStatus

Return the description value.

getDirection() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

getDoubleValue() - Method in class com.sap.scheduler.runtime.JobParameter

getEndDate() - Method in class com.sap.scheduler.runtime.Job

Returns the date when this job finished

getEndDate() - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

getEndedFrom() - Method in class com.sap.scheduler.runtime.JobFilter

getEndedTo() - Method in class com.sap.scheduler.runtime.JobFilter

getEndTime() - Method in class com.sap.scheduler.api.Filter

Obtains the end time of the filter

getEndTime() - Method in class com.sap.scheduler.api.RecurringEntry

Getter method

getFilters() - Method in class com.sap.scheduler.api.SchedulerTask

Obtains the filters associated with this scheduler task.

getFireTimes(SchedulerTaskID, SchedulerTime, SchedulerTime) - Method in interface com.sap.scheduler.api.Scheduler

This method returns the fire times of a SchedulerTask for a given time interval specified by the startTime, endTime and the id parameters.

getFloatValue() - Method in class com.sap.scheduler.runtime.JobParameter

getGroup() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

getHours() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getId() - Method in class com.sap.scheduler.runtime.Event

Deprecated. Event id is not used

getId() - Method in class com.sap.scheduler.runtime.Job

Get the job id (unique identifier).

getIntegerValue() - Method in class com.sap.scheduler.runtime.JobParameter

getJob(JobID) - Method in interface com.sap.scheduler.api.Scheduler

This method returns a job for a given job id jobid.

getJob() - Method in interface com.sap.scheduler.runtime.JobContext

Get the Job object associated with this job.

getJobDefinition(String) - Method in interface com.sap.scheduler.runtime.JobContext

Get the JobDefinition object which represents the job metadata for the given name

getJobDefinitionById(JobDefinitionID) - Method in interface com.sap.scheduler.api.Scheduler

Get job definition by its job definition id.

getJobDefinitionByName(String) - Method in interface com.sap.scheduler.api.Scheduler

Returns the job defintion for a given name.

getJobDefinitionId() - Method in class com.sap.scheduler.api.SchedulerTask

Obtains the id of the job definition whose instances are triggered by this scheduler task

getJobDefinitionId() - Method in class com.sap.scheduler.runtime.Job

getJobDefinitionId() - Method in class com.sap.scheduler.runtime.JobDefinition

Obtains the id of this job definition.

getJobDefinitionId() - Method in class com.sap.scheduler.runtime.JobFilter

getJobDefinitionName() - Method in class com.sap.scheduler.runtime.JobDefinition

This method returns the JobDefinitionName object which represents the name of this job definition.

getJobDefinitions() - Method in interface com.sap.scheduler.api.Scheduler

Returns all job definitions known to the NetWeaver Scheduler.

getJobId() - Method in class com.sap.scheduler.runtime.JobFilter

getJobId() - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

getJobLog(JobID, LogIterator, int) - Method in interface com.sap.scheduler.api.Scheduler

This method will return the log for the given job in chunks.

getJobParameter(String) - Method in interface com.sap.scheduler.runtime.JobContext

Get a job parameter.

getJobParameterDefinition(String, String) - Method in interface com.sap.scheduler.runtime.JobContext

Returns the named job definition parameter for the given job defintion which was provided when the job was deployed.

getJobParameterDefinition() - Method in class com.sap.scheduler.runtime.JobParameter

getJobParameterDefinitions(String) - Method in interface com.sap.scheduler.runtime.JobContext

Returns the job definitions parameters for the given job defintion which were provided when the job was deployed.

getJobParameterGeneric(String) - Method in interface com.sap.scheduler.runtime.JobContext

Get a job parameter.

getJobParameters(JobID) - Method in interface com.sap.scheduler.api.Scheduler

This method returns all parameters for a given job id jobid.

getJobParameters() - Method in class com.sap.scheduler.api.SchedulerTask

Obtains the parameters of this scheduler task.

getJobs(JobID[]) - Method in interface com.sap.scheduler.api.Scheduler

This method returns the jobs for given job ids.

getJobs(JobFilter, JobIterator, int) - Method in interface com.sap.scheduler.api.Scheduler

This method will return all jobs which match the provided filter criteria.

getJobs() - Method in class com.sap.scheduler.runtime.JobIterator

Method to be used by the scheduler runtime only!

getJobStatus(JobID) - Method in interface com.sap.scheduler.api.Scheduler

Returns the status of a job.

getJobStatus() - Method in class com.sap.scheduler.runtime.Job

Get the status.

getJobStatus() - Method in class com.sap.scheduler.runtime.JobFilter

getJobType() - Method in class com.sap.scheduler.runtime.JobDefinition

This method returns an int representing the type of this job.

getLocalizationInfoMap() - Method in class com.sap.scheduler.runtime.JobDefinition

Returns the localization info for this parameter.

getLocalizationInfoMap() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns the localization info for this parameter.

getLocalizedDescription() - Method in class com.sap.scheduler.runtime.JobDefinition

Returns the localized description depending on the current system locale, if not available, the default description deployed with this job will be returned.

getLocalizedDescription(Locale) - Method in class com.sap.scheduler.runtime.JobDefinition

Returns the localized description depending on the provided locale if available, otherwise the default description deployed with this job will be returned.

getLocalizedDescription() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns the localized description depending on the current system locale, if not available, the default description deployed with this job will be returned.

getLocalizedDescription(Locale) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns the localized description depending on the provided locale if available, otherwise the default description deployed with this job will be returned.

getLocalizedName() - Method in class com.sap.scheduler.runtime.JobDefinition

Returns the localized name depending on the current system locale.

getLocalizedName(Locale) - Method in class com.sap.scheduler.runtime.JobDefinition

Returns the localized name depending on the provided locale if available, otherwise the default name deployed with this job will be returned.

getLocalizedName() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns the localized name depending on the current system locale.

getLocalizedName(Locale) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns the localized name depending on the provided locale if available, otherwise the default name deployed with this job will be returned.

getLocation() - Method in interface com.sap.scheduler.runtime.JobContext

Get the location that is required in order to be able to log to the Job's category.

getLogger() - Method in interface com.sap.scheduler.runtime.JobContext

Get a JDK-compliant Logger object.

getLongValue() - Method in class com.sap.scheduler.runtime.JobParameter

getMaxValue() - Method in class com.sap.scheduler.api.CronField

Getter method

getMaxValue(int) - Static method in class com.sap.scheduler.api.CronField

Getter method

getMemoryAllocation() - Method in class com.sap.scheduler.runtime.Job

Returns the overall memory allocated by this job.

getMessageDrivenContext() - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

getMinutes() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getMinValue() - Method in class com.sap.scheduler.api.CronField

Getter method

getMinValue(int) - Static method in class com.sap.scheduler.api.CronField

Getter method

getMonths() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getName() - Method in class com.sap.scheduler.api.SchedulerTask

getName() - Method in interface com.sap.scheduler.runtime.EventConsumer

This method returns a name under which a EventConsumer is registered.

getName() - Method in class com.sap.scheduler.runtime.Job

Get the name of the job definition.

getName() - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. Use getJobDefinitionName.getName() instead

getName() - Method in class com.sap.scheduler.runtime.JobDefinitionName

Returns the job definition name.

getName() - Method in class com.sap.scheduler.runtime.JobFilter

getName() - Method in class com.sap.scheduler.runtime.JobParameter

getName() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

getNode() - Method in class com.sap.scheduler.runtime.Job

Get the node which executes or has execute this job

getNode() - Method in class com.sap.scheduler.runtime.JobFilter

getParameter() - Method in class com.sap.scheduler.runtime.Event

Returns the parameter for this event

getParameter(String) - Method in class com.sap.scheduler.runtime.JobDefinition

This method returns the job parameter definition for the specified parameter.

getParameters() - Method in class com.sap.scheduler.runtime.JobDefinition

This method returns the array of parameter definitions for this job definition.

getParent() - Method in class com.sap.scheduler.runtime.Job

Get the parent job, or null if it has no parent.

getParentId() - Method in class com.sap.scheduler.runtime.JobFilter

getPeriod() - Method in class com.sap.scheduler.api.RecurringEntry

Getter method

getPos() - Method in class com.sap.scheduler.runtime.LogIterator

Method to be used by the scheduler runtime only!

getProperties() - Method in class com.sap.scheduler.runtime.JobDefinition

Obtains all properties currently stored in this instance.

getPropertiesValue() - Method in class com.sap.scheduler.runtime.JobParameter

getRaisedByDetails() - Method in class com.sap.scheduler.runtime.Event

Further details about the source of this event.

getRaisedDate() - Method in class com.sap.scheduler.runtime.Event

Returns the date when this event was raised

getRecurringEntries() - Method in class com.sap.scheduler.api.SchedulerTask

getRemoveDate() - Method in class com.sap.scheduler.runtime.JobDefinition

getRetentionPeriod() - Method in class com.sap.scheduler.api.SchedulerTask

Obtains the retention period in days.

getRetentionPeriod() - Method in class com.sap.scheduler.runtime.Job

getRetentionPeriod() - Method in class com.sap.scheduler.runtime.JobDefinition

Obtains the retention period in days.

getReturnCode() - Method in class com.sap.scheduler.runtime.Job

Get the return code of this job.

getReturnCode() - Method in class com.sap.scheduler.runtime.JobFilter

getRunAsUser() - Method in class com.sap.scheduler.api.SchedulerTask

getScheduler() - Method in class com.sap.scheduler.runtime.Job

Returns the name of the scheduler which controls this job.

getScheduler() - Method in class com.sap.scheduler.runtime.JobFilter

getSchedulerTaskId() - Method in class com.sap.scheduler.runtime.Job

getSchedulerTaskId() - Method in class com.sap.scheduler.runtime.JobFilter

getSchedulingUser() - Method in class com.sap.scheduler.api.SchedulerTask

getStartDate() - Method in class com.sap.scheduler.runtime.Job

Returns the start date of this job.

getStartedFrom() - Method in class com.sap.scheduler.runtime.JobFilter

getStartedTo() - Method in class com.sap.scheduler.runtime.JobFilter

getStartTime() - Method in class com.sap.scheduler.api.Filter

Obtains the start time of the filter

getStartTime() - Method in class com.sap.scheduler.api.RecurringEntry

Getter method

getStateDescriptor() - Method in class com.sap.scheduler.runtime.JobIterator

Method to be used by the scheduler runtime only!

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronDOMField

Returns a string representation of a value

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronDOWField

Returns a string representation of a corresponding day

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronHourField

Returns a string representation of a hour

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronMinuteField

Returns a string representation of a minute

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronMonthField

Returns a string representation of a month

getStringValue(int) - Static method in class com.sap.scheduler.api.fields.CronYearField

Returns a string representation of a year

getStringValue() - Method in class com.sap.scheduler.runtime.JobParameter

getSubmitDate() - Method in class com.sap.scheduler.runtime.Job

date when this job was submitted

getTable() - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

getTask(SchedulerTaskID) - Method in interface com.sap.scheduler.api.Scheduler

Obtains the task with id specified by the id parameter.

getTaskId() - Method in class com.sap.scheduler.api.SchedulerTask

Obtains the id of this scheduler task

getTaskSource() - Method in class com.sap.scheduler.api.SchedulerTask

getTaskSourceDescription() - Method in class com.sap.scheduler.api.SchedulerTask

getTaskStatus() - Method in class com.sap.scheduler.api.SchedulerTask

getTime() - Method in class com.sap.scheduler.api.SchedulerTime

Getter method

getTimeZone() - Method in class com.sap.scheduler.api.CronEntry

Getter method

getTimeZone() - Method in class com.sap.scheduler.api.SchedulerTime

Getter method

getType() - Method in class com.sap.scheduler.runtime.Event

Returns the type of this event.

getType() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

This method returns the type of the parameter.

getUser() - Method in class com.sap.scheduler.runtime.Job

User id which is used to run this job

getUserId() - Method in class com.sap.scheduler.runtime.JobFilter

getValue() - Method in class com.sap.scheduler.api.TaskStatus

Returns the value which represents the task status.

getValue() - Method in class com.sap.scheduler.runtime.JobParameter

getVendorData() - Method in class com.sap.scheduler.runtime.Job

getVendorData() - Method in class com.sap.scheduler.runtime.JobFilter

getYears() - Method in class com.sap.scheduler.api.CronEntry

Getter method

H

handle(Event) - Method in interface com.sap.scheduler.runtime.EventConsumer

Callback-method which will be called when a event occurs for which the user has registered for.

hasChildJobs(JobID) - Method in interface com.sap.scheduler.api.Scheduler

Returns true if this job has child jobs.

hashCode() - Method in class com.sap.scheduler.api.SchedulerTime

Calculates a hashcode

hashCode() - Method in class com.sap.scheduler.api.TaskStatus

hashCode() - Method in class com.sap.scheduler.runtime.AbstractIdentifier

hashCode() - Method in class com.sap.scheduler.runtime.JobDefinitionName

Returns the hash code of this job definition name.

hashCode() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

hashCode() - Method in class com.sap.scheduler.runtime.JobParameterType

hashCode() - Method in class com.sap.scheduler.runtime.JobStatus

hasMoreChunks() - Method in class com.sap.scheduler.runtime.JobIterator

This method returns true if there is more data available.

hasMoreChunks() - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

hasMoreChunks() - Method in class com.sap.scheduler.runtime.LogIterator

This method returns true if there is more data available, e.g.

hold - Static variable in class com.sap.scheduler.api.TaskStatus

TaskStatus hold

HOLD - Static variable in class com.sap.scheduler.runtime.JobStatus

A job which was in state SCHEDULE can be held by the internal or an external scheduler.

holdTask(SchedulerTaskID) - Method in interface com.sap.scheduler.api.Scheduler

Holds a scheduled task with id specified by the taskId parameter.

I

INFINITE_RETENTION_PERIOD - Static variable in class com.sap.scheduler.runtime.JobDefinition

This constant represents the value for an infinite retention period.

INFINITY - Static variable in class com.sap.scheduler.api.CronField

INTEGER - Static variable in class com.sap.scheduler.runtime.JobParameterType

INVALID_FIELD_CODE - Static variable in class com.sap.scheduler.api.CronField

INVALID_JOB_DEFINITION - Static variable in class com.sap.scheduler.runtime.JobDefinitionType

isActive() - Method in class com.sap.scheduler.api.TaskStatus

return true if the task is in state active, otherwise false.

isCancelled() - Method in interface com.sap.scheduler.runtime.JobContext

Returns true if the job has received a request for cancellation.

isDisplay() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

isFinished() - Method in class com.sap.scheduler.api.TaskStatus

return true if the task is in state finished, otherwise false.

isHold() - Method in class com.sap.scheduler.api.TaskStatus

return true if the task is in state hold, otherwise false.

isIn() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

isInOut() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

isNullable() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

isOut() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

isValidJobDefintionType(int) - Static method in class com.sap.scheduler.runtime.JobDefinitionType

J

Job - Class in com.sap.scheduler.runtime

This object represents a job.

Job(JobID, JobDefinitionID, SchedulerID, String, JobStatus, Date, Date, Date, String, short, String, JobID, String, boolean, int) - Constructor for class com.sap.scheduler.runtime.Job

Deprecated. Please use Job.Job(JobID, JobDefinitionID, SchedulerID, String, JobStatus, Date, Date, Date, String, short, String, JobID, String, boolean, int, SchedulerTaskID) instead

Job(JobID, JobDefinitionID, SchedulerID, String, JobStatus, Date, Date, Date, String, short, String, JobID, String, boolean, int, SchedulerTaskID) - Constructor for class com.sap.scheduler.runtime.Job

Create a new job object from the parameters provided.

Job(JobID, JobDefinitionID, SchedulerID, String, JobStatus, Date, Date, Date, String, short, String, JobID, String, boolean, int, SchedulerTaskID, long, long) - Constructor for class com.sap.scheduler.runtime.Job

Create a new job object from the parameters provided.

Job() - Constructor for class com.sap.scheduler.runtime.Job

Deprecated. Please use Job.Job(JobID, JobDefinitionID, SchedulerID, String, JobStatus, Date, Date, Date, String, short, String, JobID, String, boolean, int, SchedulerTaskID) instead

JobContext - Interface in com.sap.scheduler.runtime

The job context of a running job which allows the job to access the scheduler runtime environment.

JobDefinition - Class in com.sap.scheduler.runtime

This abstract class represents the job meta information for jobs which have been deployed.

JobDefinition(JobDefinitionID, String, String, JobParameterDefinition[], int, int, Date, String[][], String, HashMap<String, HashMap<String, String>>) - Constructor for class com.sap.scheduler.runtime.JobDefinition

Deprecated. Please use #JobDefinition(JobDefinitionID, JobDefinitionName, String, JobParameterDefinition[], int, int, Date, String[][], Map)

JobDefinition(JobDefinitionID, JobDefinitionName, String, JobParameterDefinition[], int, int, Date, String[][], HashMap<String, HashMap<String, String>>) - Constructor for class com.sap.scheduler.runtime.JobDefinition

Creates a new instance of JobDefinition.

JobDefinition() - Constructor for class com.sap.scheduler.runtime.JobDefinition

Deprecated. Please use #JobDefinition(JobDefinitionID, JobDefinitionName, String, JobParameterDefinition[], int, int, Date, String[][], Map)

JobDefinitionID - Class in com.sap.scheduler.runtime

Uniquely identifies a Job instance.

JobDefinitionID() - Constructor for class com.sap.scheduler.runtime.JobDefinitionID

Deprecated. This constructor is intended to be used only by XML serialization/deserializtion. In order to create new instances of this class use one of the static methods

JobDefinitionName - Class in com.sap.scheduler.runtime

This class represnts the name of a job defintion.

JobDefinitionName(String) - Constructor for class com.sap.scheduler.runtime.JobDefinitionName

Constructs a new JobDefinitionName from a string.

JobDefinitionName(String, String) - Constructor for class com.sap.scheduler.runtime.JobDefinitionName

Constructs a new JobDefinitionName from an application name and a job name.

JobDefinitionType - Class in com.sap.scheduler.runtime

JobDefinitionType() - Constructor for class com.sap.scheduler.runtime.JobDefinitionType

jobFailed() - Method in interface com.sap.scheduler.runtime.JobContext

This method should be called in order to indicate that this job should be set to the status ERROR after it has been completed.

JobFilter - Class in com.sap.scheduler.runtime

This filter class is used for querying jobs.

JobFilter() - Constructor for class com.sap.scheduler.runtime.JobFilter

JobID - Class in com.sap.scheduler.runtime

Uniquely identifies a Job instance.

JobID() - Constructor for class com.sap.scheduler.runtime.JobID

Deprecated. This constructor is intended to be used only by XML serialization/deserializtion. In order to create new instances of this class use one of the static methods

JobIllegalStateException - Exception in com.sap.scheduler.runtime

This exception is thrown when an oparation on a job fails because it is in the wrong state.

JobIllegalStateException() - Constructor for exception com.sap.scheduler.runtime.JobIllegalStateException

Constructs a new JobIllegalStateException object with no arguments.

JobIllegalStateException(String) - Constructor for exception com.sap.scheduler.runtime.JobIllegalStateException

Constructs a new JobIllegalStateException object with no arguments.

JobIterator - Class in com.sap.scheduler.runtime

Iterator object used to retrieve a possibly large number of job object from a query.

JobIterator() - Constructor for class com.sap.scheduler.runtime.JobIterator

JobIterator.StateDescriptor - Class in com.sap.scheduler.runtime

JobIterator.StateDescriptor() - Constructor for class com.sap.scheduler.runtime.JobIterator.StateDescriptor

JobParameter - Class in com.sap.scheduler.runtime

This interface represents a concrete job parameter.

JobParameter(JobParameterDefinition, Object) - Constructor for class com.sap.scheduler.runtime.JobParameter

Constructs a job parameter object from the given value.

JobParameter(JobParameterDefinition, String) - Constructor for class com.sap.scheduler.runtime.JobParameter

Constructs a job parameter object from the given string value.

JobParameter(JobParameterDefinition, Long) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Integer) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Boolean) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Double) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Float) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Properties) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameter(JobParameterDefinition, Date) - Constructor for class com.sap.scheduler.runtime.JobParameter

JobParameterDefinition - Class in com.sap.scheduler.runtime

This class represents the definition for a single job definition parameter.

JobParameterDefinition() - Constructor for class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. Needed for jver tests. Use only the non-empty constructor!

JobParameterDefinition(String, JobParameterType, boolean, String, String, boolean, String, String, HashMap<String, HashMap<String, String>>) - Constructor for class com.sap.scheduler.runtime.JobParameterDefinition

JobParameterType - Class in com.sap.scheduler.runtime

This class described the supported types for job parameters.

JobStatus - Class in com.sap.scheduler.runtime

Job status codes.

JXBP_RUNTIME_EVENT_TYPES - Static variable in class com.sap.scheduler.runtime.Event

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

JXBP_RUNTIME_EVENT_TYPES_DESC - Static variable in class com.sap.scheduler.runtime.Event

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

L

LogIterator - Class in com.sap.scheduler.runtime

Iterator object used to retrieve large log files in chunks.

LogIterator() - Constructor for class com.sap.scheduler.runtime.LogIterator

LONG - Static variable in class com.sap.scheduler.runtime.JobParameterType

M

m_runAsUser - Variable in class com.sap.scheduler.api.SchedulerTask

m_schedulingUser - Variable in class com.sap.scheduler.api.SchedulerTask

m_taskSource - Variable in class com.sap.scheduler.api.SchedulerTask

m_taskStatus - Variable in class com.sap.scheduler.api.SchedulerTask

MAX_VALUE - Static variable in class com.sap.scheduler.runtime.JobDefinitionType

MDB_JOB_DEFINITION - Static variable in class com.sap.scheduler.runtime.JobDefinitionType

MDBJob - Interface in com.sap.scheduler.runtime.mdb

All jobs implement this interface by inheriting from the MDBJobImplementation class

MDBJobDelegate - Interface in com.sap.scheduler.runtime.mdb

Delegate interface to be implemented by vendors providing support for MDB jobs.

MDBJobImplementation - Class in com.sap.scheduler.runtime.mdb

Standard Message Driven Bean Job.

MDBJobImplementation() - Constructor for class com.sap.scheduler.runtime.mdb.MDBJobImplementation

MIN_VALUE - Static variable in class com.sap.scheduler.runtime.JobDefinitionType

N

newID() - Static method in class com.sap.scheduler.api.SchedulerTaskID

Creates a new SchedulerTaskID instance that represent a new guid.

newID() - Static method in class com.sap.scheduler.runtime.JobDefinitionID

Creates a new JobDefinitionID instance that represent a new guid.

newID() - Static method in class com.sap.scheduler.runtime.JobID

Creates a new JobID instance that represent a new guid.

newID() - Static method in class com.sap.scheduler.runtime.SchedulerID

Creates a new SchedulerID instance that represent a new guid.

nextChunk() - Method in class com.sap.scheduler.runtime.JobIterator

This method returns the next chunk of job objects.

nextChunk() - Method in class com.sap.scheduler.runtime.LogIterator

This method returns the next chunk of data.

NO_MORE_CHUNKS - Static variable in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

NoSuchJobDefinitionException - Exception in com.sap.scheduler.runtime

This exception is thrown by various methods in case the specified job definition does not exist.

NoSuchJobDefinitionException() - Constructor for exception com.sap.scheduler.runtime.NoSuchJobDefinitionException

Constructs a new NoSuchJobDefinitionException object with no arguments.

NoSuchJobDefinitionException(String) - Constructor for exception com.sap.scheduler.runtime.NoSuchJobDefinitionException

Constructs a new NoSuchJobDefinitionException object with a message string.

NoSuchJobException - Exception in com.sap.scheduler.runtime

This exception is thrown by various methods in case the specified job does not exist.

NoSuchJobException() - Constructor for exception com.sap.scheduler.runtime.NoSuchJobException

NoSuchJobException(String) - Constructor for exception com.sap.scheduler.runtime.NoSuchJobException

O

onJob(JobContext) - Method in interface com.sap.scheduler.runtime.mdb.MDBJob

onJob(JobContext) - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

Entry point for job code.

onMessage(Message, MessageDrivenContext, MDBJob) - Method in interface com.sap.scheduler.runtime.mdb.MDBJobDelegate

Process the JMS message for the given MDB

onMessage(Message) - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

Process an arbitary message.

P

ParameterValidationException - Exception in com.sap.scheduler.runtime

This exception is raised when the proided parameters for a job do not match the parameters which are specified by the job definition.

ParameterValidationException() - Constructor for exception com.sap.scheduler.runtime.ParameterValidationException

ParameterValidationException(String) - Constructor for exception com.sap.scheduler.runtime.ParameterValidationException

parseID(String) - Static method in class com.sap.scheduler.api.SchedulerTaskID

Reconstructs a SchedulerTaskID instance from a string representation.

parseID(byte[]) - Static method in class com.sap.scheduler.api.SchedulerTaskID

Reconstructs a SchedulerTaskID instance from a byte[] representation of a guid.

parseID(byte[], AbstractIdentifier.ConcreteInstanceFactory) - Static method in class com.sap.scheduler.runtime.AbstractIdentifier

This is helper method used by ancestor to implement creation of an instance of the given ancestor class from a byte array representation of a guid.

parseID(String, AbstractIdentifier.ConcreteInstanceFactory) - Static method in class com.sap.scheduler.runtime.AbstractIdentifier

This is helper method used by heir to implement creation of an instance of the given heir class from a hex-string representation of a guid.

parseID(String) - Static method in class com.sap.scheduler.runtime.JobDefinitionID

Reconstructs a JobDefinitionID instance from a string representation.

parseID(byte[]) - Static method in class com.sap.scheduler.runtime.JobDefinitionID

Reconstructs a JobDefinitionID instance from a byte[] representation of a guid.

parseID(String) - Static method in class com.sap.scheduler.runtime.JobID

Reconstructs a JobID instance from a string representation.

parseID(byte[]) - Static method in class com.sap.scheduler.runtime.JobID

Reconstructs a JobID instance from a byte[] representation of a guid.

parseID(String) - Static method in class com.sap.scheduler.runtime.SchedulerID

Reconstructs a SchedulerID instance from a string representation.

parseID(byte[]) - Static method in class com.sap.scheduler.runtime.SchedulerID

Reconstructs a SchedulerID instance from a byte[] representation of a guid.

persistableValue() - Method in class com.sap.scheduler.api.CronEntry

Returns the entry as a DB persistable

persistableValue() - Method in class com.sap.scheduler.api.CronField

Returns the cron field a DB persistable

PROPERTIES - Static variable in class com.sap.scheduler.runtime.JobParameterType

putProperty(String, String) - Method in class com.sap.scheduler.runtime.JobDefinition

Puts a property in the list of properties belonging to this instance.

R

readDescriptor(String) - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

readProperty(String) - Method in class com.sap.scheduler.runtime.JobDefinition

Queries a property from the current instance.

RecurringEntry - Class in com.sap.scheduler.api

This class represents a recurring entry

RecurringEntry(long) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constructs an entry with a specified period.

RecurringEntry(SchedulerTime) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constrcuts a new entry that will cause one expiration at the specified time.

RecurringEntry(SchedulerTime, long) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constructs an entry with a spesified start time, period and no end time.

RecurringEntry(SchedulerTime, SchedulerTime, long) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constructs an entry with specified start time, end time and period.

RecurringEntry(SchedulerTime, SchedulerTime, int) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constructor a entry with specified start time, end time and iterations.

RecurringEntry(SchedulerTime, long, int) - Constructor for class com.sap.scheduler.api.RecurringEntry

Constructs an entry with specified start time, period and iterations.

releaseTask(SchedulerTaskID) - Method in interface com.sap.scheduler.api.Scheduler

Releases a held task with id specified by the taskId parameter and set it back to state active.

removeEventListener(EventConsumer) - Method in interface com.sap.scheduler.api.Scheduler

This methods removes a previous registered EventConsumer.

removeFilters(SchedulerTaskID, Filter[]) - Method in interface com.sap.scheduler.api.Scheduler

Removes the given filters from the list of filters associated with the given task.

removeJob(JobID) - Method in interface com.sap.scheduler.api.Scheduler

This method removes all information about this job instance from the NetWeaver Scheduler (including logs).

removeJobs(JobID[]) - Method in interface com.sap.scheduler.api.Scheduler

This method removes all information for the given job instances from the NetWeaver Scheduler (including logs).

RUNNING - Static variable in class com.sap.scheduler.runtime.JobStatus

The job is currently executing.

RUNTIME_EVENT_TYPES - Static variable in class com.sap.scheduler.runtime.Event

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

RUNTIME_EVENT_TYPES_DESC - Static variable in class com.sap.scheduler.runtime.Event

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

RUNTIME_ROOT - Static variable in class com.sap.scheduler.runtime.Event

S

schedule(SchedulerTask) - Method in interface com.sap.scheduler.api.Scheduler

This method schedules the supplied task what means that the task will be persisted and performed.

SCHEDULED - Static variable in class com.sap.scheduler.runtime.JobStatus

The job was scheduled by the internal job scheduler, it will be started by the internal scheduler in the future.

Scheduler - Interface in com.sap.scheduler.api

This is the main interface to the NetWeaver Scheduler for Java.

Scheduler.FireTimeEvent - Class in com.sap.scheduler.api

Instances of this class specify a particular expiration of a given scheduler task.

Scheduler.FireTimeEvent(SchedulerTaskID, SchedulerTime, boolean) - Constructor for class com.sap.scheduler.api.Scheduler.FireTimeEvent

Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

Scheduler.FireTimeEvent(SchedulerTaskID, SchedulerTime) - Constructor for class com.sap.scheduler.api.Scheduler.FireTimeEvent

Constructs a new FireTimeEvent instance to represent an expiration of the given scheduler task at the given time.

SchedulerException - Exception in com.sap.scheduler.runtime

Base class for all checked exceptions thrown by the NetWeaver Scheduler for Java.

SchedulerException() - Constructor for exception com.sap.scheduler.runtime.SchedulerException

Constructs a new SchedulerException with no message.

SchedulerException(String) - Constructor for exception com.sap.scheduler.runtime.SchedulerException

Constructs a new SchedulerException with a message string.

SchedulerException(String, Throwable) - Constructor for exception com.sap.scheduler.runtime.SchedulerException

Constructs a new SchedulerException with a message and a throwable.

SchedulerException(Throwable) - Constructor for exception com.sap.scheduler.runtime.SchedulerException

Constructs a new SchedulerException with a throwable.

SchedulerID - Class in com.sap.scheduler.runtime

Uniquely identifies a Job instance.

SchedulerID() - Constructor for class com.sap.scheduler.runtime.SchedulerID

Deprecated. This constructor is intended to be used only by XML serialization/deserializtion. In order to create new instances of this class use one of the static methods

SchedulerRuntimeException - Exception in com.sap.scheduler.runtime

A SchedulerRuntimeException can be thrown by the scheduler in case there is a problem to fulfill the request.

SchedulerRuntimeException(String) - Constructor for exception com.sap.scheduler.runtime.SchedulerRuntimeException

SchedulerRuntimeException(String, Throwable) - Constructor for exception com.sap.scheduler.runtime.SchedulerRuntimeException

Create a SchedulerRuntimeException with a message, cause and code.

SchedulerTask - Class in com.sap.scheduler.api

SchedulerTask(SchedulerTaskID, JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[]) - Constructor for class com.sap.scheduler.api.SchedulerTask

Deprecated. - please use create-method instead Constructs a new SchedulerTask instance with the specified id, job definition id, parameters and schedule. When an object is created with this constructor a call to getRetentionPeriod would throw IllegalStateException and isRetentionDefault would return true.

SchedulerTask(SchedulerTaskID, JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[], Filter[], int) - Constructor for class com.sap.scheduler.api.SchedulerTask

Deprecated. - please use create-method instead Constrcuts a new SchedulerTas instance with the specified parameters. Weh an object is created with this construtor isRetentionDefault would return false and getRetentionPeriod would return the value of the retentionPeriod argument.

SchedulerTask(SchedulerTaskID, JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[], String, String) - Constructor for class com.sap.scheduler.api.SchedulerTask

Deprecated. - please use create-method instead Constrcuts a new SchedulerTas instance with the specified parameters. Weh an object is created with this construtor isRetentionDefault would return false and getRetentionPeriod would return the value of the retentionPeriod argument.

SchedulerTask(SchedulerTaskID, JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[], String, String, String) - Constructor for class com.sap.scheduler.api.SchedulerTask

Deprecated. - please use create-method instead Constrcuts a new SchedulerTas instance with the specified parameters. Weh an object is created with this construtor isRetentionDefault would return false and getRetentionPeriod would return the value of the retentionPeriod argument.

SchedulerTask(SchedulerTaskID, JobDefinitionID, JobParameter[], RecurringEntry[], CronEntry[], Filter[], int, String, String, String) - Constructor for class com.sap.scheduler.api.SchedulerTask

Deprecated. - please use create-method instead Constrcuts a new SchedulerTas instance with the specified parameters. Weh an object is created with this construtor isRetentionDefault would return false and getRetentionPeriod would return the value of the retentionPeriod argument.

SchedulerTaskID - Class in com.sap.scheduler.api

SchedulerTime - Class in com.sap.scheduler.api

This class represents a scheduler time

SchedulerTime() - Constructor for class com.sap.scheduler.api.SchedulerTime

Constructs a scheduler time object with the current time

SchedulerTime(Date, TimeZone) - Constructor for class com.sap.scheduler.api.SchedulerTime

Constructs a scheduler time object with specified time and time zone

SchedulerTime(long, TimeZone) - Constructor for class com.sap.scheduler.api.SchedulerTime

Constructs a scheduler time object with specified time and time zone

serialVersionUID - Static variable in class com.sap.scheduler.runtime.AbstractIdentifier

Serial Version UID.

setBoloeanValue(Boolean) - Method in class com.sap.scheduler.runtime.JobParameter

setBooleanValue(boolean) - Method in class com.sap.scheduler.runtime.JobParameter

setBytes(byte[]) - Method in class com.sap.scheduler.runtime.AbstractIdentifier

This method sets the guid contained in this AbstractIdentifier.

setBytesNoCloneAndCheck(byte[]) - Method in class com.sap.scheduler.runtime.AbstractIdentifier

Sets the byte representation of guid for this identity object.

setCancelRequest(boolean) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setDateValue(Date) - Method in class com.sap.scheduler.runtime.JobParameter

setDays_of_month(CronDOMField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

setDays_of_week(CronDOWField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

setDefaultData(String) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setDescription(String) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor accipting a description argument.

setDescription(String) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setDirection(String) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setDisplay(boolean) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setDoubleValue(Double) - Method in class com.sap.scheduler.runtime.JobParameter

setEndDate(Date) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setEndDate(Date) - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

setEndedFrom(Date) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which ended after the given point in time

setEndedTo(Date) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which ended before the given point in time

setFilters(SchedulerTaskID, Filter[]) - Method in interface com.sap.scheduler.api.Scheduler

Sets filters for the specified task.

setFloatValue(Float) - Method in class com.sap.scheduler.runtime.JobParameter

setGroup(String) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setHours(CronHourField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

setId(byte[]) - Method in class com.sap.scheduler.runtime.Event

Deprecated. Event id is not used

setId(JobID) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setIntegerValue(int) - Method in class com.sap.scheduler.runtime.JobParameter

setJobDefinitionId(JobDefinitionID) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setJobDefinitionId(JobDefinitionID) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor acceptiong JobDefintionID argument.

setJobDefinitionId(JobDefinitionID) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all instances of the given job definition

setJobId(JobID) - Method in class com.sap.scheduler.runtime.JobFilter

Selects the specified job.

setJobId(JobID) - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

setJobParameter(JobParameter) - Method in interface com.sap.scheduler.runtime.JobContext

Update the runtime with the given JobParameter.

setJobParameterGeneric(String, Object) - Method in interface com.sap.scheduler.runtime.JobContext

Set a job parameter.

setJobs(Job[]) - Method in class com.sap.scheduler.runtime.JobIterator

Method to be used by the scheduler runtime only!

setJobStatus(JobStatus) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setJobStatus(JobStatus) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs with the specified status.

setJobType(int) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor accipting a parameters argument.

setLocalizationInfoMap(HashMap<String, HashMap<String, String>>) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. use constructor instead

setLocalizationInfoMap(HashMap<String, HashMap<String, String>>) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setLog(String) - Method in class com.sap.scheduler.runtime.LogIterator

Method to be used by the scheduler runtime only!

setLongValue(Long) - Method in class com.sap.scheduler.runtime.JobParameter

setLongValue(long) - Method in class com.sap.scheduler.runtime.JobParameter

setMessageDrivenContext(MessageDrivenContext) - Method in class com.sap.scheduler.runtime.mdb.MDBJobImplementation

setMinutes(CronMinuteField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

setMonths(CronMonthField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

setMoreChunks(boolean) - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

setName(String) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setName(String) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor accepting a JobDefinitionName argument.

setName(String) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs with the specified job-name.

setName(String) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setNode(String) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setNode(String) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which were executed on a particular node

setNullable(boolean) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setParameters(JobParameterDefinition[]) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor accepting a parameters argument.

setParent(JobID) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setParentId(JobID) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which are children of the specified parent job

setPos(long) - Method in class com.sap.scheduler.runtime.LogIterator

Method to be used by the scheduler runtime only!

setProperties(String[][]) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - intended to be used only by XML Seriliazliation/deserialization framework. Instead of this method use the JobDefinition.putProperty(String, String) method

setPropertiesValue(Properties) - Method in class com.sap.scheduler.runtime.JobParameter

setRetentionPeriod(int) - Method in class com.sap.scheduler.runtime.JobDefinition

Deprecated. - used only for XML Serialization/Deserialization. Instead of using this method use a constructor accepting a parameters argument.

setReturnCode(short) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setReturnCode(short) - Method in interface com.sap.scheduler.runtime.JobContext

Set the job return code.

setReturnCode(Short) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs with the specified return code

setScheduler(SchedulerID) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setScheduler(SchedulerID) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which were triggered by the specified scheduler

setSchedulerTaskId(SchedulerTaskID) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which were triggered by the specified scheduler task.

setStartDate(Date) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setStartedFrom(Date) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which started after the given point in time.

setStartedTo(Date) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which started before the given point in time.

setStringValue(String) - Method in class com.sap.scheduler.runtime.JobParameter

setSubmitDate(Date) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setTable(int) - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

setType(JobParameterType) - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Deprecated. use constructor instead

setUser(String) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setUserId(String) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs which ran under the specified user id.

setValue(Object) - Method in class com.sap.scheduler.runtime.JobParameter

setVendorData(String) - Method in class com.sap.scheduler.runtime.Job

Deprecated. use the constructor

setVendorData(String) - Method in class com.sap.scheduler.runtime.JobFilter

Selects all jobs with the specified vendor data.

setYears(CronYearField) - Method in class com.sap.scheduler.api.CronEntry

Setter method

STARTING - Static variable in class com.sap.scheduler.runtime.JobStatus

The job is currently being started by the job execution runtime (e.g. the JMS messages has been sent but was not yet received by the job).

STATUS_ACT_INITIAL_API - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been created by an API-call

STATUS_ACT_INITIAL_ZEROADMIN - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been created by a ZeroAdmin template

STATUS_ACT_TO_FIN_CANCELLED_API - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been finished because it has been cancelled by an API-call

STATUS_ACT_TO_FIN_CANCELLED_ZEROADMIN - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been finished because it has been cancelled by ZeroAdmin logic

STATUS_ACT_TO_FIN_FINISHED - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been finished due to no execution times are left

STATUS_ACT_TO_FIN_UNDEPLOYED - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been finished due to the JobDefinition has been undeployed

STATUS_ACT_TO_HOLD_API - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been set to hold due to an API-call

STATUS_ACT_TO_HOLD_ERROR - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been set to hold due to error reasons

STATUS_ACTIVE - Static variable in class com.sap.scheduler.api.TaskStatus

This class represents the TaskStatus.

STATUS_CHANGED_MAP - Static variable in class com.sap.scheduler.api.TaskStatus

STATUS_FINISHED - Static variable in class com.sap.scheduler.api.TaskStatus

STATUS_HOLD - Static variable in class com.sap.scheduler.api.TaskStatus

STATUS_HOLD_TO_ACT_API - Static variable in class com.sap.scheduler.api.TaskStatus

Task has been released because it has been set to active by an API-call

STATUS_MAP - Static variable in class com.sap.scheduler.api.TaskStatus

strEntry - Variable in class com.sap.scheduler.api.CronField

STRING - Static variable in class com.sap.scheduler.runtime.JobParameterType

T

TABLE_JOBS - Static variable in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

TABLE_JOBS_ALL - Static variable in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

TABLE_JOBS_CO - Static variable in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

TASK_SOURCE_SCHEDULER_API - Static variable in class com.sap.scheduler.api.SchedulerTask

TASK_SOURCE_ZERO_ADMIN - Static variable in class com.sap.scheduler.api.SchedulerTask

TaskDoesNotExistException - Exception in com.sap.scheduler.api

This exception is thrown when a task is accessed which does not exist anymore.

TaskDoesNotExistException(String) - Constructor for exception com.sap.scheduler.api.TaskDoesNotExistException

TaskDoesNotExistException(SchedulerTaskID, IUser) - Constructor for exception com.sap.scheduler.api.TaskDoesNotExistException

taskId - Variable in class com.sap.scheduler.api.Scheduler.FireTimeEvent

The id of the task whose particular expiration is represented by this object.

TaskNotCancelableException - Exception in com.sap.scheduler.api

Deprecated. This exception will never be thrown

TaskNotCancelableException() - Constructor for exception com.sap.scheduler.api.TaskNotCancelableException

Deprecated.

TaskNotCancelableException(String) - Constructor for exception com.sap.scheduler.api.TaskNotCancelableException

Deprecated.

TaskNotCancelableException(Throwable) - Constructor for exception com.sap.scheduler.api.TaskNotCancelableException

Deprecated.

TaskNotCancelableException(String, Throwable) - Constructor for exception com.sap.scheduler.api.TaskNotCancelableException

Deprecated.

TaskStatus - Class in com.sap.scheduler.api

TaskStatus(short, short) - Constructor for class com.sap.scheduler.api.TaskStatus

TaskValidationException - Exception in com.sap.scheduler.api

A TaskValidationException is thrown on a problem with the task provided.

TaskValidationException() - Constructor for exception com.sap.scheduler.api.TaskValidationException

TaskValidationException(String) - Constructor for exception com.sap.scheduler.api.TaskValidationException

TaskValidationException(String, Throwable) - Constructor for exception com.sap.scheduler.api.TaskValidationException

TaskValidationException(Throwable) - Constructor for exception com.sap.scheduler.api.TaskValidationException

time - Variable in class com.sap.scheduler.api.Scheduler.FireTimeEvent

Time of the particular expiration represented by this object.

timeMillis() - Method in class com.sap.scheduler.api.SchedulerTime

Getter method

toFormattedString() - Method in class com.sap.scheduler.api.SchedulerTask

Returns this SchedulerTask in a formatted way

toFormattedString() - Method in class com.sap.scheduler.runtime.Job

toFormattedString() - Method in class com.sap.scheduler.runtime.JobParameterDefinition

Returns this JobParameterDefinition in a formatted way

TooManyFireEventsException - Exception in com.sap.scheduler.api

TooManyFireEventsException() - Constructor for exception com.sap.scheduler.api.TooManyFireEventsException

TooManyFireEventsException(String) - Constructor for exception com.sap.scheduler.api.TooManyFireEventsException

TooManyFireEventsException(Throwable) - Constructor for exception com.sap.scheduler.api.TooManyFireEventsException

TooManyFireEventsException(String, Throwable) - Constructor for exception com.sap.scheduler.api.TooManyFireEventsException

toString() - Method in class com.sap.scheduler.api.CronEntry

Returns a string representation of the entry

toString() - Method in class com.sap.scheduler.api.CronField

Returns a string representation of the cron field

toString() - Method in class com.sap.scheduler.api.Filter

Returns a string representation of the filter

toString() - Method in class com.sap.scheduler.api.RecurringEntry

Returns a string representarion of the recuring entry

toString() - Method in class com.sap.scheduler.api.TaskStatus

Returns the status as String, without description.

toString() - Method in class com.sap.scheduler.runtime.AbstractIdentifier

Obtains a hex-string representation of this GUID

toString() - Method in class com.sap.scheduler.runtime.Event

toString() - Method in class com.sap.scheduler.runtime.JobDefinition

Obtains a string representation of this instance.

toString() - Method in class com.sap.scheduler.runtime.JobDefinitionName

Returns the name of this job definition as a string.

toString(int) - Static method in class com.sap.scheduler.runtime.JobDefinitionType

toString() - Method in class com.sap.scheduler.runtime.JobFilter

toString() - Method in class com.sap.scheduler.runtime.JobIterator.StateDescriptor

toString() - Method in class com.sap.scheduler.runtime.JobParameter

toString() - Method in class com.sap.scheduler.runtime.JobParameterType

toString() - Method in class com.sap.scheduler.runtime.JobStatus

U

UNKNOWN - Static variable in class com.sap.scheduler.runtime.JobStatus

The job is in an unknown state.

V

validate(String) - Method in class com.sap.scheduler.api.CronEntry

Validates a cron entry

validate(String, int) - Static method in class com.sap.scheduler.api.CronField

value() - Method in class com.sap.scheduler.runtime.JobStatus

valueOf(String) - Method in class com.sap.scheduler.runtime.JobParameter

valueOf(String) - Static method in class com.sap.scheduler.runtime.JobParameterType

valueOf(String) - Static method in class com.sap.scheduler.runtime.JobStatus

valueOf(short) - Static method in class com.sap.scheduler.runtime.JobStatus

W

waitForChildJobs() - Method in interface com.sap.scheduler.runtime.JobContext

Wait for all child jobs to finish.

waitForChildJobs(long) - Method in interface com.sap.scheduler.runtime.JobContext

Wait for all child jobs to finish.

waitForChildJobs(JobID[]) - Method in interface com.sap.scheduler.runtime.JobContext

Wait for the specified child jobs to wait for.

waitForChildJobs(JobID[], long) - Method in interface com.sap.scheduler.runtime.JobContext

Wait for the specified child jobs to complete.

A B C D E F G H I J L M N O P R S T U V W