public interface EntityFilter
Modifier and Type | Field and Description |
---|---|
static String |
PROPERTY_END_INDEX |
static String |
PROPERTY_ORDER_BY |
static String |
PROPERTY_REFERENCE_ID |
static String |
PROPERTY_REFERENCE_PROPERTY |
static String |
PROPERTY_START_INDEX |
Modifier and Type | Method and Description |
---|---|
void |
addPropertyChangeListener(PropertyChangeListener listener)
Add PropertyChangeListener.
|
void |
checkReference(Class<?> reference,
boolean mandatory)
Use to check if
reference class is supported by the current
filter reference. |
Integer |
getEndIndex()
Get the value of endIndex
|
String |
getOrderBy()
Get the value of orderBy
|
String |
getReferenceId()
Get the value of referenceId
|
String |
getReferenceProperty()
Get the value of referenceProperty
|
Integer |
getStartIndex()
Get the value of startIndex
|
boolean |
hasReference()
Used to check if the filter contains a reference.
|
boolean |
isClassReference(Class<?> entityClass)
Test if the
entityClass is corresponding to the current reference
in the filter. |
void |
removePropertyChangeListener(PropertyChangeListener listener)
Remove PropertyChangeListener.
|
void |
setEndIndex(Integer endIndex)
Set the value of endIndex
|
void |
setOrderBy(String orderBy)
Set the value of orderBy
|
void |
setReference(Object entity)
Set the value of referenceId from
entity |
void |
setReferenceId(String referenceId)
Set the value of referenceId
|
void |
setReferenceProperty(String referenceProperty)
Set the value of referenceProperty
|
void |
setStartIndex(Integer startIndex)
Set the value of startIndex
|
static final String PROPERTY_START_INDEX
static final String PROPERTY_END_INDEX
static final String PROPERTY_ORDER_BY
static final String PROPERTY_REFERENCE_ID
static final String PROPERTY_REFERENCE_PROPERTY
Integer getStartIndex()
void setStartIndex(Integer startIndex)
startIndex
- new value of startIndexString getOrderBy()
void setOrderBy(String orderBy)
orderBy
- new value of orderByInteger getEndIndex()
void setEndIndex(Integer endIndex)
endIndex
- new value of endIndexString getReferenceId()
void setReferenceId(String referenceId)
referenceId
- void setReference(Object entity) throws IllegalArgumentException
entity
entity
- IllegalArgumentException
boolean hasReference()
void checkReference(Class<?> reference, boolean mandatory) throws IllegalArgumentException
reference
class is supported by the current
filter reference. The reference can be not mandatory
. Exceptions
are thrown if the check failed. If you prefer to have a boolean instead
of exceptions, you can use isClassReference(Class)
.reference
- Class reference to checkmandatory
- If the existence of the reference is mandatoryIllegalArgumentException
- for errors on checkhasReference()
,
isClassReference(Class)
boolean isClassReference(Class<?> entityClass)
entityClass
is corresponding to the current reference
in the filter. Will return false if no reference is set in the filter.entityClass
- Class reference to testcheckReference(Class, boolean)
String getReferenceProperty()
void setReferenceProperty(String referenceProperty)
referenceProperty
- void addPropertyChangeListener(PropertyChangeListener listener)
listener
- void removePropertyChangeListener(PropertyChangeListener listener)
listener
- Copyright © 2004–2022 Code Lutin. All rights reserved.