org.alfresco.repo.webservice

Interface ServerQuery

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

AbstractQuery, AssociationQuery, ChildAssociationQuery, ParentAssociationQuery, SearchQuery, UserQuery

public interface ServerQuery
extends java.io.Serializable

Interface definition for a QuerySession.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SYS_COL_ASSOC_NAME
static java.lang.String	SYS_COL_ASSOC_TYPE System column namess
static java.lang.String	SYS_COL_IS_PRIMARY
static java.lang.String	SYS_COL_NTH_SIBLING

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	execute(org.alfresco.service.ServiceRegistry serviceRegistry) Executes the query and returns the full query results.
java.lang.Object	execute(org.alfresco.service.ServiceRegistry serviceRegistry, long maxResults) Executes the query and return all results up to given maximum number.

Field Detail

SYS_COL_ASSOC_TYPE

static final java.lang.String SYS_COL_ASSOC_TYPE

System column namess

See Also:

Constant Field Values

SYS_COL_ASSOC_NAME

static final java.lang.String SYS_COL_ASSOC_NAME

See Also:

Constant Field Values

SYS_COL_IS_PRIMARY

static final java.lang.String SYS_COL_IS_PRIMARY

See Also:

Constant Field Values

SYS_COL_NTH_SIBLING

static final java.lang.String SYS_COL_NTH_SIBLING

See Also:

Constant Field Values

Method Detail

execute

java.lang.Object execute(org.alfresco.service.ServiceRegistry serviceRegistry)

Executes the query and returns the full query results.

Parameters:

The - services to help make the query

Returns:

The full set of query results. The results must be empty if there are no results.

execute

java.lang.Object execute(org.alfresco.service.ServiceRegistry serviceRegistry,
                       long maxResults)

Executes the query and return all results up to given maximum number. Note that this is not the same as the page size, but rather is a total upper limit to the number of results that can viewed.

Parameters:

The - services to help make the query

maxResults - the total number of results to retrieve

Returns:

The full set of query results up to the maximum given. The results must be empty if there are no results.