|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EntityLookupModel
A interface responsible for doing entity lookups based on a set of criteria properties.
Method Summary | |
---|---|
void |
addSearchStringListener(ActionListener listener)
|
void |
addSelectedEntitiesListener(ActionListener listener)
|
String |
getDescription()
|
List<Property.ColumnProperty> |
getLookupProperties()
|
String |
getMultipleValueSeparator()
|
String |
getSearchString()
|
List<Entity> |
getSelectedEntities()
|
String |
getWildcard()
|
boolean |
isCaseSensitive()
|
boolean |
isMultipleSelectionAllowed()
|
boolean |
isWildcardPostfix()
|
boolean |
isWildcardPrefix()
|
List<Entity> |
performQuery()
Performs a query based on the select criteria |
void |
refreshSearchText()
Refreshes the search text so that is represents the selected entities |
void |
removeSearchStringListener(ActionListener listener)
|
void |
removeSelectedEntitiesListener(ActionListener listener)
|
EventObserver |
searchStringObserver()
|
boolean |
searchStringRepresentsSelected()
|
EntityLookupModel |
setAdditionalLookupCriteria(Criteria additionalLookupCriteria)
Sets the additional lookup criteria to use when performing the lookup. |
EntityLookupModel |
setCaseSensitive(boolean caseSensitive)
Specifies whether or not this lookup model should be case sensitive |
void |
setDescription(String description)
|
void |
setMultipleSelectionAllowed(boolean multipleSelectionAllowed)
Specifies whether or not this lookup model should allow selection of multiple entities |
EntityLookupModel |
setMultipleValueSeparator(String multipleValueSeparator)
Sets the string to use to separate multiple values when shown as a string |
void |
setSearchString(String searchString)
Sets the search string to use when performing the next lookup |
void |
setSelectedEntities(List<Entity> entities)
Sets the selected entities |
void |
setSelectedEntity(Entity entity)
Sets the given entity as the selected entity |
EntityLookupModel |
setWildcard(String wildcard)
Sets the wildcard to use |
EntityLookupModel |
setWildcardPostfix(boolean wildcardPostfix)
Specifies whether or not to automatically append a wildcard to the search string |
EntityLookupModel |
setWildcardPrefix(boolean wildcardPrefix)
Specifies whether or not to automatically prefix the search string with a wildcard |
Methods inherited from interface org.jminor.framework.client.model.EntityDataProvider |
---|
getConnectionProvider, getEntityID |
Method Detail |
---|
List<Entity> getSelectedEntities()
void setSelectedEntity(Entity entity)
entity
- the entity to set as the selected entityvoid setSelectedEntities(List<Entity> entities)
entities
- the entities to set as selected
IllegalArgumentException
- if this lookup model does not allow multiple selections and entities.size() > 1
String getDescription()
void setDescription(String description)
description
- a string describing this lookup modelList<Property.ColumnProperty> getLookupProperties()
boolean isMultipleSelectionAllowed()
void setMultipleSelectionAllowed(boolean multipleSelectionAllowed)
multipleSelectionAllowed
- if true then selection of multiple entities is allowedvoid refreshSearchText()
void setSearchString(String searchString)
searchString
- the search stringString getSearchString()
EntityLookupModel setWildcard(String wildcard)
wildcard
- the wildcard
String getWildcard()
boolean searchStringRepresentsSelected()
List<Entity> performQuery()
boolean isCaseSensitive()
EntityLookupModel setCaseSensitive(boolean caseSensitive)
caseSensitive
- if true then this lookup model is case sensitive
boolean isWildcardPrefix()
EntityLookupModel setWildcardPrefix(boolean wildcardPrefix)
wildcardPrefix
- if true then a wildcard is automatically prefixed to the search string
boolean isWildcardPostfix()
EntityLookupModel setWildcardPostfix(boolean wildcardPostfix)
wildcardPostfix
- if true then a wildcard is automatically appended to the search string
EntityLookupModel setMultipleValueSeparator(String multipleValueSeparator)
multipleValueSeparator
- the separator string
String getMultipleValueSeparator()
EntityLookupModel setAdditionalLookupCriteria(Criteria additionalLookupCriteria)
additionalLookupCriteria
- the additional lookup criteria
void addSelectedEntitiesListener(ActionListener listener)
listener
- a listener to be notified each time the selected entities are changedvoid removeSelectedEntitiesListener(ActionListener listener)
listener
- the listener to removeEventObserver searchStringObserver()
void addSearchStringListener(ActionListener listener)
listener
- a listener to be notified each time the search string changesvoid removeSearchStringListener(ActionListener listener)
listener
- the listener to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |