filenet.vw.api

Class VWTimeIntervalDefinition

java.lang.Object

filenet.vw.api.VWTimeIntervalDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

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

Use this class to create, read, delete, or modify Time Interval definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
int	getEndTime() Gets the end time value for this time interval definition.
int	getStartTime() Gets the start time value for this time interval definition.
void	setEndTime(int theEndTime) Sets the end time value for this time interval definition.
void	setStartTime(int theStartTime) Sets the start time value for this time interval definition.

Methods inherited from class java.lang.Object

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

Method Detail

getStartTime

public int getStartTime()

Gets the start time value for this time interval definition.

Returns:

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

Since:

CPE 5.2.0.3

See Also:

VWTimeIntervalDefinition.setStartTime(int)

setStartTime

public void setStartTime(int theStartTime)
                  throws VWException

Sets the start time value for this time interval definition.

Parameters:

theStartTime - The beginning of this time interval in minutes. Specify the number of minutes from midnight (0). A value of zero means 12:00 am. The maximum value is 24 hours (24 * 60).

Throws:

VWException - Thrown if the start time is less than 0 or greater than 24 hours (in minutes).

Since:

CPE 5.2.0.3

getEndTime

public int getEndTime()

Gets the end time value for this time interval definition.

Returns:

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

Since:

CPE 5.2.0.3

See Also:

VWTimeIntervalDefinition.setEndTime(int)

setEndTime

public void setEndTime(int theEndTime)
                throws VWException

Sets the end time value for this time interval definition. The value must be greater than the start time value.

Parameters:

theEndTime - The end of this time interval in minutes. Specify the number of minutes from midnight (0). A value of zero means 12:00 am. The maximum value is 24 hours (24 * 60).

Throws:

VWException - Thrown if the end time is less than the start time or greater than 24 hours (in minutes).

Since:

CPE 5.2.0.3