it.list.jft
Interface FilterParam

All Superinterfaces:
Param

public interface FilterParam
extends Param

Filter parameter container.

This container of filter parameters is created by Context.makeFilterParam() and it is used by Context.makeFilter().

See Also:
Filter Usage, Acceptable Values

Method Summary
 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.
 
Methods inherited from interface Param
isBound
 

Method Detail

getEntityClassID

int getEntityClassID()
Returns the EntityClassID of the associated 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.

Used by:
Filter.create()
Default value:
0
Acceptable values:
JFT.THIS.isRegistered(getEntityClassID())

Returns:
the EntityClassID of the associated EntityClass of the new filter.
See Also:
who sets this value

getType

int getType()
Returns the filter type of the new filter.

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.

Used by:
Filter.create()
Default value:
0
Acceptable values:
getType() >= 0

Returns:
the filter type of the new filter.
See Also:
who sets this value

getDefinition

String getDefinition()
Returns the filter definition of the new filter.

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.

Used by:
Filter.create()
Default value:
null.
Acceptable values:
true // any value

Returns:
the filter definition of the new filter.
See Also:
who sets this value

setEntityClassID

void setEntityClassID(int entityClassID)
                      throws IllegalStateException
Set/replace the associated EntityClass of the new filter.

Parameters:
entityClassID - EntityClassID of the associated EntityClass of the new filter.
Throws:
IllegalStateException - if this container is already bound.
See Also:
default/current/acceptable values and their meaning

setType

void setType(int type)
             throws IllegalStateException
Set/replace the filter type of the new filter.

Parameters:
type - type of the new filter.
Throws:
IllegalStateException - if this container is already bound.
See Also:
default/current/acceptable values and their meaning

setDefinition

void setDefinition(String definition)
                   throws IllegalStateException
Set/replace the filter definition of the new filter.

Parameters:
definition - filter definition of the new filter.
Throws:
IllegalStateException - if this container is already bound.
See Also:
default/current/acceptable values and their meaning


Submit a bug or feature to FT\API Programming Support<\font>