Schedule

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

All Superinterfaces:

java.io.Serializable, XMLizable

All Known Implementing Classes:

DateRangeSchedule, PromotionSchedule, TimeRangeSchedule, TimeRangeWithinADaySchedule, WeekDaySchedule
```
public interface Schedule
extends XMLizable
```
Promotions are active during certain periods of time and the definition of these time periods is called promotion schedule.

Field Summary

Fields
Modifier and Type	Field and Description
`static int[]`	`ALL_WEEK_LONG` Constant, entire week
`static java.lang.String`	`COPYRIGHT` IBM Copyright
`static java.util.Date`	`END_OF_THE_DAY` constant, end of the day
`static java.util.Date`	`END_OF_TIME` Constant the end of time
`static java.util.Date`	`START_OF_THE_DAY` constant start of the day
`static java.util.Date`	`START_OF_TIME` Constant the beginning of time

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Date`	`getOverallEndDate()` Returns the overall end date of this schedule
`java.util.Date`	`getOverallStartDate()` Returns the overall start date of this schedule
`boolean`	`isActive()` Checks to see if a schedule is active or not
`boolean`	`isActiveAsOf(java.util.Date theTime)` Checks to see if a schedule is active at a certain time

Methods inherited from interface com.ibm.commerce.marketing.promotion.xml.XMLizable
fromXML, toXML

- Field Detail
  - COPYRIGHT
```
static final java.lang.String COPYRIGHT
```
    IBM Copyright
    
    See Also:
    
    Constant Field Values
  - START_OF_TIME
```
static final java.util.Date START_OF_TIME
```
    Constant the beginning of time
  - END_OF_TIME
```
static final java.util.Date END_OF_TIME
```
    Constant the end of time
  - START_OF_THE_DAY
```
static final java.util.Date START_OF_THE_DAY
```
    constant start of the day
  - END_OF_THE_DAY
```
static final java.util.Date END_OF_THE_DAY
```
    constant, end of the day
  - ALL_WEEK_LONG
```
static final int[] ALL_WEEK_LONG
```
    Constant, entire week
- Method Detail
  - isActive
```
boolean isActive()
```
    Checks to see if a schedule is active or not
    
    Returns:
    
    true if the schedule is active, false otherwise
  - isActiveAsOf
```
boolean isActiveAsOf(java.util.Date theTime)
```
    Checks to see if a schedule is active at a certain time
    
    Parameters:
    
    theTime - the "certain time"
    
    Returns:
    
    true, if the schedule is active at that time, false otherwise
  - getOverallStartDate
```
java.util.Date getOverallStartDate()
```
    Returns the overall start date of this schedule
    
    Returns:
    
    the overall start date of this schedule
  - getOverallEndDate
```
java.util.Date getOverallEndDate()
```
    Returns the overall end date of this schedule
    
    Returns:
    
    the overall end date of this schedule