it.list.jft
Interface EntityFilter

All Superinterfaces:
ActivityLifeCycle, CommunicationLifeCycle, Filter, LifeCycle

public interface EntityFilter
extends Filter

Usually, fasttrack serverices implements a default filter to restrict the set of values notified by a Subscription, based on full or partial key values.

To use this you must set the filter type value as TYPE_ENTITYFILTER and the Entity Class ID used by subscription. The filter returned by makeFilter can be safely casted to EntityFilter.
After that, it may be used in a subcription setting an empty EntityKey whill will be used to set filter key values. Please note, you must create and set up different filters for different subscriptions; a filter is not allowed to be used for many subscription simultaneously.
To change filter value you may call:

Plese note, the set method doesn't perform any action for this class.

You should call flush after many filter operations to force any buffered action to be sent to the server.

See Also:
Filter, FilterParam, FilterListener

Field Summary
static int TYPE_ENTITYFILTER
          The filter type value.
 
Fields inherited from interface Filter
STATUS_CREATED, STATUS_CREATING, STATUS_DESTROYED, STATUS_DESTROYING
 
Fields inherited from interface ActivityLifeCycle
RESULT_INVALID_CONNECTION_STATUS
 
Fields inherited from interface LifeCycle
RESULT_GENERIC_ERROR, RESULT_INVALID_STATUS, RESULT_OK, STATUS_INIT, STATUS_RELEASED
 
Method Summary
 int add(EntityKey entityKey)
          Add the EntityKey to the filter.
 int del(EntityKey entityKey)
          Remove the EntityKey from the filter.
 int flush()
          Send to the server any buffered filter action.
 int reset()
          Remove all the key values from the filter.
 
Methods inherited from interface Filter
create, destroy, set
 
Methods inherited from interface ActivityLifeCycle
getConnection
 
Methods inherited from interface CommunicationLifeCycle
getContext, getListener, getParam
 
Methods inherited from interface LifeCycle
enumChilds, getStatus, release
 

Field Detail

TYPE_ENTITYFILTER

static final int TYPE_ENTITYFILTER
The filter type value.

See Also:
Constant Field Values
Method Detail

add

int add(EntityKey entityKey)
Add the EntityKey to the filter.

Parameters:
entityKey - the partial or full EntityKey.
Returns:

del

int del(EntityKey entityKey)
Remove the EntityKey from the filter.

Parameters:
entityKey - the partial or full EntityKey.
Returns:

reset

int reset()
Remove all the key values from the filter.

Returns:

flush

int flush()
Send to the server any buffered filter action.

Returns:


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