VWSLAEntryDefinition (Process API Documentation)

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public final class VWSLAEntryDefinition
extends java.lang.Object
implements java.io.Serializable, java.lang.Cloneable
```
Use this class to create, read, delete, or modify Service Level Agreement Entry definition properties.

Since:

CPE 5.2.0.3

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DAY_ADJUSTMENT_ADJUSTED_TIME` Value of 4. If this is a day-based SLA entry, the deadline will be adjusted so that it occurs during work hours.
`static int`	`DAY_ADJUSTMENT_END_OF_BUSINESS_DAY` Value of 1. If this is a day-based SLA entry, the deadline will occur at the end of the business day.
`static int`	`DAY_ADJUSTMENT_END_OF_DAY` Value of 2. If this is a day-based SLA entry, the deadline will occur at the end of the day (11:59 PM).
`static int`	`DAY_ADJUSTMENT_FIXED_TIME` Value of 3. If this is a day-based SLA entry, the deadline will occur at the time specified in the 'fixedTime' value.
`static int`	`DAY_ADJUSTMENT_SAME_TIME` Value of 0. If this is a day-based SLA entry, the deadline will occur at the same time of day that the work item was received.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`dayAdjustmentToString(int dayAdjustment)` Gets the string representation of a day adjustment value.
`int`	`getDayAdjustment()` Indicates whether the deadline value is adjusted to the end of the work day, the end of the business day, or the time the work item is created.
`int`	`getDeadline()` Gets the deadline value for the SLA Entry.
`java.lang.String`	`getDescription()` Gets the description value for the SLA Entry.
`int`	`getFixedTime()` Gets the fixed time value for the SLA Entry.
`int`	`getReminder()` Gets the reminder value for the SLA Entry.
`boolean`	`isCutoffUsed()` Indicates whether cutoff time is used in a calculation to determine the start time of the deadline timer.
`boolean`	`isDeadlineInDays()` Indicates whether the deadline is specified in days.
`boolean`	`isWorkScheduleUsed()` Indicates whether a Work Schedule is used in SLA time calculation for the deadline and reminder
`void`	`setCutoffUsed(boolean theFlag)` Sets whether the cutoff is to be used in calculation to determine the start time of the deadline timer.
`void`	`setDayAdjustment(int theAdjustmentValue)` Sets the day adjustment value, which is used only if this is a day-based SLA.
`void`	`setDeadline(int theDeadline)` Sets the deadline for the SLA Entry.
`void`	`setDeadlineInDays(boolean theFlag)` Sets whether the deadline is specified in days.
`void`	`setDescription(java.lang.String theDescription)` Sets the description for the SLA Entry.
`void`	`setFixedTime(int theFixedTime)` Sets the fixed time value for the SLA Entry.
`void`	`setReminder(int theReminder)` Sets the reminder value for SLA Entry.
`void`	`setWorkScheduleUsed(boolean theFlag)` Sets whether the Work Schedule is to be used in SLA calculation to determine the deadline and reminder timer.

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

- Field Detail
  - DAY_ADJUSTMENT_SAME_TIME
```
public static final int DAY_ADJUSTMENT_SAME_TIME
```
    Value of 0. If this is a day-based SLA entry, the deadline will occur at the same time of day that the work item was received. Used to set the 'dayAdjustment' value.
    
    See Also:
    
    Constant Field Values
  - DAY_ADJUSTMENT_END_OF_BUSINESS_DAY
```
public static final int DAY_ADJUSTMENT_END_OF_BUSINESS_DAY
```
    Value of 1. If this is a day-based SLA entry, the deadline will occur at the end of the business day. Used to set the 'dayAdjustment' value.
    
    See Also:
    
    Constant Field Values
  - DAY_ADJUSTMENT_END_OF_DAY
```
public static final int DAY_ADJUSTMENT_END_OF_DAY
```
    Value of 2. If this is a day-based SLA entry, the deadline will occur at the end of the day (11:59 PM). Used to set the 'dayAdjustment' value.
    
    See Also:
    
    Constant Field Values
  - DAY_ADJUSTMENT_FIXED_TIME
```
public static final int DAY_ADJUSTMENT_FIXED_TIME
```
    Value of 3. If this is a day-based SLA entry, the deadline will occur at the time specified in the 'fixedTime' value. Used to set the 'dayAdjustment' value.
    
    See Also:
    
    Constant Field Values
  - DAY_ADJUSTMENT_ADJUSTED_TIME
```
public static final int DAY_ADJUSTMENT_ADJUSTED_TIME
```
    Value of 4. If this is a day-based SLA entry, the deadline will be adjusted so that it occurs during work hours. Used to set the 'dayAdjustment' value.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDeadline
```
public int getDeadline()
```
    Gets the deadline value for the SLA Entry.
    
    Returns:
    
    The value of the deadline property for the step. If the deadline is in days (see VWSLAEntryDefinition.isDeadlineInDays()), return the number of days. If the deadline is not in days, return the number of minutes between the start of the step to expiration of the deadline time.
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWSLAEntryDefinition.isDeadlineInDays()
  - setDeadline
```
public void setDeadline(int theDeadline)
                 throws VWException
```
    Sets the deadline for the SLA Entry. If the deadline is in days (see VWSLAEntryDefinition.isDeadlineInDays()), the deadline value is the number of days. If the deadline is not in days, the deadline value represents the number of minutes between the start of the step to expiration of the deadline time.
    
    Parameters:
    
    theDeadline - A integer specifying the dead line period.
    
    Throws:
    
    VWException - Thrown if the theDeadline parameter contains a negative value.
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWSLAEntryDefinition.setDeadlineInDays(boolean), VWSLAEntryDefinition.isDeadlineInDays()
  - getReminder
```
public int getReminder()
```
    Gets the reminder value for the SLA Entry. The reminder value represents the number of minutes the reminder timer expires prior to expiration of the deadline timer at run time.
    
    Returns:
    
    A number representing the value of the reminder in minutes. If no reminder value exists, 0 (zero) is returned.
    
    Since:
    
    CPE 5.2.0.3
  - setReminder
```
public void setReminder(int theReminder)
                 throws VWException
```
    Sets the reminder value for SLA Entry. The reminder value represents the number of minutes the reminder timer expires prior to expiration of the deadline timer at run time. Specify a reminder value of 0 (zero) for no reminder.
    
    Parameters:
    
    theReminder - A number specifying the reminder period, in minutes.
    
    Throws:
    
    VWException - The method throws an exception if theReminder parameter contains a negative value.
    
    Since:
    
    CPE 5.2.0.3
  - getFixedTime
```
public int getFixedTime()
```
    Gets the fixed time value for the SLA Entry.
    
    Returns:
    
    A number representing the fixed time value. A value of 0 (zero) means that no fixed time is set.
    
    Since:
    
    CPE 5.2.0.3
  - setFixedTime
```
public void setFixedTime(int theFixedTime)
                  throws VWException
```
    Sets the fixed time value for the SLA Entry. The fixed time value represents the number of minutes since 12:00 AM.
    
    Parameters:
    
    theFixedTime - A number specifying the fixed time period, in minutes.
    
    Throws:
    
    VWException - The method throws an exception if theFixedTime parameter contains a negative value.
    
    Since:
    
    CPE 5.2.0.3
  - isCutoffUsed
```
public boolean isCutoffUsed()
```
    Indicates whether cutoff time is used in a calculation to determine the start time of the deadline timer.
    Returns:
    One of the following:
    
    true indicates cutoff will be used in deadline and reminder calculations.
    
    false cutoff time will be ignored.
    Since:
    
    CPE 5.2.0.3
  - setCutoffUsed
```
public void setCutoffUsed(boolean theFlag)
                   throws VWException
```
    Sets whether the cutoff is to be used in calculation to determine the start time of the deadline timer.
    Parameters:
    theFlag - One of the following:
    
    true indicates cutoff will be used in deadline and reminder calculations.
    
    false cutoff time will be ignored.
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getDayAdjustment
```
public int getDayAdjustment()
```
    Indicates whether the deadline value is adjusted to the end of the work day, the end of the business day, or the time the work item is created. This value is used only if this is a day-based SLA.
    
    Returns:
    
    The day adjustment value
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWSLAEntryDefinition.setDayAdjustment(int)
  - setDayAdjustment
```
public void setDayAdjustment(int theAdjustmentValue)
                      throws VWException
```
    Sets the day adjustment value, which is used only if this is a day-based SLA.
    Parameters:
    theAdjustmentValue - One of the following:
    
    VWSLAEntryDefinition.DAY_ADJUSTMENT_SAME_TIME the deadline will occur at the same time of day that the work item was created.
    
    VWSLAEntryDefinition.DAY_ADJUSTMENT_END_OF_DAY the deadline will occur at the end of the day (11:59:59 PM).
    
    VWSLAEntryDefinition.DAY_ADJUSTMENT_END_OF_BUSINESS_DAY the deadline will occur at the end of the business day.
    
    VWSLAEntryDefinition.DAY_ADJUSTMENT_FIXED_TIME the deadline will occur at the time specified in the 'fixedTime' value.
    
    VWSLAEntryDefinition.DAY_ADJUSTMENT_ADJUSTED_TIME the deadline will be adjusted so that it occurs during work hours.
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - isDeadlineInDays
```
public boolean isDeadlineInDays()
```
    Indicates whether the deadline is specified in days. The day calculation can specify end of the day, meaning the deadline is due the end of the working day when a work schedule is present, or midnight if no work schedule is used in the calculation.
    Returns:
    One of the following:
    
    true indicates the day will be used in deadline calculation.
    
    false indicates that minutes will be used.
    Since:
    
    CPE 5.2.0.3
  - setDeadlineInDays
```
public void setDeadlineInDays(boolean theFlag)
                       throws VWException
```
    Sets whether the deadline is specified in days. The day calculation can specify end of the day, meaning the deadline is due the end of the working day when a work schedule is present, or midnight if no work schedule is used in the calculation.
    Parameters:
    theFlag - One of the following:
    
    true indicates the day will be used in deadline calculation.
    
    false indicates that minutes will be used.
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - isWorkScheduleUsed
```
public boolean isWorkScheduleUsed()
```
    Indicates whether a Work Schedule is used in SLA time calculation for the deadline and reminder
    Returns:
    One of the following:
    
    true indicates a Work Schedule will be used in deadline and reminder calculations.
    
    false the deadline and reminder calculations will use a 24x7 calendar.
    Since:
    
    CPE 5.2.0.3
  - setWorkScheduleUsed
```
public void setWorkScheduleUsed(boolean theFlag)
                         throws VWException
```
    Sets whether the Work Schedule is to be used in SLA calculation to determine the deadline and reminder timer.
    Parameters:
    theFlag - One of the following:
    
    true indicates a Work Schedule will be used in deadline and reminder calculations.
    
    false the deadline and reminder calculations will use a 24x7 calendar.
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the description value for the SLA Entry.
    
    Returns:
    
    A String containing the description.
    
    Since:
    
    CPE 5.2.0.3
  - setDescription
```
public void setDescription(java.lang.String theDescription)
                    throws VWException
```
    Sets the description for the SLA Entry.
    
    Parameters:
    
    theDescription - A String containing the description.
    
    Throws:
    
    VWException - Thrown for various reasons.
    
    Since:
    
    CPE 5.2.0.3
  - dayAdjustmentToString
```
public static java.lang.String dayAdjustmentToString(int dayAdjustment)
                                              throws VWException
```
    Gets the string representation of a day adjustment value.
    
    Parameters:
    
    dayAdjustment - A day adjustment value.
    
    Returns:
    
    The String version of the day adjustment setting
    
    Throws:
    
    VWException - If the specified day adjustment value is invalid
    
    Since:
    
    CPE 5.2.0.3
    
    See Also:
    
    VWSLAEntryDefinition.setDayAdjustment(int)

Methods inherited from class java.lang.Object

DAY_ADJUSTMENT_SAME_TIME

DAY_ADJUSTMENT_END_OF_BUSINESS_DAY

DAY_ADJUSTMENT_END_OF_DAY

DAY_ADJUSTMENT_FIXED_TIME

DAY_ADJUSTMENT_ADJUSTED_TIME

getDeadline

setDeadline

getReminder

setReminder

getFixedTime

setFixedTime

isCutoffUsed

setCutoffUsed

getDayAdjustment

setDayAdjustment

isDeadlineInDays

setDeadlineInDays

isWorkScheduleUsed

setWorkScheduleUsed

getDescription

setDescription

dayAdjustmentToString