com.ibm.commerce.marketing.promotion.schedule

Class TimeRangeWithinADaySchedule

java.lang.Object

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

com.ibm.commerce.marketing.promotion.schedule.TimeRangeWithinADaySchedule

All Implemented Interfaces:

Schedule, ScheduleLookAheadSupport, XMLizable, java.io.Serializable

public class TimeRangeWithinADaySchedule
extends TimeRangeSchedule

This class extends the TimeRangeSchedule class and defines a time range within a day that the promotion is active.

XML Snippet for TimeRangeWithinADaySchedule:

   <TimeWithinADay impl="com.ibm.commerce.marketing.promotion.schedule.TimeRangeWithinADaySchedule">
                <Start inclusive="true">00:00:00</Start>
                <End inclusive="false">23:59:59</End>
   </TimeWithinADay>
 

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
TimeRangeWithinADaySchedule() Default constructor
TimeRangeWithinADaySchedule(java.util.Date aStartTime, java.util.Date anEndTime) Constructor
TimeRangeWithinADaySchedule(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.util.Date	getOverallEndDate() Returns the overall end date, always return Schedule.END_OF_TIME
java.util.Date	getOverallStartDate() Returns the overall start date, always return Schedule.START_OF_TIME
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
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, getStartTime, 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

TimeRangeWithinADaySchedule

public TimeRangeWithinADaySchedule()

Default constructor

TimeRangeWithinADaySchedule

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

Constructor

Parameters:

aStartTime - start time, inclusive

anEndTime - end time, inclusive

TimeRangeWithinADaySchedule

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

Constructor

Parameters:

aStartTime - start time

anEndTime - end time

anIncludeStart - whether start time is included in the active period of the schedule

anIncludeEnd - whether end time is included in the active period of the schedule

Method Detail

isActive

public boolean isActive()

Description copied from interface: Schedule

Checks to see if a schedule is active or not

Specified by:

isActive in interface Schedule

Overrides:

isActive in class TimeRangeSchedule

Returns:

true if the schedule is active, false otherwise

See Also:

com.ibm.commerce.discount.mixmatch.Schedule#isActive()

isActiveAsOf

public boolean isActiveAsOf(java.util.Date theTime)

Description copied from interface: Schedule

Checks to see if a schedule is active at a certain time

Specified by:

isActiveAsOf in interface Schedule

Overrides:

isActiveAsOf in class TimeRangeSchedule

Parameters:

theTime - the "certain time"

Returns:

true, if the schedule is active at that time, false otherwise

See Also:

com.ibm.commerce.discount.mixmatch.Schedule#isActiveAsOf(Date)

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()

getOverallStartDate

public java.util.Date getOverallStartDate()

Returns the overall start date, always return Schedule.START_OF_TIME

Specified by:

getOverallStartDate in interface Schedule

Overrides:

getOverallStartDate in class TimeRangeSchedule

Returns:

overall start date

getOverallEndDate

public java.util.Date getOverallEndDate()

Returns the overall end date, always return Schedule.END_OF_TIME

Specified by:

getOverallEndDate in interface Schedule

Overrides:

getOverallEndDate in class TimeRangeSchedule

Returns:

overall end date