|
HATS 7.5.1 Web API ReferencePublicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product. |
||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.ibm.hats.transform.ConsumableFieldList
public class ConsumableFieldList
The ConsumableFieldList class represents a list of HsrScreenField objects. Each field can be marked as consumed or not consumed.
This class is exclusively used by the Pattern components as a way to mark fields that have been consumed by a higher priority global rule.
PatternComponent| Constructor Summary | |
|---|---|
ConsumableFieldList(HsrScreen hostScreen,
boolean includeInputFields,
boolean includeProtectedFields)
Constructs a new ConsumableFieldList object. |
|
| Method Summary | |
|---|---|
int |
getConsumedCount()
Returns the number of fields that have been consumed. |
HsrScreenField |
getField(int index)
Returns the HsrScreenField at the specified (0-based) index. |
int |
getFieldIndex(HsrScreenField field)
Returns the 0-based index of the specified field. |
boolean |
isFieldConsumed(int index)
Returns true if the field has been consumed. |
void |
setIsFieldConsumed(int index,
boolean b)
Sets whether a field has been consumed. |
int |
size()
Returns the number of fields in the list. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ConsumableFieldList(HsrScreen hostScreen,
boolean includeInputFields,
boolean includeProtectedFields)
ConsumableFieldList object.
hostScreen - The host screen used to build the list of fields.includeInputFields - Flag to indicate whether or not to include input (non-protected) fields in the list.includeProtectedFields - Flag to indicate whether or not to include protected fields in the list| Method Detail |
|---|
public HsrScreenField getField(int index)
HsrScreenField at the specified (0-based) index.
index - 0-based index of the field to get
HsrScreenField object or null if the index did not exist in the listpublic int getFieldIndex(HsrScreenField field)
field - host screen field to retrieve the 0-based index of
public boolean isFieldConsumed(int index)
true if the field has been consumed.
index -
public void setIsFieldConsumed(int index,
boolean b)
index - 0-based index of the fieldb - value of consumed
public int size()
throws NullPointerException
NullPointerExceptionpublic int getConsumedCount()
|
HATS 7.5.1 (201005110649) | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||