|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.pingidentity.sources.gui.FilterFieldsGuiDescriptor
public class FilterFieldsGuiDescriptor
This class provides metadata to PingFederate that is used to display a dynamic UI.
The user enters information into this UI that can filter or limit the result set.
The filter information is then sent to the CustomDataSourceDriver.retrieveValues(Collection, SimpleFieldList)
method during attribute retrieval.
Note: One of the available fields to add to the FilterFieldsGuiDescriptor is UploadFileFieldDescriptor
.
This field descriptor allows a user to upload a file. If this field is added to the FilterFieldsGuiDescriptor, the file will be uploaded
when the initialize upload is invoked and then saved as part of the connection. To refresh the information (if the file content changes) the user
will need to edit the connection and re-invoke the UpLoadFileFieldDescriptor. This information will be saved as part of the connection
information, possiblely making the connection xml footprint very large (depending upon the file size).
CustomDataSourceDriverDescriptor
,
CustomDataSourceDriver.retrieveValues(Collection, SimpleFieldList)
Constructor Summary | |
---|---|
FilterFieldsGuiDescriptor()
Default constructor |
|
FilterFieldsGuiDescriptor(java.lang.String description)
Create a new FilterFieldsGuiDescriptor with a description. |
Method Summary | |
---|---|
void |
addField(FieldDescriptor fieldDescriptor)
Add a user entry field to this GUI configuration descriptor. |
java.lang.String |
getDescription()
Gets the description. |
java.util.List<FieldDescriptor> |
getFields()
Gets the ordered list of FieldDescriptors. |
void |
setDescription(java.lang.String description)
Set the description that will be displayed at the top of the GUI configuration page. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public FilterFieldsGuiDescriptor()
public FilterFieldsGuiDescriptor(java.lang.String description)
description
- the description that will be displayed at the top of the GUI
configuration page.Method Detail |
---|
public void addField(FieldDescriptor fieldDescriptor)
fieldDescriptor
- the field to add.public java.util.List<FieldDescriptor> getFields()
public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- the new description.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |