|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.sourceid.saml20.adapter.gui.FieldDescriptor
public abstract class FieldDescriptor
An abstract base type for describing GUI fields to be rendered in the PingFederate administration console. See the various subclasses for specific types (text field, drop down, checkbox, etc.).
AdapterConfigurationGuiDescriptor.addField(FieldDescriptor)
,
AdapterConfigurationGuiDescriptor.addAdvancedField(FieldDescriptor)
,
TableDescriptor.addRowField(FieldDescriptor)
,
Serialized FormNested Class Summary | |
---|---|
class |
FieldDescriptor.FieldValidationWrapper
A wrapper class to support the 'skip if' functionality in addValidator(org.sourceid.saml20.adapter.gui.validation.FieldValidator, boolean) |
Constructor Summary | |
---|---|
protected |
FieldDescriptor(java.lang.String name,
java.lang.String description)
Create a new FieldDescriptor. |
Method Summary | |
---|---|
void |
addValidator(FieldValidator validator)
Add a FieldValidator to the back of the ordered list of validators for this field. |
void |
addValidator(FieldValidator validator,
boolean skipIfEmptyValue)
Add a FieldValidator to the back of the ordered list of validators for this field. |
java.lang.String |
getDefaultValue()
Gets the default value for this field. |
java.lang.String |
getDescription()
Gets a description of this field. |
java.lang.String |
getName()
Gets the name of this field. |
java.util.List<FieldDescriptor.FieldValidationWrapper> |
getValidationChain()
Gets the ordered list of FieldValidators. |
void |
setDefaultValue(java.lang.String defaultValue)
Set the default value for this individual field. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected FieldDescriptor(java.lang.String name, java.lang.String description)
name
- the field name (must be unique per AdapterConfigurationGuiDescriptor or TableDescriptor).description
- a helpful description of the field.Method Detail |
---|
public java.lang.String getName()
public java.lang.String getDescription()
public java.lang.String getDefaultValue()
public void setDefaultValue(java.lang.String defaultValue)
defaultValue
- for this field.public void addValidator(FieldValidator validator)
addValidator(org.sourceid.saml20.adapter.gui.validation.FieldValidator, boolean)
with
false for the last parameter.
validator
- the FieldValidatorpublic void addValidator(FieldValidator validator, boolean skipIfEmptyValue)
validator
- validator the FieldValidatorskipIfEmptyValue
- a boolean indicating if validator should be skipped when the field value is null or empty.
This is useful for situations where you want to perform some validation on a field only if the user entered a
value for the field. For example, you might want a field that is not required but must be an integer if used.public java.util.List<FieldDescriptor.FieldValidationWrapper> getValidationChain()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |