com.ibm.commerce.marketing.promotion.schedule

Class WeekDaySchedule

java.lang.Object

com.ibm.commerce.marketing.promotion.schedule.WeekDaySchedule

All Implemented Interfaces:

Schedule, ScheduleLookAheadSupport, XMLizable, java.io.Serializable

public class WeekDaySchedule
extends java.lang.Object
implements Schedule, ScheduleLookAheadSupport

This class is used to define the days of the week that the promotion is in active state.

XML Snippet for WeekDaySchedule:

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

See Also:

Serialized Form

Field Summary

Fields

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

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
WeekDaySchedule() Default constructor
WeekDaySchedule(int[] activeWeekDays) Constructor

Method Summary

Modifier and Type	Method and Description
void	calculateNextStateAndExpirationTime() Calculates the next state shift time and the next state
int	clockResolution() Returns the constant for time resolution unit "Day"
boolean	currentState() Returns the current schedule state
java.util.Date	currentStateValidUntil() Returns the next status change time
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[]	getWeekDays() Returns the weekDays represented by an array of boolean
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 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

WeekDaySchedule

public WeekDaySchedule()

Default constructor

WeekDaySchedule

public WeekDaySchedule(int[] activeWeekDays)

Constructor

Parameters:

activeWeekDays - days of the week, in which the schedule is active

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

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

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

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

Returns:

The string format of the XML that represents this XMLizable object

Throws:

XMLizationException - when this process fails

See Also:

XMLizable.toXML()

clockResolution

public int clockResolution()

Returns the constant for time resolution unit "Day"

Specified by:

clockResolution in interface ScheduleLookAheadSupport

Returns:

clock resolution in form of integer

currentState

public boolean currentState()

Returns the current schedule state

Specified by:

currentState in interface ScheduleLookAheadSupport

Returns:

current schedule state

currentStateValidUntil

public java.util.Date currentStateValidUntil()

Description copied from interface: ScheduleLookAheadSupport

Returns the next status change time

Specified by:

currentStateValidUntil in interface ScheduleLookAheadSupport

Returns:

next status change time

See Also:

ScheduleLookAheadSupport.currentStateValidUntil()

calculateNextStateAndExpirationTime

public void calculateNextStateAndExpirationTime()

Calculates the next state shift time and the next state

Specified by:

calculateNextStateAndExpirationTime in interface ScheduleLookAheadSupport

getOverallStartDate

public java.util.Date getOverallStartDate()

Returns the overall start date, always return Schedule.START_OF_TIME

Specified by:

getOverallStartDate in interface Schedule

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

Returns:

overall end date

getWeekDays

public boolean[] getWeekDays()

Returns the weekDays represented by an array of boolean

Returns:

the weekDays represented by an array of boolean