com.ibm.gre.samples.collectionhelpers
Class OptionalFields

java.lang.Object
  |
  +--com.ibm.gre.samples.collectionhelpers.OptionalFields

public class OptionalFields
extends java.lang.Object

The OptionalFields class represents bit mask values specifying fields that can optionaly be added and displayed for a Life Cycle Query. These elements can be found as members of the "GetEligibleFilePlanComponents" element part of the input to the GET_ELIGIBLE_FILE_PLAN_COMPONENTS BatchController task.


Field Summary
static int DISPOSAL_AUTHORITY
          Indicates the Disposal Authority field should be displayed for input.
static int ELIGIBLE_FOR_CLOSE
          Indicates the Eligible for close checkbox should be displayed for input.
static int ELIGIBLE_FOR_CUT_OFF
          Indicates the Eligible for Cutt Off checkbox should be displayed for input.
static int ELIGIBLE_FOR_TRANSITION
          Indicates the Eligible for Transition checkbox should be displayed for input.
static int LIFE_CYCLE_QUERY_TYPE
           
static int NO_FIELDS
          Indicates No Optional Fields
static int PHASE_ID
          Indicates the Phase list should be displayed for input.
static int REFERENCE_DATE_FROM
          Indicates the Reference Date From should be displayed for input.
static int REFERENCE_DATE_TO
          Indicates the Reference Date To should be displayed for input.
 
Constructor Summary
OptionalFields(int mask)
          Constructor
 
Method Summary
 boolean editDisposalAuthority()
          Returns true if the Disposal Authority field should be displayed for edit.
 boolean editEligibleForClose()
          Returns true if the Eligible for Close field should be displayed for edit.
 boolean editEligibleForCutOff()
          Returns true if the Eligible For Cutoff field should be displayed for edit.
 boolean editEligibleForTransition()
          Returns true if the Eligible for Transition field should be displayed for edit.
 boolean editLifeCycleQueryType()
          Returns true if the Life Cycle Query type field should be displayed for edit.
 boolean editPhaseId()
          Returns true if the Phase ID field should be displayed for edit.
 boolean editReferenceDateFrom()
          Returns true if the Reference Date From field should be displayed for edit.
 boolean editReferenceDateTo()
          Returns true if the Reference Date To field should be displayed for edit.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

NO_FIELDS

public static int NO_FIELDS
Indicates No Optional Fields


REFERENCE_DATE_TO

public static int REFERENCE_DATE_TO
Indicates the Reference Date To should be displayed for input.


REFERENCE_DATE_FROM

public static int REFERENCE_DATE_FROM
Indicates the Reference Date From should be displayed for input.


DISPOSAL_AUTHORITY

public static int DISPOSAL_AUTHORITY
Indicates the Disposal Authority field should be displayed for input.


ELIGIBLE_FOR_CUT_OFF

public static int ELIGIBLE_FOR_CUT_OFF
Indicates the Eligible for Cutt Off checkbox should be displayed for input.


ELIGIBLE_FOR_CLOSE

public static int ELIGIBLE_FOR_CLOSE
Indicates the Eligible for close checkbox should be displayed for input.


ELIGIBLE_FOR_TRANSITION

public static int ELIGIBLE_FOR_TRANSITION
Indicates the Eligible for Transition checkbox should be displayed for input.


PHASE_ID

public static int PHASE_ID
Indicates the Phase list should be displayed for input.


LIFE_CYCLE_QUERY_TYPE

public static int LIFE_CYCLE_QUERY_TYPE
Constructor Detail

OptionalFields

public OptionalFields(int mask)
Constructor

Parameters:
mask - The bit mask containing the optional fields to display.
Method Detail

editReferenceDateFrom

public boolean editReferenceDateFrom()
Returns true if the Reference Date From field should be displayed for edit.

Returns:
boolean

editReferenceDateTo

public boolean editReferenceDateTo()
Returns true if the Reference Date To field should be displayed for edit.

Returns:
boolean

editDisposalAuthority

public boolean editDisposalAuthority()
Returns true if the Disposal Authority field should be displayed for edit.

Returns:
boolean

editEligibleForCutOff

public boolean editEligibleForCutOff()
Returns true if the Eligible For Cutoff field should be displayed for edit.

Returns:
boolean

editEligibleForClose

public boolean editEligibleForClose()
Returns true if the Eligible for Close field should be displayed for edit.

Returns:
boolean

editEligibleForTransition

public boolean editEligibleForTransition()
Returns true if the Eligible for Transition field should be displayed for edit.

Returns:
boolean

editPhaseId

public boolean editPhaseId()
Returns true if the Phase ID field should be displayed for edit.

Returns:
boolean

editLifeCycleQueryType

public boolean editLifeCycleQueryType()
Returns true if the Life Cycle Query type field should be displayed for edit.

Returns:
boolean