com.onwbp.adaptation
Class Request

java.lang.Object
  com.onwbp.adaptation.Request

public class Request

extends Object

Defines a specific request over a table.

A request is executed by calling the method execute().

Multi-threading

An instance of this class does not lock accesses from multiple concurrent threads.

See Also:

AdaptationTable.createRequest()

Method Summary

RequestResult	execute() Executes the request and returns the result.
AdaptationFilter	getSpecificFilter()
PrimaryKeyWildCard	getWildcard() Deprecated.
boolean	isIncludeEditionDelete() Deprecated. Always returns false.
boolean	isIncludeOcculting()
void	setIncludeEditionDelete(boolean includeEditionDelete) Deprecated. Void method.
void	setIncludeOcculting(boolean includeOcculting) If argument is true, specifies that the request result shall also include adaptations which are in occulting mode.
void	setOrderByPrimaryKey() Specifies that the request result must be ordered by ascending primary key.
void	setSortCriteria(RequestSortCriteria sortCriteria) Specifies that the request result must be sorted according to the specified criteria.
void	setSpecificFilter(AdaptationFilter aFilter) Specifies that the request result shall only include the adaptations which satisfy the filter passed as an argument.
void	setWildcard(PrimaryKeyWildCard wildcard) Deprecated. Replaced by setSpecificFilter(AdaptationFilter).
void	setXPathFilter(String predicate) Specifies that the request result shall only include the occurrences which satisfy the predicate passed as an argument.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

isIncludeEditionDelete

public boolean isIncludeEditionDelete()

Deprecated. Always returns false.

See Also:

setIncludeEditionDelete(boolean)

setIncludeEditionDelete

public void setIncludeEditionDelete(boolean includeEditionDelete)

Deprecated. Void method.

isIncludeOcculting

public boolean isIncludeOcculting()

See Also:

setIncludeOcculting(boolean)

setIncludeOcculting

public void setIncludeOcculting(boolean includeOcculting)

If argument is true, specifies that the request result shall also include adaptations which are in occulting mode.

If not set, this property is false: adaptations in occulting mode are not included in the result.

setOrderByPrimaryKey

public void setOrderByPrimaryKey()

Specifies that the request result must be ordered by ascending primary key.

This is the default sort.

See Also:

setSortCriteria(RequestSortCriteria)

setSortCriteria

public void setSortCriteria(RequestSortCriteria sortCriteria)

Specifies that the request result must be sorted according to the specified criteria.

See Also:

setOrderByPrimaryKey(), AdaptationTable.createRequestResult(String, RequestSortCriteria)

getWildcard

public PrimaryKeyWildCard getWildcard()

Deprecated.

See Also:

setWildcard(PrimaryKeyWildCard)

setWildcard

public void setWildcard(PrimaryKeyWildCard wildcard)

Deprecated. Replaced by setSpecificFilter(AdaptationFilter).

Specifies that the request result shall only include the adaptations which satisfy the primary key wildcard passed as an argument.

If not set, this property is null: no key filtering is performed.

getSpecificFilter

public AdaptationFilter getSpecificFilter()

See Also:

setSpecificFilter(AdaptationFilter)

setSpecificFilter

public void setSpecificFilter(AdaptationFilter aFilter)

Specifies that the request result shall only include the adaptations which satisfy the filter passed as an argument.

If not set, this property is null: no specific filtering will be performed.

setXPathFilter

public void setXPathFilter(String predicate)

Specifies that the request result shall only include the occurrences which satisfy the predicate passed as an argument.

If a filter has been specified by means of method setSpecificFilter(AdaptationFilter), it is replaced by a filter that implements the predicate.

See Also:

XPath supported syntax. , AdaptationTable.selectOccurrences(String), setSpecificFilter(AdaptationFilter)

execute

public RequestResult execute()
                      throws IncompatibleChangeError

Executes the request and returns the result.

Throws:

IncompatibleChangeError