public interface ISchedulerTime
A ISchedulerTime
represents a time in an
ISchedulerTimeTable
when an ISchedulerTask
should
be executed by the IScheduler
.
Examples: every Friday at 10am: set(Calendar.FRIDAY, 10, 0);
or
every Day in September at 9pm: set(Calendar.SEPTEMBER, ISchedulerTime.WILDCARD, 21, 0);
Copyright 2004 SAP AG
ISchedulerTimeTable
Modifier and Type | Field and Description |
---|---|
static int |
WILDCARD
A 'dont care'-value for the several timetable fields (means 'any').
|
Modifier and Type | Method and Description |
---|---|
int |
get(int field)
Get time values, as in
Calendar . |
String |
getAsText()
Get the time in textual representation.
|
Set |
getAvailableTimeZones()
Returns a set of all time zones that can be set for this scheduler time.
|
TimeZone |
getTimeZone()
Returns the time zone this scheduler time belongs to.
|
boolean |
isAvailableTimeZone(TimeZone zone)
Checks whether a time zone can be set for this scheduler time or would be
replaced by the default time zone if set.
|
boolean |
matches(Calendar date)
Test, if a given date matches this time.
|
boolean |
set(int field,
int value)
Set time values, as in
Calendar . |
boolean |
setAsText(String text)
Set the time in a textual representation.
|
boolean |
setMonthDay(int year,
int month,
int monthday,
int hour,
int minute)
Set the time to the given values for month and monthday.
|
void |
setTimeZone(TimeZone zone)
Sets the time zone of this scheduler time belongs to.
|
boolean |
setWeekDay(int year,
int month,
int weekday,
int hour,
int minute)
Set the time to the given values for weekday.
|
boolean |
setWeekOfMonth(int year,
int month,
int weekday,
int weekofmonth,
int hour,
int minute)
Set the time to the given values for the week of the month.
|
static final int WILDCARD
boolean matches(Calendar date)
date
- the Calendar
with the date to check.boolean
true
if the date matches the
time, false
if it does not match.boolean setMonthDay(int year, int month, int monthday, int hour, int minute) throws WcmException
year
- an int
with the year (1900-2100).month
- an int
with the month (constants from
Calendar
)hour
- an int
with the hour (0-23).minute
- an int
with the minute (0-59)monthday
- The new monthDay valueboolean
true
if successful,
false
if not.WcmException
- if the time can not be set.boolean setWeekDay(int year, int month, int weekday, int hour, int minute) throws WcmException
year
- an int
with the year (1900-2100).month
- an int
with the month (constants from
Calendar
)weekday
- an int
with the weekday (use constants from
Calendar
)hour
- an int
with the hour (0-23)minute
- an int
with the minute (0-59)boolean
true
if successful,
false
if not.WcmException
- if the time can not be set.boolean setWeekOfMonth(int year, int month, int weekday, int weekofmonth, int hour, int minute) throws WcmException
year
- an int
with the year (1900-2100).month
- an int
with the month (constants from
Calendar
)weekday
- an int
with the weekday (use constants from
Calendar
)weekofmonth
- an int
with the week of the month (1-5)hour
- an int
with the hour (0-23)minute
- an int
with the minute (0-59)boolean
true
if successful,
false
if not.WcmException
- if the time can not be set.int get(int field) throws WcmException
Calendar
.field
- an int
which defines the field to get (constants
from Calendar
)int
with the value for that field.WcmException
- if the field can not be retrieved.boolean set(int field, int value) throws WcmException
Calendar
.field
- an int
which defines the field to set (constants
from Calendar
)value
- an int
with the value to set.boolean
true
if successful,
false
if not.WcmException
- if the field can not be set.String getAsText()
String
with the time in a textual
representation.setAsText(String)
boolean setAsText(String text) throws WcmException
text
- The new asText valueboolean
true
if successful,
false
if not (the String was not valid).WcmException
- Description of the ExceptionWcmException
- if the time can not be set.void setTimeZone(TimeZone zone) throws WcmException
zone
- The time zone this time belongs to.WcmException
- If the time zone could not be set.TimeZone getTimeZone() throws WcmException
WcmException
- If the time zone could not be retrieved.Set getAvailableTimeZones() throws WcmException
WcmException
- If the available time zones could not be retrieved.boolean isAvailableTimeZone(TimeZone zone) throws WcmException
zone
- The time zone to be checkedtrue
if the given time zone can be set for this
scheduler timeWcmException
- If the given time zone could not be checkedAccess Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2018 SAP AG Complete Copyright Notice