org.opengroupware.jogi.ogo
Class FetchSpecification

java.lang.Object
  org.opengroupware.jogi.ogo.FetchSpecification

public class FetchSpecification

extends java.lang.Object

Holds the specifications of queries. The FetchSpecification qualifier is an SQL-like string that specifies what records to fetch. The optional ordering influences the order in which the results are returned.

Author:

Werner Schuster

Constructor Summary

FetchSpecification(java.lang.String qualifier)
Creates a FetchSpecification with the specified qualifier that uses the default sort ordering.

FetchSpecification(java.lang.String qualifier, java.lang.String order)
Creates a FetchSpecification with the specified qualifier.

Method Summary

java.lang.String	getQualifier()
java.util.List	getSortOrdering()
void	setQualifier(java.lang.String qualifier) This handles the qualifiers for the fetch request.
void	setSortOrdering(java.util.List order) Sets the sort order.

Methods inherited from class java.lang.Object

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

Constructor Detail

FetchSpecification

public FetchSpecification(java.lang.String qualifier)

Creates a FetchSpecification with the specified qualifier that uses the default sort ordering.

Parameters:

qualifier - the query expression for the FetchSpecification

FetchSpecification

public FetchSpecification(java.lang.String qualifier,
                          java.lang.String order)

Creates a FetchSpecification with the specified qualifier. The results will be sorted with the order field. This constructor should be used if only one sort order parameter is required.

Parameters:

qualifier - the query expression for the FetchSpecification

order - the name of one field to sort the results with.

Method Detail

setQualifier

public void setQualifier(java.lang.String qualifier)

This handles the qualifiers for the fetch request. Take a look at the OpenGroupware.org documentation for details about this.

Parameters:

qualifier -

getQualifier

public java.lang.String getQualifier()

setSortOrdering

public void setSortOrdering(java.util.List order)

Sets the sort order.

Parameters:

order - the names of the fields to order the result by; if the contained Objects are not of type String, their toString method is called;

getSortOrdering

public java.util.List getSortOrdering()