com.sssw.fw.api
Interface EbiQuery

All Superinterfaces:

EbiQueryBase, Serializable

All Known Subinterfaces:

EbiAclMetaDataQuery, EbiAclQuery, EbiDocMetaDataQuery, EbiDocQuery, EbiFtsDocContentQuery, EbiFtsDocMetaDataQuery, EbiFullTextQuery, com.sssw.fw.persist.jdbc.api.EbiJdbcQuery, EbiMetaDataQuery, EbiUserMetaDataQuery, EbiUserQuery

public interface EbiQuery

extends EbiQueryBase, Serializable

This is a generic interface for defining queries for searching over various types of Portal Elements.

Method Summary

boolean	allSelected() Check to see if all properties are selected.
void	deselectAll() Deselect all properties.
Collection	getOrderBys() Enumerate the ORDER BY clauses defined on the query.
String	getQueryString() Get the sql String constructed from this query instance.
Collection	getSelects() Enumerate the selected properties
void	removeOrderBys() Remove all the ORDER BY clauses currently defined on the query.
void	selectAll() Select all properties (an equivalent of SQL's SELECT *)

Method Detail

selectAll

public void selectAll()

Select all properties (an equivalent of SQL's SELECT *)

deselectAll

public void deselectAll()

Deselect all properties. Note: implementations are expected to always have at least one default property selected, even if this method has been called, in order for the query to execute.

allSelected

public boolean allSelected()

Check to see if all properties are selected.

Returns:

true if all selected, false if not

getSelects

public Collection getSelects()

Enumerate the selected properties

Returns:

a Collection of String properties

getOrderBys

public Collection getOrderBys()

Enumerate the ORDER BY clauses defined on the query.

Returns:

a Collection of String ORDER BY clauses

removeOrderBys

public void removeOrderBys()

Remove all the ORDER BY clauses currently defined on the query.

getQueryString

public String getQueryString()

Get the sql String constructed from this query instance.

Returns:

the sql String.