com.ibm.commerce.marketing.promotion.schedule

Class DateRangeSchedule

java.lang.Object

com.ibm.commerce.marketing.promotion.schedule.TimeRangeSchedule

com.ibm.commerce.marketing.promotion.schedule.DateRangeSchedule

All Implemented Interfaces:

Schedule, ScheduleLookAheadSupport, XMLizable, java.io.Serializable

public class DateRangeSchedule
extends TimeRangeSchedule

This class is used for representing the Date Range of a promotion where any promotion can be active during a certain period of time defined by a start and end date. The end time could be set to a very large number e.g. 11:59:59 PM, December 31, 9999, which effectively makes the promotion active all the time after the start date.

XML Snippet for DateRangeSchedule:

    <DateRange impl=
    "com.ibm.commerce.marketing.promotion.schedule.DateRangeSchedule">
        <Start inclusive="true">01-09-2003 13:15:30</Start>
        <End inclusive="true">31-12-2004 09:30:20</End>
    </DateRange>
 
 

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM Copyright

Fields inherited from class com.ibm.commerce.marketing.promotion.schedule.TimeRangeSchedule

INCLUDE_END, INCLUDE_START

Fields inherited from interface com.ibm.commerce.marketing.promotion.schedule.Schedule

ALL_WEEK_LONG, END_OF_THE_DAY, END_OF_TIME, START_OF_THE_DAY, START_OF_TIME

Fields inherited from interface com.ibm.commerce.marketing.promotion.schedule.ScheduleLookAheadSupport

DAY, HALF_AN_HOUR, HOUR, MINUTE, MONTH, QUARTER, SECOND, WEEK, YEAR

Constructor Summary

Constructors

Constructor and Description
DateRangeSchedule() Constructor
DateRangeSchedule(java.util.Date aStartTime, java.util.Date anEndTime) Constructor
DateRangeSchedule(java.util.Date aStartTime, java.util.Date anEndTime, boolean anIncludeStart, boolean anIncludeEnd) Constructor

Method Summary

Modifier and Type	Method and Description
void	fromXML(org.w3c.dom.Node node) Transforms the XML node into its corresponding real Object.
java.lang.String	toXML() Converts the object into its corresponding XML format representation.

Methods inherited from class com.ibm.commerce.marketing.promotion.schedule.TimeRangeSchedule

calculateNextStateAndExpirationTime, clockResolution, convertPromotionDatesToUTC, currentState, currentStateValidUntil, formatStringIntoDate, getEndTime, getOverallEndDate, getOverallStartDate, getStartTime, isActive, isActiveAsOf, isIncludeEnd, isIncludeStart, setEndTime, setIncludeEnd, setIncludeStart, setStartTime

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright

See Also:

Constant Field Values

Constructor Detail

DateRangeSchedule

public DateRangeSchedule()

Constructor

DateRangeSchedule

public DateRangeSchedule(java.util.Date aStartTime,
                         java.util.Date anEndTime)

Constructor

Parameters:

aStartTime - start date inclusive

anEndTime - end date inclusive

DateRangeSchedule

public DateRangeSchedule(java.util.Date aStartTime,
                         java.util.Date anEndTime,
                         boolean anIncludeStart,
                         boolean anIncludeEnd)

Constructor

Parameters:

aStartTime - start date

anEndTime - end date

anIncludeStart - whether or not include the start date & time

anIncludeEnd - whether or not include the end date & time

Method Detail

fromXML

public void fromXML(org.w3c.dom.Node node)
             throws DeXMLizationException

Description copied from interface: XMLizable

Transforms the XML node into its corresponding real Object.

Specified by:

fromXML in interface XMLizable

Overrides:

fromXML in class TimeRangeSchedule

Parameters:

node - The node that represents an XMLizable object

Throws:

DeXMLizationException - when this process fails

See Also:

XMLizable.fromXML(Node)

toXML

public java.lang.String toXML()
                       throws XMLizationException

Description copied from interface: XMLizable

Converts the object into its corresponding XML format representation.

Specified by:

toXML in interface XMLizable

Overrides:

toXML in class TimeRangeSchedule

Returns:

The string format of the XML that represents this XMLizable object

Throws:

XMLizationException - when this process fails

See Also:

XMLizable.toXML()