com.qcadoo.view.api.components

Interface LookupComponent

All Superinterfaces:

ComponentMessagesHolder, ComponentState, FieldComponent

public interface LookupComponent
extends FieldComponent

Nested Class Summary

Nested classes/interfaces inherited from interface com.qcadoo.view.api.ComponentState

ComponentState.MessageType

Method Summary

Modifier and Type	Method and Description
String	getCurrentCode() Get current filed code
Entity	getEntity() Returns entity which is selected in lookup
FilterValueHolder	getFilterValue() Gets current criteria modifier parameters value.
boolean	isClearCurrentCode()
boolean	isEmpty() Check if this lookup doesn't have selected any entity and its input is empty.
void	setFilterValue(FilterValueHolder value) Sets filter value which will be send to criteria modifier hook.

Methods inherited from interface com.qcadoo.view.api.components.FieldComponent

isPersistent, isRequired, requestComponentUpdateState, setRequired

Methods inherited from interface com.qcadoo.view.api.ComponentState

getFieldValue, getLocale, getName, getUuid, isEnabled, isHasError, isVisible, performEvent, setEnabled, setFieldValue, setVisible

Methods inherited from interface com.qcadoo.view.api.ComponentMessagesHolder

addMessage, addMessage, addMessage, addMessage, addMessage, addTranslatedMessage, addTranslatedMessage, addTranslatedMessage

Method Detail

getCurrentCode

String getCurrentCode()

Get current filed code

Returns:

current code

getEntity

Entity getEntity()

Returns entity which is selected in lookup

Returns:

entity which is selected in lookup or null when entity is not found in database

getFilterValue

FilterValueHolder getFilterValue()

Gets current criteria modifier parameters value. To modify them use setFilterValue method.

Returns:

Current criteria modifier parameters value.

Since:

1.2.1

isClearCurrentCode

boolean isClearCurrentCode()

isEmpty

boolean isEmpty()

Check if this lookup doesn't have selected any entity and its input is empty.

Returns:

true if this lookup doesn't have selected any entity and its input is empty.

Since:

1.2.1

setFilterValue

void setFilterValue(FilterValueHolder value)

Sets filter value which will be send to criteria modifier hook. Set this value in beforeRender hook to make it work correctly.

Parameters:

value -

Since:

1.2.1