org.sourceid.saml20.adapter.gui
Class TableDescriptor

java.lang.Object
  org.sourceid.saml20.adapter.gui.TableDescriptor

public class TableDescriptor
extends java.lang.Object

A class that describes to the PingFederate server the way a table of fields should be rendered.

Author:

Brian Campbell

See Also:

AdapterConfigurationGuiDescriptor.addTable(TableDescriptor), FieldDescriptor, RowValidator

Constructor Summary

TableDescriptor(java.lang.String name, java.lang.String description)
Create a TableDescriptor with a name and description.

TableDescriptor(java.lang.String name, java.lang.String description, java.util.List<FieldDescriptor> row)
Create a TableDescriptor with a name, description and a list of fields that comprise a row in the table.

Method Summary

void	addRowField(FieldDescriptor fieldDescriptor) Add a FieldDescriptor to the list of fields that make up a row in this table.
void	addValidator(RowValidator validator) Add a RowValidator to the ordered list of RowValidator for this table.
java.lang.String	getDescription() Gets the description of this table.
java.lang.String	getName() Gets the name of this table.
java.util.List<FieldDescriptor>	getRowFields() Gets the List of FieldDescriptors that make up a row in this table.
java.util.List<RowValidator>	getValidationChain() Gets the list of RowValidators for this table

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TableDescriptor

public TableDescriptor(java.lang.String name,
                       java.lang.String description)

Create a TableDescriptor with a name and description. The name and description will be displayed on the GUI configuration page.

Parameters:

name - the name of the table.

description - a description of the table.

TableDescriptor

public TableDescriptor(java.lang.String name,
                       java.lang.String description,
                       java.util.List<FieldDescriptor> row)

Create a TableDescriptor with a name, description and a list of fields that comprise a row in the table. The name and description will be displayed on the GUI configuration page. And the Fields in the row will make up the entry fields in each row of the table in the GUI.

Parameters:

name - the name of the table.

description - a description of the table.

row - a List of FieldDescriptors that describe a row in the table.

Method Detail

getDescription

public java.lang.String getDescription()

Gets the description of this table.

Returns:

the description.

getName

public java.lang.String getName()

Gets the name of this table.

Returns:

the name.

getRowFields

public java.util.List<FieldDescriptor> getRowFields()

Gets the List of FieldDescriptors that make up a row in this table.

Returns:

a List of FieldDescriptors.

addRowField

public void addRowField(FieldDescriptor fieldDescriptor)

Add a FieldDescriptor to the list of fields that make up a row in this table.

Parameters:

fieldDescriptor - the field to add as the last field in the row.

addValidator

public void addValidator(RowValidator validator)

Add a RowValidator to the ordered list of RowValidator for this table.

Parameters:

validator - the validator

getValidationChain

public java.util.List<RowValidator> getValidationChain()

Gets the list of RowValidators for this table

Returns:

a list of RowValidators.