it.list.jft
Interface QueryParam

All Superinterfaces:
Param

public interface QueryParam
extends Param

Query parameter container.

This container of query parameters is created by Context.makeQueryParam() and it is used by Context.makeQuery().

See Also:
Query Usage, Acceptable Values

Method Summary
 int getQueryID()
          Returns the QueryID of the new query.
 Entity getQueryParameterEntity()
          Returns the Query Parameter Entity of the new query.
 void setQueryID(int queryID)
          Set/replace the QueryID of the new query.
 void setQueryParameterEntity(Entity queryParameter)
          Set/replace the Query Parameter Entity of the new query.
 
Methods inherited from interface Param
isBound
 

Method Detail

getQueryID

int getQueryID()
Returns the QueryID of the new query.

The QueryID identifies a given query into the server and so its value must be agreed between the client and the server.

The server may subsequently returns QueryCreateEvent.RESULT_WRONG_QUERY_ID failure-code if it does not understand this value.

Used by:
Query.create()
Default value:
0
Acceptable values:
getQueryID() > 0

Returns:
the QueryID of the new query.
See Also:
who sets this value

getQueryParameterEntity

Entity getQueryParameterEntity()
Returns the Query Parameter Entity of the new query.

The Query Parameter Entity is the argument of the new query and it is given to the server and so its meaning must be agreed between the client and the server.

The server may subsequently returns QueryCreateEvent.RESULT_BAD_PARAMETERS failure-code if it does not understand this value.

This value is optional: null is an acceptable value and, in this case, no argument is given to the server.

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

Returns:
the QueryID of the new query.
See Also:
who sets this value

setQueryID

void setQueryID(int queryID)
                throws IllegalStateException
Set/replace the QueryID of the new query.

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

setQueryParameterEntity

void setQueryParameterEntity(Entity queryParameter)
                             throws IllegalStateException
Set/replace the Query Parameter Entity of the new query.

Parameters:
queryParameter - the Query Parameter Entity of the new query.
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>