net.sf.mmm.search.api.config

Interface SearchFieldConfiguration

All Known Implementing Classes:

SearchFieldConfigurationBean

public interface SearchFieldConfiguration

This is the interface for the configuration of a field.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
SearchFieldMode	getMode() This method gets the mode of the field.
String	getName() This method gets the name of the field.
SearchFieldType	getType() This method gets the type of the according field.
boolean	isHidden() This method determines if the represented field shall be hidden in the view.

Method Detail

getName

String getName()

This method gets the name of the field. It is used as key to identify the field.

Returns:

the field-name.

getType

SearchFieldType getType()

This method gets the type of the according field.

Returns:

the field-type.

See Also:

SearchEntry.getField(String, Class)

getMode

SearchFieldMode getMode()

This method gets the mode of the field.

Returns:

the SearchFieldMode.

isHidden

boolean isHidden()

This method determines if the represented field shall be hidden in the view. This means it is NOT displayed in the details of a SearchHit. The default is false.

Returns:

true if hidden, false otherwise.