org.sourceid.saml20.adapter.gui

Class PolicyContractFieldDescriptor

java.lang.Object

org.sourceid.saml20.adapter.gui.FieldDescriptor

org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

org.sourceid.saml20.adapter.gui.PolicyContractFieldDescriptor

All Implemented Interfaces:

Serializable

public class PolicyContractFieldDescriptor
extends FilterableSelectionFieldDescriptor

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

FilterableSelectionFieldDescriptor.FilterableSelectionFieldDefaultValidator, FilterableSelectionFieldDescriptor.QueryParam, FilterableSelectionFieldDescriptor.SearchableType, FilterableSelectionFieldDescriptor.SearchableTypeConfig

Nested classes/interfaces inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

FieldDescriptor.FieldValidationWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	DESC_FIELD_POLICY_CONTRACT
static String	FIELD_POLICY_CONTRACT

Fields inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

SELECTED_VALUE_DELIMITER, STORAGE_KEY_DELIMITER

Constructor Summary

Constructors

Constructor and Description
PolicyContractFieldDescriptor(String name, String description) Creates a new PolicyContractFieldDescriptor.

Method Summary

Modifier and Type	Method and Description
String	getFormattedValue(String value) Gets the formatted value, by default returns the same string value returned by getSelectedDisplayName.
List<FilterableSelectionFieldDescriptor.SearchableTypeConfig>	getSearchableTypes() Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.
String	getSelectedDisplayName(String valueForStorage) Gets the display string value of a stored value returned by parseSelectedValueForStorage.
String	parseSelectedValueForStorage(String selectedValue) Parses the selected value of the filterable drop-down menu for storage.

Methods inherited from class org.sourceid.saml20.adapter.gui.FilterableSelectionFieldDescriptor

isValidFormat

Methods inherited from class org.sourceid.saml20.adapter.gui.FieldDescriptor

addValidator, addValidator, getDefaultForLegacyConfig, getDefaultValue, getDescription, getLabel, getName, getValidationChain, isHidden, setDefaultForLegacyConfig, setDefaultValue, setHidden, setLabel

Methods inherited from class java.lang.Object

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

Field Detail

DESC_FIELD_POLICY_CONTRACT

public static final String DESC_FIELD_POLICY_CONTRACT

See Also:

Constant Field Values

FIELD_POLICY_CONTRACT

public static final String FIELD_POLICY_CONTRACT

See Also:

Constant Field Values

Constructor Detail

PolicyContractFieldDescriptor

public PolicyContractFieldDescriptor(String name,
                                     String description)

Creates a new PolicyContractFieldDescriptor.

Parameters:

name - the field name

description - a helpful description of the field

Method Detail

parseSelectedValueForStorage

public String parseSelectedValueForStorage(String selectedValue)

Description copied from class: FilterableSelectionFieldDescriptor

Parses the selected value of the filterable drop-down menu for storage.

Overrides:

parseSelectedValueForStorage in class FilterableSelectionFieldDescriptor

Parameters:

selectedValue - selected value of the filterable drop-down menu, following the format "[search type tab title]-[selected entry ID]"

     NOTE:
     The search type tab title part is only useful when the filterable selection field descriptor implementation
     supports multiple search types, so for implementation that supports only one search type, the tab title may
     be parsed out and discarded.

     For example, for the selected value, 'OAuth Clients-sampleOAuthClient', where 'OAuth Clients' is the search
     type tab title and 'sampleOAuthClient' is the unique OAuth client ID that may be used to retrieve an OAuth
     client data object from a data store, a FilterableSelectionFieldDescriptor implementation that only supports
     searches over OAuth clients may have no reason to keep track of the search type, so the tab title
     'OAuth Clients' may be discarded.
 

Returns:

parsed string value based on the selectedValue to be used when the selected value is saved

getSearchableTypes

public List<FilterableSelectionFieldDescriptor.SearchableTypeConfig> getSearchableTypes()

Description copied from class: FilterableSelectionFieldDescriptor

Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.

Specified by:

getSearchableTypes in class FilterableSelectionFieldDescriptor

Returns:

a list of search type configuration supported by this filterable selection field descriptor

getSelectedDisplayName

public String getSelectedDisplayName(String valueForStorage)

Description copied from class: FilterableSelectionFieldDescriptor

Gets the display string value of a stored value returned by parseSelectedValueForStorage.

     For example, when a unique OAuth client ID is returned by parseSelectedValueForStorage, instead of using the
     client ID as the display string, a FilterableSelectionFieldDescriptor implementation may opt to display the
     corresponding client name of client ID instead, possibly obtained through data store query.
 

Overrides:

getSelectedDisplayName in class FilterableSelectionFieldDescriptor

Parameters:

valueForStorage - typically an unique ID of a data object, e.g. a connection (system) ID, an adapter ID, or an OAuth client ID etc.

Returns:

drop-down box display value for the selected item

getFormattedValue

public String getFormattedValue(String value)

Description copied from class: FilterableSelectionFieldDescriptor

Gets the formatted value, by default returns the same string value returned by getSelectedDisplayName.

Overrides:

getFormattedValue in class FilterableSelectionFieldDescriptor

Parameters:

value - typically an unique ID of a data object, e.g. a connection ID, an adapter ID, or an OAuth client ID etc.

Returns:

returns the display name of the policy contract if one is set, otherwise returns an empty string.