public interface FilterParam extends Param
This container of filter parameters is created by
Context.makeFilterParam()
and it is used by
Context.makeFilter()
.
Modifier and Type | Method and Description |
---|---|
String |
getDefinition()
Returns the filter definition of the new filter.
|
int |
getEntityClassID()
Returns the EntityClassID of the associated
EntityClass of the
new filter. |
int |
getType()
Returns the filter type of the new filter.
|
void |
setDefinition(String definition)
Set/replace the filter definition of the new filter.
|
void |
setEntityClassID(int entityClassID)
Set/replace the associated
EntityClass of the new filter. |
void |
setType(int type)
Set/replace the filter type of the new filter.
|
int getEntityClassID()
EntityClass
of the
new filter.
The associated EntityClass
is one of the 3 things that define a
filter: (associated EntityClass, filter type and
the optional filter definition).
The precise meaning of these 3 things depends from the particular filter and, in general, it must be agreed between the client and the server.
The server may subsequently returns a
FilterCreateEvent.RESULT_INVALID_ENTITY_CLASS_ID
failure-code if it does not understand this value.
Filter.create()
JFT.THIS
.isRegistered(getEntityClassID())
EntityClass
of the
new filter.who sets this value
int getType()
The filter type is one of the 3 things that define a filter: (associated EntityClass, filter type and the optional filter definition).
The precise meaning of these 3 things depends from the particular filter and, in general, it must be agreed between the client and the server.
The server may subsequently returns a
FilterCreateEvent.RESULT_INVALID_FILTER_TYPE
failure-code if it does not understand this value.
Filter.create()
getType() >= 0
who sets this value
String getDefinition()
The filter definition is one of the 3 things that define a filter: (associated EntityClass, filter type and the optional filter definition).
The precise meaning of these 3 things depends from the particular filter and, in general, it must be agreed between the client and the server.
The server may subsequently returns a
FilterCreateEvent.RESULT_SYNTAX_ERROR
or a
FilterCreateEvent.RESULT_INVALID_FILTER_LEN
failure-code if it does not understand this value or if this value is too
long.
This value is optional: null
and empty strings are
acceptable values and, in this case, no definition is given to the
server.
Filter.create()
null
.
true // any value
who sets this value
void setEntityClassID(int entityClassID) throws IllegalStateException
EntityClass
of the new filter.
entityClassID
- EntityClassID of the associated EntityClass
of the new
filter.IllegalStateException
- if this container is already bound.default/current/acceptable values and their
meaning
void setType(int type) throws IllegalStateException
type
- type of the new filter.IllegalStateException
- if this container is already bound.default/current/acceptable values and their meaning
void setDefinition(String definition) throws IllegalStateException
definition
- filter definition of the new filter.IllegalStateException
- if this container is already bound.default/current/acceptable values and their meaning
Submit a bug or feature to FT\API Programming Support