Primavera Integration API Release 8

com.primavera.integration.client.bo.enm
Class TimesheetPeriodType

java.lang.Object
  extended by com.primavera.integration.client.bo.enm.EnumType
      extended by com.primavera.integration.client.bo.enm.TimesheetPeriodType

public class TimesheetPeriodType
extends EnumType

Time sheet period types are used in GlobalPreferences for the time sheet application. Valid values are: 'Every Week', 'Every Two Weeks', 'Every Four Weeks' and 'Every Month'.

To use an enumeration in a where clause, make sure you use the internal database value. This can be retrieved from a particular enum instance by calling getValue().


Field Summary
static TimesheetPeriodType EVERY_FOUR_WEEKS
           
static TimesheetPeriodType EVERY_MONTH
           
static TimesheetPeriodType EVERY_TWO_WEEKS
           
static TimesheetPeriodType EVERY_WEEK
           
static TimesheetPeriodType NULL
           
 
Method Summary
 String getDescription()
          Gets the description of this TimesheetPeriodType instance
static String[] getEnumDescriptions()
          Gets an array of all descriptions for this enumeration
static String[] getEnumValues()
          Gets an array of all internal values for this enumeration
static TimesheetPeriodType getTimesheetPeriodType(int iTimesheetPeriodType)
          Gets an instance of TimesheetPeriodType based on the integer value specified.
static TimesheetPeriodType getTimesheetPeriodType(String sTimesheetPeriodType)
          Gets an instance of TimesheetPeriodType based on the String value specified.
 String getValue()
          Gets the internal value of this TimesheetPeriodType instance
 String toString()
          Returns a string representation of the object, which is the same as the description returned by the getDescription() method
 
Methods inherited from class com.primavera.integration.client.bo.enm.EnumType
equals, hashCode, intValue
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NULL

public static final TimesheetPeriodType NULL

EVERY_WEEK

public static final TimesheetPeriodType EVERY_WEEK

EVERY_TWO_WEEKS

public static final TimesheetPeriodType EVERY_TWO_WEEKS

EVERY_FOUR_WEEKS

public static final TimesheetPeriodType EVERY_FOUR_WEEKS

EVERY_MONTH

public static final TimesheetPeriodType EVERY_MONTH
Method Detail

toString

public String toString()
Returns a string representation of the object, which is the same as the description returned by the getDescription() method

Overrides:
toString in class Object
Returns:
String a string representation of the object

getValue

public String getValue()
Gets the internal value of this TimesheetPeriodType instance

Specified by:
getValue in class EnumType
Returns:
String the internal value

getDescription

public String getDescription()
Gets the description of this TimesheetPeriodType instance

Specified by:
getDescription in class EnumType
Returns:
String the description

getTimesheetPeriodType

public static TimesheetPeriodType getTimesheetPeriodType(String sTimesheetPeriodType)
Gets an instance of TimesheetPeriodType based on the String value specified.

Parameters:
sTimesheetPeriodType - the internal value or description
Returns:
TimesheetPeriodType the unique TimesheetPeriodType instance

getTimesheetPeriodType

public static TimesheetPeriodType getTimesheetPeriodType(int iTimesheetPeriodType)
Gets an instance of TimesheetPeriodType based on the integer value specified.

Parameters:
iTimesheetPeriodType - an integer representing a particular value of this class. This value is also used when exporting to XML.
Returns:
TimesheetPeriodType the unique TimesheetPeriodType instance

getEnumValues

public static String[] getEnumValues()
Gets an array of all internal values for this enumeration

Returns:
String[] an array of all internal values

getEnumDescriptions

public static String[] getEnumDescriptions()
Gets an array of all descriptions for this enumeration

Returns:
String[] an array of all descriptions

Primavera Integration API Release 8

Copyright © 2003, 2010, Oracle and/or its affiliates. All rights reserved.