de.espirit.firstspirit.access.store.templatestore.gom
Interface GomIncludeValueProvider<T>

public interface GomIncludeValueProvider<T>

Hot-spot interface to provide a list of values for input components.

Some input components (e.g. CMS_INPUT_COMBOBOX) support an arbitrary list of values the user can choose from. This value list can be injected by an INCLUDE tag inside the GOM xml:

  <CMS_INCLUDE_OPTIONS type="public">
     <NAME>public_name</NAME>
     <PARAMS>
         <PARAM name="key1">value1</PARAM>
         <PARAM name="key2">value2</PARAM>
     </PARAMS>
  </CMS_INCLUDE_OPTIONS>
 

The paramters are provided to instances of type Parameterizable by a setParameters-call.

Since:

4.2

Example:

This is a basic example

Method Summary

String	getKey(T value) Return a unique key for a specific value.
Class<T>	getType() The generic content type (see List<T> getValues(UserService) and String getKey(T)).
List<T>	getValues(SpecialistsBroker broker) Get the list of included values.
List<T>	getValues(UserService userService) Deprecated. since 4.2.400 Use GomIncludeValueProvider.getValues(SpecialistsBroker) instead.

Method Detail

getType

@NotNull
Class<T> getType()

The generic content type (see List<T> getValues(UserService) and String getKey(T)).

Returns:

The generic content type

Since:

4.2

getValues

@Deprecated
@NotNull
List<T> getValues(@NotNull
                                     UserService userService)

Deprecated. since 4.2.400 Use GomIncludeValueProvider.getValues(SpecialistsBroker) instead.

Callback used to get the list of included values.

Parameters:

userService -

Returns:

list of include values

Since:

4.2

getValues

@NotNull
List<T> getValues(@NotNull
                          SpecialistsBroker broker)

Get the list of included values.

Parameters:

broker - The broker providing environment access.

Returns:

A list of include values.

Since:

4.2.400

getKey

@NotNull
String getKey(@NotNull
                      T value)

Return a unique key for a specific value. Used for persistence.

Parameters:

value - a value from getValues(..)

Returns:

An unambiguous key for the specified value.

Since:

4.2