Project: stp

com.ibm.rational.wvcm.stp.cq
Enum CqFieldDefinition.Requiredness

Object
  extended by Enum<CqFieldDefinition.Requiredness>
      extended by CqFieldDefinition.Requiredness
All Implemented Interfaces:
com.ibm.rational.wvcm.stpex.StpExEnumeration, Serializable, Comparable<CqFieldDefinition.Requiredness>
Enclosing interface:
CqFieldDefinition

public static enum CqFieldDefinition.Requiredness
extends Enum<CqFieldDefinition.Requiredness>
implements com.ibm.rational.wvcm.stpex.StpExEnumeration

An enumeration of the possible restrictions on assigning a value to a field.


Enum Constant Summary
MANDATORY
          a field value is MANDATORY; a non-null value must be provided.
OPTIONAL
          a field value is OPTIONAL; a non-null value may be provider but is not required
READ_ONLY
          field is READ_ONLY; its value cannot be changed.
USE_HOOK
          a field value is determined by calling the associated hook
 
Method Summary
static CqFieldDefinition.Requiredness valueOf(String name)
          Returns the enum constant of this type with the specified name.
static CqFieldDefinition.Requiredness[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

MANDATORY

public static final CqFieldDefinition.Requiredness MANDATORY
a field value is MANDATORY; a non-null value must be provided.


OPTIONAL

public static final CqFieldDefinition.Requiredness OPTIONAL
a field value is OPTIONAL; a non-null value may be provider but is not required


READ_ONLY

public static final CqFieldDefinition.Requiredness READ_ONLY
field is READ_ONLY; its value cannot be changed.


USE_HOOK

public static final CqFieldDefinition.Requiredness USE_HOOK
a field value is determined by calling the associated hook

Method Detail

valueOf

public static CqFieldDefinition.Requiredness valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

values

public static CqFieldDefinition.Requiredness[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (CqFieldDefinition.Requiredness c : CqFieldDefinition.Requiredness.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

Generated Fri 7-Aug-2015 10:46 PM

Copyright © IBM 2015. All rights reserved.