filenet.vw.api

Class VWWorkDayDefinition

java.lang.Object

filenet.vw.api.VWWorkDayDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Use this class to create, read, delete, or modify Work 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.
int	getCutOffTime() Gets the cut off time value for this work day definition.
int	getDayIndex() Gets the day index of this work day definition.
VWTimeIntervalDefinition[]	getTimeIntervalDefinitions() Get the time interval definitions for this work day definition.
void	setCutOffTime(int theCutOffTime) Sets the cut off time for this work day definition.
void	setTimeIntervalDefinitions(VWTimeIntervalDefinition[] theTimeIntervalDefinitions) Sets the time interval definitions for this work day definition.

Methods inherited from class java.lang.Object

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

Method Detail

getDayIndex

public int getDayIndex()
                throws VWException

Gets the day index of this work day definition.

Returns:

An index representing the day for this work day definition. The value will be within the range (VWWorkScheduleDefinition.DAY_SUNDAY - VWWorkScheduleDefinition.DAY_SATURDAY)

Throws:

VWException - Thrown for various reasons.

Since:

CPE 5.2.0.3

getCutOffTime

public int getCutOffTime()

Gets the cut off time value for this work 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:

VWWorkDayDefinition.setCutOffTime(int)

setCutOffTime

public void setCutOffTime(int theCutOffTime)
                   throws VWException

Sets the cut off time for this work 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

getTimeIntervalDefinitions

public VWTimeIntervalDefinition[] getTimeIntervalDefinitions()
                                                      throws VWException

Get the time interval definitions for this work day definition.

Returns:

An array of time interval definition objects defined for this work 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:

VWWorkDayDefinition.getTimeIntervalDefinitions()

setTimeIntervalDefinitions

public void setTimeIntervalDefinitions(VWTimeIntervalDefinition[] theTimeIntervalDefinitions)
                                throws VWException

Sets the time interval definitions for this work 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