|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface BusinessIntervalFactory
Creates and manipulates BusinessInterval objects.
Method Summary | |
---|---|
BusinessInterval |
makeBusinessInterval(java.lang.String name)
Returns a new BusinessInterval with the specified name. |
flux.dev.BusinessIntervalComponent |
makeBusinessIntervalForDay(java.lang.String name,
java.util.Date day)
Returns a new BusinessIntervalComponent that represents a single calendar day. |
flux.dev.BusinessIntervalComponent |
makeBusinessIntervalForDay(java.lang.String name,
java.util.Date day,
java.lang.String repeatTimeExpression)
Returns a new BusinessIntervalComponent that represents an all day interval that repeats according to repeatTimeExpression. |
flux.dev.BusinessIntervalComponent |
makeBusinessIntervalForever()
Returns a new BusinessIntervalComponent that represents all time. |
flux.dev.BusinessIntervalComponent |
makeBusinessIntervalForRange(java.lang.String name,
java.util.Date start,
java.util.Date stop,
java.lang.String duration,
java.lang.String repeatTimeExpression,
int count)
Returns a new BusinessIntervalComponent that represents an interval with an arbitrary duration, starting at the specified start date (inclusive), ending at the specified end date (exclusive), and repeating according to repeatTimeExpression for the specified number of times. |
flux.dev.BusinessIntervalComponent |
makeBusinessIntervalForRange(java.lang.String name,
java.util.Date start,
java.lang.String duration,
java.lang.String repeatTimeExpression)
Returns a new BusinessIntervalComponent that represents an interval with an arbitrary duration, starting at the specified start date (inclusive), and repeating according to repeatTimeExpression. |
BusinessInterval |
makeCustomBusinessInterval(flux.dev.AllowableBusinessIntervalDev customBusinessInterval)
Creates a custom BusinessInterval from an AllowableBusinessIntervalDev object. |
BusinessInterval |
makeDifference(BusinessInterval left,
BusinessInterval right)
Performs the set operation "difference" on the intervals, "left difference right". |
BusinessInterval |
makeDifference(java.lang.String name,
BusinessInterval left,
BusinessInterval right)
Performs the set operation "difference" on the intervals, "left difference right". |
BusinessInterval |
makeFridayWeekend()
Returns a pre-defined business interval that excludes Fridays. |
BusinessInterval |
makeIntersection(BusinessInterval left,
BusinessInterval right)
Performs the set operation "intersection" on the intervals, "left intersection right". |
BusinessInterval |
makeIntersection(java.lang.String name,
BusinessInterval left,
BusinessInterval right)
Performs the set operation "intersection" on the intervals, "left intersection right". |
BusinessInterval |
makeSaturdaySundayWeekend()
Returns a business interval that excludes Saturdays and Sundays. |
BusinessInterval |
makeSaturdayWeekend()
Returns a pre-defined business interval that excludes Saturdays. |
BusinessInterval |
makeSundayWeekend()
Returns a pre-defined business interval that excludes Sundays. |
BusinessInterval |
makeUnion(BusinessInterval left,
BusinessInterval right)
Performs the set operation "union" on the intervals, "left union right". |
BusinessInterval |
makeUnion(java.lang.String name,
BusinessInterval left,
BusinessInterval right)
Performs the set operation "union" on the intervals, "left union right". |
BusinessInterval |
makeUsFederalHolidays()
Returns a pre-defined business interval that excludes federal holidays in the United States. |
Method Detail |
---|
BusinessInterval makeBusinessInterval(java.lang.String name)
name
- The name of the new BusinessInterval.
flux.dev.BusinessIntervalComponent makeBusinessIntervalForDay(java.lang.String name, java.util.Date day) throws EngineException
name
- The name of the component.day
- The starting calendar day. The time component of day is
ignored.
EngineException
- If day is null.flux.dev.BusinessIntervalComponent makeBusinessIntervalForDay(java.lang.String name, java.util.Date day, java.lang.String repeatTimeExpression) throws EngineException
name
- The name of the component.day
- The starting calendar day. The time component of day is
ignored.repeatTimeExpression
- Applied to start to determine the start of the
next interval.
EngineException
- If repeatTimeExpression is an invalid time
expression.flux.dev.BusinessIntervalComponent makeBusinessIntervalForever()
flux.dev.BusinessIntervalComponent makeBusinessIntervalForRange(java.lang.String name, java.util.Date start, java.util.Date stop, java.lang.String duration, java.lang.String repeatTimeExpression, int count) throws EngineException
name
- The name of the component.start
- The starting date (inclusive).stop
- The date when this interval is no longer
applied (exclusive).duration
- The duration of one interval.repeatTimeExpression
- Applied to start to determine the start of the
next interval.count
- The repeat count.
EngineException
- If repeatTimeExpression is an invalid time
expression.flux.dev.BusinessIntervalComponent makeBusinessIntervalForRange(java.lang.String name, java.util.Date start, java.lang.String duration, java.lang.String repeatTimeExpression) throws EngineException
name
- The name of the component.start
- The starting date (inclusive).duration
- The duration of one interval.repeatTimeExpression
- Applied to start to determine the start of the
next interval.
EngineException
- If repeatTimeExpression is an invalid time
expression.BusinessInterval makeCustomBusinessInterval(flux.dev.AllowableBusinessIntervalDev customBusinessInterval)
customBusinessInterval
- A custom business interval for calling out to
external software systems for business
interval, calendar, and holiday information.
BusinessInterval makeDifference(BusinessInterval left, BusinessInterval right)
left
- The left operand.right
- The right operand.
BusinessInterval makeDifference(java.lang.String name, BusinessInterval left, BusinessInterval right)
name
- The name of the result interval.left
- The left operand.right
- The right operand.
BusinessInterval makeIntersection(BusinessInterval left, BusinessInterval right)
left
- The left operand.right
- The right operand.
BusinessInterval makeIntersection(java.lang.String name, BusinessInterval left, BusinessInterval right)
name
- The name of the result interval.left
- The left operand.right
- The right operand.
BusinessInterval makeFridayWeekend()
BusinessInterval makeSaturdayWeekend()
BusinessInterval makeSaturdaySundayWeekend()
BusinessInterval makeSundayWeekend()
BusinessInterval makeUnion(BusinessInterval left, BusinessInterval right)
left
- The left operand.right
- The right operand.
BusinessInterval makeUnion(java.lang.String name, BusinessInterval left, BusinessInterval right)
name
- The name of the result interval.left
- The left operand.right
- The right operand.
BusinessInterval makeUsFederalHolidays()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |