public class PromotionSchedule extends java.lang.Object implements Schedule
XML Snippet for PromotionSchedule:
<Schedule impl="com.ibm.commerce.marketing.promotion.schedule.PromotionSchedule"> <DateRange impl="com.ibm.commerce.marketing.promotion.schedule.DateRangeSchedule"> <Start inclusive="true">01-09-2003</Start> <End inclusive="true">31-12-2004</End> </DateRange> <TimeWithinADay impl="com.ibm.commerce.marketing.promotion.schedule.TimeRangeWithinADaySchedule"> <Start inclusive="true">00:00:00</Start> <End inclusive="false">23:59:59</End> </TimeWithinADay> <Week impl= "com.ibm.commerce.marketing.promotion.schedule.WeekDaySchedule"> <WeekDay>Sunday</WeekDay> <WeekDay>Monday</WeekDay> <WeekDay>Tuesday</WeekDay> <WeekDay>Wednesday</WeekDay> <WeekDay>Thursday</WeekDay> <WeekDay>Friday</WeekDay> <WeekDay>Saturday</WeekDay> </Week> </Schedule>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COPYRIGHT
IBM Copyright
|
ALL_WEEK_LONG, END_OF_THE_DAY, END_OF_TIME, START_OF_THE_DAY, START_OF_TIME
Constructor and Description |
---|
PromotionSchedule()
Constructor
|
PromotionSchedule(java.util.Date startDate,
java.util.Date endDate,
java.util.Date startTime,
java.util.Date endTime,
int[] activeWeekdays)
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
fromXML(org.w3c.dom.Node node)
Transforms the XML node into its corresponding real Object.
|
DateRangeSchedule |
getDateSchedule()
Gets the
DateRangeSchedule for promotion |
java.util.Date |
getOverallEndDate()
Returns overall end date
|
java.util.Date |
getOverallStartDate()
Returns overall start date
|
TimeRangeWithinADaySchedule |
getTimeWithinADaySchedule()
Gets the
TimeRangeWithinADaySchedule |
WeekDaySchedule |
getWeekdaySchedule()
Gets
WeekDaySchedule |
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
|
void |
setDateSchedule(DateRangeSchedule aDateRangeSchedule)
Sets the
DateRangeSchedule for promotion |
void |
setTimeWithinADaySchedule(TimeRangeWithinADaySchedule aTimeRangeWithinADaySchedule)
Sets the
TimeRangeWithinADaySchedule |
void |
setWeekdaySchedule(WeekDaySchedule aWeekDaySchedule)
Sets
WeekDaySchedule |
java.lang.String |
toXML()
Converts the object into its corresponding XML format representation.
|
public static final java.lang.String COPYRIGHT
public PromotionSchedule()
public PromotionSchedule(java.util.Date startDate, java.util.Date endDate, java.util.Date startTime, java.util.Date endTime, int[] activeWeekdays)
startDate
- start date, inclusiveendDate
- end date, inclusivestartTime
- start time in each day, inclusiveendTime
- end time in each day, inclusiveactiveWeekdays
- active weekdays, 0: Sunday, 1: Monday..... 5: Friday, 6: Saturdaypublic boolean isActive()
Schedule
public boolean isActiveAsOf(java.util.Date theTime)
Schedule
isActiveAsOf
in interface Schedule
theTime
- the "certain time"com.ibm.commerce.discount.mixmatch.Schedule#isActiveAsOf(Date)
public void fromXML(org.w3c.dom.Node node) throws DeXMLizationException
XMLizable
fromXML
in interface XMLizable
node
- The node that represents an XMLizable objectDeXMLizationException
- when this process failsXMLizable.fromXML(Node)
public java.lang.String toXML() throws XMLizationException
XMLizable
toXML
in interface XMLizable
XMLizationException
- when this process failsXMLizable.toXML()
public java.util.Date getOverallStartDate()
getOverallStartDate
in interface Schedule
public java.util.Date getOverallEndDate()
getOverallEndDate
in interface Schedule
public DateRangeSchedule getDateSchedule()
DateRangeSchedule
for promotionpublic void setDateSchedule(DateRangeSchedule aDateRangeSchedule)
DateRangeSchedule
for promotionaDateRangeSchedule
- the dateSchedule for promotion to setpublic TimeRangeWithinADaySchedule getTimeWithinADaySchedule()
TimeRangeWithinADaySchedule
public void setTimeWithinADaySchedule(TimeRangeWithinADaySchedule aTimeRangeWithinADaySchedule)
TimeRangeWithinADaySchedule
aTimeRangeWithinADaySchedule
- the timeWithinADaySchedule to setpublic WeekDaySchedule getWeekdaySchedule()
WeekDaySchedule
public void setWeekdaySchedule(WeekDaySchedule aWeekDaySchedule)
WeekDaySchedule
aWeekDaySchedule
- the weekdaySchedule to set