filenet.vw.api

Class VWSpecialDayDefinition

java.lang.Object

filenet.vw.api.VWSpecialDayDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public final class VWSpecialDayDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable

Use this class to create, read, delete, or modify Special day definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
VWTimeIntervalDefinition	createTimeIntervalDefinition(int startTime, int endTime) Creates a new time interval definition.
java.lang.String	getAuthoredName() Gets the authored name assigned to Special Day definition.
int	getCutOffTime() Gets the cut off time value for this special day definition.
int	getDay() Gets the day value.
int	getMonth() Gets the month value.
java.lang.String	getName() Gets the name of this special day definition.
VWTimeIntervalDefinition[]	getTimeIntervalDefinitions() Gets the time interval definitions for this special day definition.
int	getYear() Gets the year value.
void	setCutOffTime(int theCutOffTime) Sets the cut off time for this special day definition.
void	setDate(int theMonth, int theDay, int theYear) Sets the date value for this special day definition.
void	setName(java.lang.String theName) Sets the name of this special day definition.
void	setTimeIntervalDefinitions(VWTimeIntervalDefinition[] theTimeIntervalDefinitions) Sets the time interval definitions for this special day definition.

Methods inherited from class java.lang.Object

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

Method Detail

getName

public java.lang.String getName()
                         throws VWException

Gets the name of this special day definition. If a translated version exists, that version is returned.

Returns:

A String containing the name of this special day definition.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

getAuthoredName

public java.lang.String getAuthoredName()
                                 throws VWException

Gets the authored name assigned to Special Day definition.

Returns:

A String containing the authored name of this special day definition.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

setName

public void setName(java.lang.String theName)
             throws VWException

Sets the name of this special day definition.

Parameters:

theName - A String containing the name of this special day definition.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

getMonth

public int getMonth()

Gets the month value.

Returns:

A value within the range (VWWorkScheduleDefinition.MONTH_JANUARY - VWWorkScheduleDefinition.MONTH_DECEMBER).

Since:

CPE 5.2.0.3

getDay

public int getDay()

Gets the day value.

Returns:

A value within the range (1-31)

Since:

CPE 5.2.0.3

getYear

public int getYear()

Gets the year value.

Returns:

The year value.

Since:

CPE 5.2.0.3

setDate

public void setDate(int theMonth,
                    int theDay,
                    int theYear)
             throws VWException

Sets the date value for this special day definition.

Parameters:

theMonth - A value within the range (VWWorkScheduleDefinition.MONTH_JANUARY - VWWorkScheduleDefinition.MONTH_DECEMBER).

theDay - A value within the range (1-31)

theYear - A value of 1970 or greater

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

getTimeIntervalDefinitions

public VWTimeIntervalDefinition[] getTimeIntervalDefinitions()
                                                      throws VWException

Gets the time interval definitions for this special day definition.

Returns:

An array of time interval definition objects defined for this special day definition.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

createTimeIntervalDefinition

public VWTimeIntervalDefinition createTimeIntervalDefinition(int startTime,
                                                             int endTime)
                                                      throws VWException

Creates a new time interval definition. The time values specify the number of minutes from midnight (0). The maximum value is 24 hours (24 * 60).

Parameters:

startTime - The start time in minutes. A value of zero means 12:00 am.

endTime - The end time in minutes (must be greater than the start time).

Returns:

The new time interval definition object.

Throws:

VWException - thrown for various reasons.

Since:

CPE 5.2.0.3

See Also:

VWSpecialDayDefinition.getTimeIntervalDefinitions()

setTimeIntervalDefinitions

public void setTimeIntervalDefinitions(VWTimeIntervalDefinition[] theTimeIntervalDefinitions)
                                throws VWException

Sets the time interval definitions for this special day definition. The specified time intervals will be ordered by start time. Note: Make sure that there are no overlapping time intervals in the specified list.

Parameters:

theTimeIntervalDefinitions - An array of time interval definition objects that are to be defined for Work Day definition.

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getCutOffTime

public int getCutOffTime()

Gets the cut off time value for this special day definition.

Returns:

The cut off time. A value of zero means 12:00 am. -1 means the value is not set.

Since:

CPE 5.2.0.3

See Also:

VWSpecialDayDefinition.setCutOffTime(int)

setCutOffTime

public void setCutOffTime(int theCutOffTime)
                   throws VWException

Sets the cut off time for this special day definition. The value represents the number of minutes from midnight (0). The maximum value is 24 hours (24 * 60).

Parameters:

theCutOffTime - The cut off time in minutes. The value is the number of minutes from midnight (0). Specify -1 for no cut off value.

Throws:

VWException - Thrown if the cut off time is invalid.

Since:

CPE 5.2.0.3