public class BaseSchemeElement
extends java.lang.Object
BaseSchemeElement (name, description, minRepetitions, maxRepetitions) | |____> SchemeSequence | |____> BaseSchemeFieldElement (letterOptions, eval) | |____> SchemeFieldSet | |____> SchemeField (index, qualifiers, defaultValue) | |____> SchemeFieldSetItem (order)
Modifier and Type | Field and Description |
---|---|
protected boolean |
editable
When true indicates the element can be editable by the users
|
protected java.lang.Integer |
maxRepetitions
For repetitive fields it indicates at last how many repetitions are allowed
|
protected java.lang.Integer |
minRepetitions
For repetitive fields it indicates at least how many repetitions are expected
|
protected java.lang.String |
name
A given name to unique identification of the element.
|
static java.lang.Integer |
UNLIMITED |
protected boolean |
visible
When true indicates the element can be visible to the users
|
Modifier | Constructor and Description |
---|---|
|
BaseSchemeElement() |
protected |
BaseSchemeElement(java.lang.String name) |
protected |
BaseSchemeElement(java.lang.String name,
java.lang.Integer minRepetitions,
java.lang.Integer maxRepetitions) |
Modifier and Type | Method and Description |
---|---|
SchemeField |
asField()
get this as
SchemeField or null if is not that type |
SchemeFieldSet |
asFieldSet() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDescription() |
java.lang.Long |
getId()
Get the id
|
java.lang.Integer |
getMaxRepetitions() |
java.lang.Integer |
getMinRepetitions() |
java.lang.String |
getName() |
int |
hashCode() |
boolean |
isEditable() |
boolean |
isField() |
boolean |
isFieldSet() |
boolean |
isMandatory()
Indicates if the field is mandatory (in a particular sequence in a particular message scheme).
|
boolean |
isOptional()
Indicates if the field is optional (in a particular sequence in a particular message scheme).
|
boolean |
isRepetitive()
Indicates if the field is or not repetitive (in a particular sequence in a particular message scheme)
|
boolean |
isSequence() |
boolean |
isUnlimited()
Indicates if the field is repetitive with unlimited repetitions allowed
|
boolean |
isVisible() |
void |
setDescription(java.lang.String description) |
void |
setEditable(boolean editable) |
void |
setId(java.lang.Long id)
Set the id.
|
void |
setMaxRepetitions(java.lang.Integer maxRepetitions)
Sets the maximum allowed repetitions of the element.
|
void |
setMinRepetitions(java.lang.Integer minRepetitions)
Sets the minimum expected repetitions of the element.
|
void |
setName(java.lang.String name) |
void |
setVisible(boolean visible) |
java.lang.String |
toString() |
protected boolean editable
protected java.lang.Integer maxRepetitions
protected java.lang.Integer minRepetitions
protected java.lang.String name
For SEQUENCES: The SWIFT common naming is recommended: A, B, C, etc... for sequences and A1, B1, etc... for sub sequences.
For FIELDS: THe attribute contains the field number (without letter option).
public static final java.lang.Integer UNLIMITED
protected boolean visible
public BaseSchemeElement()
protected BaseSchemeElement(java.lang.String name)
protected BaseSchemeElement(java.lang.String name, java.lang.Integer minRepetitions, java.lang.Integer maxRepetitions)
public SchemeField asField()
SchemeField
or null
if is not that typeisField()
public SchemeFieldSet asFieldSet()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public java.lang.String getDescription()
public java.lang.Long getId()
public java.lang.Integer getMaxRepetitions()
public java.lang.Integer getMinRepetitions()
public java.lang.String getName()
public int hashCode()
hashCode
in class java.lang.Object
public boolean isEditable()
public boolean isField()
public boolean isFieldSet()
public boolean isMandatory()
public boolean isOptional()
isMandatory()
public boolean isRepetitive()
public boolean isSequence()
public boolean isUnlimited()
public boolean isVisible()
public void setDescription(java.lang.String description)
public void setEditable(boolean editable)
public void setId(java.lang.Long id)
id
- the id to setpublic void setMaxRepetitions(java.lang.Integer maxRepetitions)
maxRepetitions
- maximum allowed repetitions, it must be UNLIMITED or greater than zerojava.lang.IllegalArgumentException
- if the argument is not greater than zero, nor UNLIMITEDpublic void setMinRepetitions(java.lang.Integer minRepetitions)
minRepetitions
- minimum expected repetitions, it must be UNLIMITED or positivejava.lang.IllegalArgumentException
- if the argument is not greater or equals than zero, nor UNLIMITEDpublic void setName(java.lang.String name)
public void setVisible(boolean visible)
public java.lang.String toString()
toString
in class java.lang.Object