Primavera Integration API 7.0

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

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

public class RoleLimitDisplayOption
extends EnumType

Role limit display option enumerations are used with role limits. Values are 'Custom' and 'Primary Role'.

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 RoleLimitDisplayOption CUSTOM
           
static RoleLimitDisplayOption NULL
           
static RoleLimitDisplayOption PRIMARY_ROLE
           
 
Method Summary
 java.lang.String getDescription()
          Gets the description of this RoleLimitDisplayOption instance
static java.lang.String[] getEnumDescriptions()
          Gets an array of all descriptions for this enumeration
static java.lang.String[] getEnumValues()
          Gets an array of all internal values for this enumeration
static RoleLimitDisplayOption getRoleLimitDisplayOption(int iRoleLimitDisplayOption)
          Gets an instance of RoleLimitDisplayOption based on the integer value specified.
static RoleLimitDisplayOption getRoleLimitDisplayOption(java.lang.String sRoleLimitDisplayOption)
          Gets an instance of RoleLimitDisplayOption based on the String value specified.
 java.lang.String getValue()
          Gets the internal value of this RoleLimitDisplayOption instance
 java.lang.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 RoleLimitDisplayOption NULL

CUSTOM

public static final RoleLimitDisplayOption CUSTOM

PRIMARY_ROLE

public static final RoleLimitDisplayOption PRIMARY_ROLE
Method Detail

toString

public java.lang.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 java.lang.Object
Returns:
String a string representation of the object

getValue

public java.lang.String getValue()
Gets the internal value of this RoleLimitDisplayOption instance

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

getDescription

public java.lang.String getDescription()
Gets the description of this RoleLimitDisplayOption instance

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

getRoleLimitDisplayOption

public static RoleLimitDisplayOption getRoleLimitDisplayOption(java.lang.String sRoleLimitDisplayOption)
Gets an instance of RoleLimitDisplayOption based on the String value specified.

Parameters:
sRoleLimitDisplayOption - the internal value or description
Returns:
RoleLimitDisplayOption the unique RoleLimitDisplayOption instance

getRoleLimitDisplayOption

public static RoleLimitDisplayOption getRoleLimitDisplayOption(int iRoleLimitDisplayOption)
Gets an instance of RoleLimitDisplayOption based on the integer value specified.

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

getEnumValues

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

Returns:
String[] an array of all internal values

getEnumDescriptions

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

Returns:
String[] an array of all descriptions

Primavera Integration API 7.0

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