public interface QueryParam extends Param
This container of query parameters is created by
Context.makeQueryParam()
and it is used by
Context.makeQuery()
.
Modifier and Type | Method and Description |
---|---|
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.
|
int getQueryID()
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.
Query.create()
who sets this value
Entity getQueryParameterEntity()
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.
Query.create()
null
true // any value
who sets this value
void setQueryID(int queryID) throws IllegalStateException
queryID
- the QueryID of the new query.IllegalStateException
- if this container is already bound.default/current/acceptable values and their meaning
void setQueryParameterEntity(Entity queryParameter) throws IllegalStateException
queryParameter
- the Query Parameter Entity of the new query.IllegalStateException
- if this container is already bound.default/current/acceptable values and their
meaning
Submit a bug or feature to FT\API Programming Support