org.openlowcode.design.pages

Class SearchWidgetDefinition

java.lang.Object

org.openlowcode.design.pages.SearchWidgetDefinition

public class SearchWidgetDefinition
extends java.lang.Object

A search widget definition can be added to the automatically generated search page for an object

Author:

Open Lowcode SAS

Field Summary

Fields

Modifier and Type	Field and Description
static int	POSTTREATMENT_EASYTEXTSEARCH performs a post treatment for easy text search
static int	POSTTREATMENT_NONE performs a post treatment with no effect

Constructor Summary

Constructors

Constructor and Description
SearchWidgetDefinition(boolean primary) creates a search widget definition
SearchWidgetDefinition(boolean primary, java.lang.String fieldname, java.lang.String displayname) Create a search widget definition for plain text field
SearchWidgetDefinition(boolean primary, java.lang.String fieldname, java.lang.String displayname, ChoiceCategory multiplechoicecategory) creates a search widget definition using a choice category.
SearchWidgetDefinition(boolean primary, java.lang.String fieldname, java.lang.String displayname, ChoiceCategory multiplechoicecategory, boolean searchasstring)
SearchWidgetDefinition(boolean primary, java.lang.String fieldname, java.lang.String displayname, int posttreatment) create a search widget definition with potential post-treatment
SearchWidgetDefinition(boolean primary, java.lang.String fieldname, java.lang.String displayname, TimePeriod.PeriodType periodtype) creates a search widget definition for a time period

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDisplayname()
Element	getElement()
java.lang.String	getFieldname()
ChoiceCategory	getMultipleChoiceCategory()
TimePeriod.PeriodType	getPeriodType()
int	getPosttreatment()
boolean	isChoiceSearchInString()
boolean	isPrimary()
void	setReferenceElement(Element element)

Methods inherited from class java.lang.Object

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

Field Detail

POSTTREATMENT_NONE

public static int POSTTREATMENT_NONE

performs a post treatment with no effect

POSTTREATMENT_EASYTEXTSEARCH

public static int POSTTREATMENT_EASYTEXTSEARCH

performs a post treatment for easy text search

Constructor Detail

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary,
                              java.lang.String fieldname,
                              java.lang.String displayname)

Create a search widget definition for plain text field

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

fieldname - name of the field (should be unique for the object)

displayname - the display name if the name of the element should be overridden, null else

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary,
                              java.lang.String fieldname,
                              java.lang.String displayname,
                              int posttreatment)

create a search widget definition with potential post-treatment

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

fieldname - name of the field (should be unique for the object)

displayname - the display name if the name of the element should be overridden, null else

posttreatment - post treatment as defined in a static int in this class

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary,
                              java.lang.String fieldname,
                              java.lang.String displayname,
                              ChoiceCategory multiplechoicecategory)

creates a search widget definition using a choice category. The widget will allow several selections

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

fieldname - name of the field (should be unique for the object)

displayname - the display name if the name of the element should be overridden, null else

multiplechoicecategory - choice category

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary,
                              java.lang.String fieldname,
                              java.lang.String displayname,
                              TimePeriod.PeriodType periodtype)

creates a search widget definition for a time period

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

fieldname - name of the field (should be unique for the object)

displayname - the display name if the name of the element should be overridden, null else

periodtype - type of time period

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary,
                              java.lang.String fieldname,
                              java.lang.String displayname,
                              ChoiceCategory multiplechoicecategory,
                              boolean searchasstring)

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

fieldname - name of the field (should be unique for the object)

displayname - the display name if the name of the element should be overridden, null else

multiplechoicecategory - choice category

searchasstring - if the search is using a choice

SearchWidgetDefinition

public SearchWidgetDefinition(boolean primary)

creates a search widget definition

Parameters:

primary - true if the element should be shown as primary, false if the field should be shown in the collapsible part of the search screen

Method Detail

isChoiceSearchInString

public boolean isChoiceSearchInString()

Returns:

true if the search is using a choice

getPeriodType

public TimePeriod.PeriodType getPeriodType()

Returns:

get the period type if the search widget is a time period

getMultipleChoiceCategory

public ChoiceCategory getMultipleChoiceCategory()

Returns:

the choice category used for this search widget

setReferenceElement

public void setReferenceElement(Element element)

Parameters:

element - sets the element that is used for the search widget (data element - mostly stored element)

isPrimary

public boolean isPrimary()

Returns:

true if the search field is primary

getFieldname

public java.lang.String getFieldname()

Returns:

the field name (unique)

getDisplayname

public java.lang.String getDisplayname()

Returns:

the field description / label as shown in the screen

getPosttreatment

public int getPosttreatment()

Returns:

the type of post-treatment ( static int in this class)

getElement

public Element getElement()

Returns:

the element the search widget is refering to