VWWorkScheduleDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWWorkScheduleDefinition

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWWorkScheduleDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Use this class to create, read, delete, or modify work schedule definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAY_FRIDAY` Value of 5. Represents the day Friday.
`static int`	`DAY_MONDAY` Value of 1. Represents the day Monday.
`static int`	`DAY_SATURDAY` Value of 6. Represents the day Saturday.
`static int`	`DAY_SUNDAY` Value of 0. Represents the day Sunday.
`static int`	`DAY_THURSDAY` Value of 4. Represents the day Thursday.
`static int`	`DAY_TUESDAY` Value of 2. Represents the day Tuesday.
`static int`	`DAY_WEDNESDAY` Value of 3. Represents the day Wednesday.
`static int`	`MONTH_APRIL` Value of 3. Represents the fourth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_AUGUST` Value of 7. Represents the eighth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_DECEMBER` Value of 11. Represents the twelfth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_FEBRUARY` Value of 1. Represents the second month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_JANUARY` Value of 0. Represents the first month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_JULY` Value of 6. Represents the seventh month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_JUNE` Value of 5. Represents the sixth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_MARCH` Value of 2. Represents the third month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_MAY` Value of 4. Represents the fifth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_NOVEMBER` Value of 10. Represents the eleventh month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_OCTOBER` Value of 9. Represents the tenth month of the year in the Gregorian and Julian calendars.
`static int`	`MONTH_SEPTEMBER` Value of 8. Represents the ninth month of the year in the Gregorian and Julian calendars.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VWSpecialDayDefinition`	`createSpecialDayDefinition(java.lang.String theName, int theMonth, int theDay, int theYear)` Creates a new special day definition.
`VWSpecialDayDefinition`	`deleteSpecialDayDefinition(java.lang.String theName)` Deletes a special day definition from this work schedule definition.
`java.lang.String`	`getAuthoredName()` Gets the authored name assigned to work schedule definition.
`java.lang.String`	`getDescription()` Gets the description of this work schedule definition.
`java.lang.String`	`getName()` Gets the name assigned to this work schedule definition.
`VWSpecialDayDefinition`	`getSpecialDayDefinition(java.lang.String name)` Gets the special day definition with the specified name from this work schedule definition.
`VWSpecialDayDefinition[]`	`getSpecialDayDefinitions()` Get the special day definitions for this work schedule definition.
`java.lang.String`	`getTimeZoneName()` Gets the name of the time zone that will be used for this Work Schedule.
`VWWorkDayDefinition`	`getWorkDayDefinition(int theDayIndex)` Gets the work day definition at the specified day index.
`VWWorkDayDefinition[]`	`getWorkDayDefinitions()` Get the special day definitions for this work schedule.
`void`	`setDescription(java.lang.String description)` Sets the description of this work schedule definition.
`void`	`setSpecialDayDefinitions(VWSpecialDayDefinition[] theSpecialDayDefinitions)` Sets the special day definitions for this work schedule definition.
`void`	`setTimeZoneName(java.lang.String theTimeZoneName)` Sets the time zone that will be used with this Work Schedule
`java.lang.String`	`toString()` Gets the name of this work schedule definition.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DAY_SUNDAY
```
public static final int DAY_SUNDAY
```
    Value of 0. Represents the day Sunday. Used as an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_MONDAY
```
public static final int DAY_MONDAY
```
    Value of 1. Represents the day Monday. Used as an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_TUESDAY
```
public static final int DAY_TUESDAY
```
    Value of 2. Represents the day Tuesday. Used an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_WEDNESDAY
```
public static final int DAY_WEDNESDAY
```
    Value of 3. Represents the day Wednesday. Used an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_THURSDAY
```
public static final int DAY_THURSDAY
```
    Value of 4. Represents the day Thursday. Used an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_FRIDAY
```
public static final int DAY_FRIDAY
```
    Value of 5. Represents the day Friday. Used an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - DAY_SATURDAY
```
public static final int DAY_SATURDAY
```
    Value of 6. Represents the day Saturday. Used an index into the VWWorkDayDefinition array.
    
    See Also:
    
    Constant Field Values
  - MONTH_JANUARY
```
public static final int MONTH_JANUARY
```
    Value of 0. Represents the first month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_FEBRUARY
```
public static final int MONTH_FEBRUARY
```
    Value of 1. Represents the second month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_MARCH
```
public static final int MONTH_MARCH
```
    Value of 2. Represents the third month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_APRIL
```
public static final int MONTH_APRIL
```
    Value of 3. Represents the fourth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_MAY
```
public static final int MONTH_MAY
```
    Value of 4. Represents the fifth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_JUNE
```
public static final int MONTH_JUNE
```
    Value of 5. Represents the sixth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_JULY
```
public static final int MONTH_JULY
```
    Value of 6. Represents the seventh month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_AUGUST
```
public static final int MONTH_AUGUST
```
    Value of 7. Represents the eighth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_SEPTEMBER
```
public static final int MONTH_SEPTEMBER
```
    Value of 8. Represents the ninth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_OCTOBER
```
public static final int MONTH_OCTOBER
```
    Value of 9. Represents the tenth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_NOVEMBER
```
public static final int MONTH_NOVEMBER
```
    Value of 10. Represents the eleventh month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
  - MONTH_DECEMBER
```
public static final int MONTH_DECEMBER
```
    Value of 11. Represents the twelfth month of the year in the Gregorian and Julian calendars.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getName
```
public java.lang.String getName()
                         throws VWException
```
    Gets the name assigned to this work schedule definition. If a translated version exists, that version is returned.
    
    Returns:
    
    A String containing the name of this work schedule 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 work schedule definition.
    
    Returns:
    
    A String containing the authored name of this work schedule definition.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getDescription
```
public java.lang.String getDescription()
                                throws VWException
```
    Gets the description of this work schedule definition. If a translated version exists, that version is returned.
    
    Returns:
    
    A String containing the description, or null if no description is defined.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - setDescription
```
public void setDescription(java.lang.String description)
                    throws VWException
```
    Sets the description of this work schedule definition.
    
    Parameters:
    
    description - A String containing the description.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getTimeZoneName
```
public java.lang.String getTimeZoneName()
```
    Gets the name of the time zone that will be used for this Work Schedule.
    
    Returns:
    
    The time zone name
    
    Since:
    
    CPE 5.2.0.3
  - setTimeZoneName
```
public void setTimeZoneName(java.lang.String theTimeZoneName)
                     throws VWException
```
    Sets the time zone that will be used with this Work Schedule
    
    Parameters:
    
    theTimeZoneName - value must be confined within the set returned by TimeZone.getAvailableIDs()
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getWorkDayDefinitions
```
public VWWorkDayDefinition[] getWorkDayDefinitions()
                                            throws VWException
```
    Get the special day definitions for this work schedule.
    
    Returns:
    
    An array of VWSpecialDayDefinition objects identifying the special days that are defined for this work schedule definition.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getWorkDayDefinition
```
public VWWorkDayDefinition getWorkDayDefinition(int theDayIndex)
                                         throws VWException
```
    Gets the work day definition at the specified day index.
    Parameters:
    theDayIndex - The index of the work day. One of the following:
    
    VWWorkScheduleDefinition.DAY_SUNDAY
    
    VWWorkScheduleDefinition.DAY_MONDAY
    
    VWWorkScheduleDefinition.DAY_TUESDAY
    
    VWWorkScheduleDefinition.DAY_WEDNESDAY
    
    VWWorkScheduleDefinition.DAY_THURSDAY
    
    VWWorkScheduleDefinition.DAY_FRIDAY
    
    VWWorkScheduleDefinition.DAY_SATURDAY
    Returns:
    
    A work day definition object, or null if not found.
    
    Throws:
    
    VWException - Thrown if theDayIndex is not within the accepted range.
    
    Since:
    
    CPE 5.2.0.3
  - getSpecialDayDefinitions
```
public VWSpecialDayDefinition[] getSpecialDayDefinitions()
                                                  throws VWException
```
    Get the special day definitions for this work schedule definition.
    
    Returns:
    
    An array of special day definition objects.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getSpecialDayDefinition
```
public VWSpecialDayDefinition getSpecialDayDefinition(java.lang.String name)
                                               throws VWException
```
    Gets the special day definition with the specified name from this work schedule definition.
    
    Parameters:
    
    name - The name of the special day definition.
    
    Returns:
    
    A special day definition object.
    
    Throws:
    
    VWException - Thrown if the specified name is invalid or the special day definition cannot be found.
    
    Since:
    
    CPE 5.2.0.3
  - setSpecialDayDefinitions
```
public void setSpecialDayDefinitions(VWSpecialDayDefinition[] theSpecialDayDefinitions)
                              throws VWException
```
    Sets the special day definitions for this work schedule definition.
    
    Parameters:
    
    theSpecialDayDefinitions - An array of special day definition objects that are to be defined for this work schedule definition. The name and date must be unique within the array of special day definitions.
    
    Throws:
    
    VWException - thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - createSpecialDayDefinition
```
public VWSpecialDayDefinition createSpecialDayDefinition(java.lang.String theName,
                                                         int theMonth,
                                                         int theDay,
                                                         int theYear)
                                                  throws VWException
```
    Creates a new special day definition. The name and date must be unique within this work schedule definition.
    
    Parameters:
    
    theName - The name of the special day definition.
    
    theMonth - The month of the special day. The accepted value is from VWWorkScheduleDefinition.MONTH_JANUARY to VWWorkScheduleDefinition.MONTH_DECEMBER.
    
    theDay - The day of the special day (1-31).
    
    theYear - The year of the special day.
    
    Returns:
    
    The new special day definition object.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - deleteSpecialDayDefinition
```
public VWSpecialDayDefinition deleteSpecialDayDefinition(java.lang.String theName)
                                                  throws VWException
```
    Deletes a special day definition from this work schedule definition.
    
    Parameters:
    
    theName - The name of the special day definition to be deleted.
    
    Throws:
    
    VWException - Thrown if the special day definition cannot be deleted.
    
    Since:
    
    CPE 5.2.0.3
  - toString
```
public java.lang.String toString()
```
    Gets the name of this work schedule definition.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A String containing the name of this work schedule definition.
    
    Since:
    
    CPE 5.2.0.3

Methods inherited from class java.lang.Object

DAY_SUNDAY

DAY_MONDAY

DAY_TUESDAY

DAY_WEDNESDAY

DAY_THURSDAY

DAY_FRIDAY

DAY_SATURDAY

MONTH_JANUARY

MONTH_FEBRUARY

MONTH_MARCH

MONTH_APRIL

MONTH_MAY

MONTH_JUNE

MONTH_JULY

MONTH_AUGUST

MONTH_SEPTEMBER

MONTH_OCTOBER

MONTH_NOVEMBER

MONTH_DECEMBER

getName

getAuthoredName

getDescription

setDescription

getTimeZoneName

setTimeZoneName

getWorkDayDefinitions

getWorkDayDefinition

getSpecialDayDefinitions

getSpecialDayDefinition

setSpecialDayDefinitions

createSpecialDayDefinition

deleteSpecialDayDefinition

toString