to.etc.domui.component.meta
Annotation Type MetaSearchItem


@Retention(value=RUNTIME)
public @interface MetaSearchItem

This is an item in an object's default search definition. This defines a property on that object as a property which the user needs to be able to search on. It is valid within a @Search class-level annotation only.

Author:
Frits Jalvingh Created on Oct 7, 2009

Optional Element Summary
 boolean ignoreCase
          Generate a CI query by default.
 java.lang.String lookupHintKey
           
 java.lang.String lookupLabelKey
          This defines a key in the class's bundle for a string to use as the lookup field's label.
 int minLength
          This defines the minimal length a user must enter into a search control before it is allowed to search.
 java.lang.String name
          The name of the property to search on in this object.
 int order
          If this specification is used in combination with @SearchProperty annotations this field must be used to define an order.
 SearchPropertyType searchType
          This defines how search property would be used.
 

name

public abstract java.lang.String name
The name of the property to search on in this object. When unset this specification must specify a lookup field generator class.

Returns:
Default:
""

order

public abstract int order
If this specification is used in combination with @SearchProperty annotations this field must be used to define an order.

Returns:
Default:
-1

minLength

public abstract int minLength
This defines the minimal length a user must enter into a search control before it is allowed to search. This can be used to prevent searches on 'a%' if that would cause a problematic query.

Returns:
Default:
-1

ignoreCase

public abstract boolean ignoreCase
Generate a CI query by default. Unused?

Returns:
Default:
true

lookupLabelKey

public abstract java.lang.String lookupLabelKey
This defines a key in the class's bundle for a string to use as the lookup field's label. This is normally used for compound specs only.

Default:
""

lookupHintKey

public abstract java.lang.String lookupHintKey
Default:
""

searchType

public abstract SearchPropertyType searchType
This defines how search property would be used. By default it is set to use only see SearchPropertyType.SEARCH_FIELD. This is normally used for compound specs only.

Default:
to.etc.domui.component.meta.SearchPropertyType.SEARCH_FIELD