com.appiancorp.suiteapi.process.calendar

Class WorkingCalendar

java.lang.Object

com.appiancorp.core.expr.calendar.PortableWorkingCalendar

com.appiancorp.suiteapi.process.calendar.WorkingCalendar

Direct Known Subclasses:

SystemCalendar

public class WorkingCalendar
extends com.appiancorp.core.expr.calendar.PortableWorkingCalendar

A bean representing a calendar. It contains the default start and end times for each day of the week, and start and end times for specific days. It also stores which days are working and non-working days.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	DEFAULT_CALENDAR_ID
static java.lang.Integer	SORT_BY_ID
static java.lang.Integer	SORT_BY_NAME

Fields inherited from class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

timeZoneId, TOO_MANY_ITERATIONS_BEFORE_RESULT_OR_LIMIT

Constructor Summary

Constructors

Constructor and Description
WorkingCalendar()

Method Summary

Modifier and Type	Method and Description
java.util.Calendar	addDays(java.util.Calendar base, int numberOfDays) Add given number of working days to the given Calendar, yielding another Calendar that is also a working time.
java.util.Calendar	addHours(java.util.Calendar startDateTime, int numberOfHours) Add given number of working hours to the given Calendar, yielding another Calendar that is also a working time.
java.util.Calendar	addMinutes(java.util.Calendar startDateTime, int numberOfMinutes) Add given number of working minutes to the given Calendar, yielding another Calendar that is also a working time.
java.util.Calendar	calendarFromTimestamp(java.sql.Timestamp timestamp, java.util.TimeZone defaultTimeZone) Create a Calendar from the given java.sql.Timestamp, adjusted for the configured TimeZone of the WorkingCalendar, or defaultTimeZone if none.
CalendarElement[][]	getDefaultDayOfWeek() Get the default start and end times for the days of the week.
java.lang.Boolean	getDisallowDelete() Get whether or not deleting this calendar is enabled or disabled.
java.lang.Long	getId() Gets the id of this calendar
java.lang.String	getName() Gets the calendar's name
CalendarDateElement[]	getSpecific() Get the start and end times for specific days.
java.lang.Boolean	getSystem() Get whether or not this is a system calendar.
java.util.TimeZone	getTimeZone()
java.lang.String	getTimeZoneId() Get the id of the time zone for this calendar.
static boolean	isNonWorking(CalendarElement[] day) Tells if the given day is a non working day or not.
boolean	isWorkingDay(java.util.Calendar calendar) Is the day represented by this Calendar object a working day according to this working calendar?
boolean	isWorkTime(java.util.Calendar calendar) Does this Calendar represent a working time?
void	setDefaultDayOfWeek(CalendarElement[][] defaultDayOfWeek) Set the default start and end times for the days of the week.
void	setDisallowDelete(java.lang.Boolean disallowDelete) Set whether or not deleting this calendar is enabled or disabled.
void	setId(java.lang.Long id) Sets the id of this calendar
void	setName(java.lang.String name) Sets the calendars name
void	setSpecific(CalendarDateElement[] specific) Sets the start and end times for specific days.
void	setSystem(java.lang.Boolean system) Set whether or not this is a system calendar.
void	setTimeZoneId(java.lang.String timeZoneId) Set the name of the time zone for this calendar.
java.lang.String	toString() Simple toString method.
int	workingDaysInRange(java.util.Calendar start, java.util.Calendar end) Count the number of working days in given range.
int	workingHoursInRange(java.util.Calendar start, java.util.Calendar end) Count the number of working hours in given range.
int	workingMinutesInRange(java.util.Calendar start, java.util.Calendar end) Count the number of working minutes in given range.

Methods inherited from class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

addDaysNoGmtAdjustment, addHoursNoGmtAdjustment, addMinutesNoGmtAdjustment, addMonthsNoGmtAdjustment, addSecondsNoGmtAdjustment, addYearsNoGmtAdjustment, adjustAddFinal, subtractDaysNoGmtAdjustment, subtractHoursNoGmtAdjustment, subtractMinutesNoGmtAdjustment, subtractMonthsNoGmtAdjustment, subtractSecondsNoGmtAdjustment, subtractYearsNoGmtAdjustment

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_CALENDAR_ID

public static final java.lang.Long DEFAULT_CALENDAR_ID

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Constructor Detail

WorkingCalendar

public WorkingCalendar()

Method Detail

getId

public java.lang.Long getId()

Gets the id of this calendar

Returns:

the id

setId

public void setId(java.lang.Long id)

Sets the id of this calendar

Parameters:

id -

getName

public java.lang.String getName()

Gets the calendar's name

Returns:

the name

setName

public void setName(java.lang.String name)

Sets the calendars name

Parameters:

name -

getDefaultDayOfWeek

public CalendarElement[][] getDefaultDayOfWeek()

Get the default start and end times for the days of the week. These CalendarElements define the default start and end times for the days of the week. The first dimension of the array is the day of the week where 0 = Sunday, 1 = Monday, ... , and 6 = Saturday. The second dimension is equal to the number of start-end pairs that can be defined for a day (currently four).

Specified by:

getDefaultDayOfWeek in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Returns:

Returns the defaultDayOfWeek.

See Also:

CalendarElement, setDefaultDayOfWeek(CalendarElement[][])

setDefaultDayOfWeek

public void setDefaultDayOfWeek(CalendarElement[][] defaultDayOfWeek)

Set the default start and end times for the days of the week.

Parameters:

defaultDayOfWeek - The defaultDayOfWeek to set.

See Also:

getDefaultDayOfWeek()

getDisallowDelete

public java.lang.Boolean getDisallowDelete()

Get whether or not deleting this calendar is enabled or disabled. A value of true means that deleting the calendar is not allowed.

Returns:

Whether or not deleting is allowed for this calendar.

See Also:

setDisallowDelete(Boolean)

setDisallowDelete

public void setDisallowDelete(java.lang.Boolean disallowDelete)

Set whether or not deleting this calendar is enabled or disabled.

Parameters:

disallowDelete - Whether or not deleting is allowed for this calendar.

See Also:

getDisallowDelete()

getSpecific

public CalendarDateElement[] getSpecific()

Get the start and end times for specific days. This array of CalendarDateElements defines start and end time pairs for specific dates. The size of the array is unbounded, and order does not matter. Therefore separate start and end pairs can be defined for the same date anywhere in the array.

Specified by:

getSpecific in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Returns:

The start and end times for specific days.

See Also:

CalendarDateElement, setSpecific(CalendarDateElement[])

setSpecific

public void setSpecific(CalendarDateElement[] specific)

Sets the start and end times for specific days.

Parameters:

specific - The start and end times to set for specific days.

See Also:

getSpecific();

getSystem

public java.lang.Boolean getSystem()

Get whether or not this is a system calendar.

Returns:

Whether or not this is a system calendar.

See Also:

setSystem(Boolean)

setSystem

public void setSystem(java.lang.Boolean system)

Set whether or not this is a system calendar.

Parameters:

system - Whether or not this is a system calendar.

See Also:

getSystem()

isNonWorking

public static boolean isNonWorking(CalendarElement[] day)

Tells if the given day is a non working day or not.

Parameters:

day - The day to find out if it's a non working day

Returns:

true if the day is a non working day.

toString

public java.lang.String toString()

Simple toString method. Use for informational purposes, as the format may change in the future.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of this working calendar

calendarFromTimestamp

public java.util.Calendar calendarFromTimestamp(java.sql.Timestamp timestamp,
                                                java.util.TimeZone defaultTimeZone)

Create a Calendar from the given java.sql.Timestamp, adjusted for the configured TimeZone of the WorkingCalendar, or defaultTimeZone if none.

Parameters:

timestamp -

defaultTimeZone -

Returns:

adjusted Calendar, suitable for passing to other WorkingCalendar informational methods expecting a Calendar

setTimeZoneId

public void setTimeZoneId(java.lang.String timeZoneId)

Set the name of the time zone for this calendar.

Overrides:

setTimeZoneId in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

timeZoneId - The time zone id to set for this calendar.

See Also:

getTimeZoneId()

getTimeZoneId

public java.lang.String getTimeZoneId()

Get the id of the time zone for this calendar.

Overrides:

getTimeZoneId in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Returns:

The time zone for this calendar.

See Also:

setTimeZoneId(String)

getTimeZone

public java.util.TimeZone getTimeZone()

Overrides:

getTimeZone in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Returns:

workingDaysInRange

public int workingDaysInRange(java.util.Calendar start,
                              java.util.Calendar end)

Count the number of working days in given range.

Overrides:

workingDaysInRange in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

start -

end -

Returns:

count of working days in given range, negative if start is after end.

workingHoursInRange

public int workingHoursInRange(java.util.Calendar start,
                               java.util.Calendar end)

Count the number of working hours in given range.

Overrides:

workingHoursInRange in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

start -

end -

Returns:

count of working days in given range, negative if start is after end.

workingMinutesInRange

public int workingMinutesInRange(java.util.Calendar start,
                                 java.util.Calendar end)

Count the number of working minutes in given range.

Overrides:

workingMinutesInRange in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

start -

end -

Returns:

count of working days in given range, negative if start is after end.

isWorkTime

public boolean isWorkTime(java.util.Calendar calendar)

Does this Calendar represent a working time?

Overrides:

isWorkTime in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

calendar -

Returns:

true if the given Calendar object represents a working time in this working calendar

isWorkingDay

public boolean isWorkingDay(java.util.Calendar calendar)

Is the day represented by this Calendar object a working day according to this working calendar? A day is a working day if any minute of that day is a working minute. Specific dates override day of week information.

Overrides:

isWorkingDay in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

calendar -

Returns:

true if the given Calendar object represents a working day in this working calendar

addDays

public java.util.Calendar addDays(java.util.Calendar base,
                                  int numberOfDays)

Add given number of working days to the given Calendar, yielding another Calendar that is also a working time. Will throw an IllegalArgumentException if the number to analyze exceeds 365 days of no working time, or is negative.

Overrides:

addDays in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

base -

numberOfDays - ; non-negative

Returns:

a Calendar object representing the date and time of the next working time the given number of days in the future

addHours

public java.util.Calendar addHours(java.util.Calendar startDateTime,
                                   int numberOfHours)

Add given number of working hours to the given Calendar, yielding another Calendar that is also a working time. Will throw an IllegalArgumentException if the number to analyze exceeds 365 days of no working time, or is negative.

Overrides:

addHours in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

startDateTime -

numberOfHours - ; non-negative

Returns:

a Calendar object representing the date and time of the next working time the given number of hours in the future

addMinutes

public java.util.Calendar addMinutes(java.util.Calendar startDateTime,
                                     int numberOfMinutes)

Add given number of working minutes to the given Calendar, yielding another Calendar that is also a working time. Will throw an IllegalArgumentException if the number to analyze exceeds 365 days of no working time, or is negative.

Overrides:

addMinutes in class com.appiancorp.core.expr.calendar.PortableWorkingCalendar

Parameters:

startDateTime -

numberOfMinutes - ; non-negative

Returns:

a Calendar object representing the date and time of the next working time the given number of minutes in the future