com.tsgrp.opencontent.core.query

Interface IQuery

All Known Implementing Classes:

AbstractAlfrescoEmbQueryImpl, AbstractLuceneQueryImpl, AlfrescoEmbQueryImpl, DCTMQueryImpl, ElasticsearchDynamoQueryImpl, ElasticsearchSchemalessQueryImpl, SolrDynamoQueryImpl, SolrHBaseQueryImpl, SolrSchemalessQueryImpl

public interface IQuery

Interface methods for executing queries.

Method Summary

Modifier and Type	Method and Description
QueryResult	enhancedExecuteQuery(java.lang.String ticket, EnhancedQueryCriteriaBean query) Executes an enhanced execute query.
java.util.List<java.util.List<java.lang.Object>>	enhancedPassthroughReadQuery(java.lang.String ticket, java.lang.String query) Run and execute a database query against the given implementation.
QueryResult	enhancedReadQuery(java.lang.String ticket, EnhancedQueryCriteriaBean query) Executes an enhanced read query.
void	executeQuery(java.lang.String ticket, OCQuery query) findTotalRecords computes the number of total results and calculates the number of pages executeQuery supports pagination via the specified page number (1-based) Limited to page size unless pagesize is -1
java.util.Map<java.lang.String,java.lang.Object>	findTotalRecords(java.lang.String ticket, OCQuery query) Executes an OCQuery and returns the total number of results found for pagination
int	passthroughExecuteQuery(java.lang.String ticket, java.lang.String query) Run an execute a database query.
StringArray[]	passthroughReadQuery(java.lang.String ticket, java.lang.String query) Run an execute a database query, returning a table of results.
OCQuery	processResults(java.lang.String ticket, OCQuery query) Hotspot function for client overrides of OCQuery results

Method Detail

passthroughReadQuery

StringArray[] passthroughReadQuery(java.lang.String ticket,
                                   java.lang.String query)

Run an execute a database query, returning a table of results. Each row will be a StringArray object containing the rows contents as an array of String objects. The query must be a read-only query and cannot modify the repository.

Parameters:

ticket - an authentication ticket

query - the DQL query to execute, which must return a single int

Returns:

the results of query execution, or null on failure

enhancedPassthroughReadQuery

java.util.List<java.util.List<java.lang.Object>> enhancedPassthroughReadQuery(java.lang.String ticket,
                                                                              java.lang.String query)

Run and execute a database query against the given implementation. Returns a List of Lists representing each "row" of results. Does NOT provide the headers for the given query.

Parameters:

ticket - an authentication ticket

query - the given query to run

Returns:

the results of query execution

passthroughExecuteQuery

int passthroughExecuteQuery(java.lang.String ticket,
                            java.lang.String query)

Run an execute a database query. This method will attempt to run the passed in query, and return the integer return value from the query. If there is an error, the return value will be -1.

Parameters:

ticket - an authentication ticket

query - the DQL query to execute, which must return a single int

Returns:

the integer return value from the query, or -1 on failure

enhancedReadQuery

QueryResult enhancedReadQuery(java.lang.String ticket,
                              EnhancedQueryCriteriaBean query)

Executes an enhanced read query.

Parameters:

ticket - an authentication ticket

query - a QueryCriteriaBean populated with query criteria

Returns:

• QueryResult
• error returns true if method failed, otherwise false
• results contains an array of QueryResultRows returned by query

enhancedExecuteQuery

QueryResult enhancedExecuteQuery(java.lang.String ticket,
                                 EnhancedQueryCriteriaBean query)

Executes an enhanced execute query.

Parameters:

ticket - an authentication ticket

query - a QueryCriteriaBean populated with query criteria

Returns:

• QueryResult
• error returns true if method failed, otherwise false

executeQuery

void executeQuery(java.lang.String ticket,
                  OCQuery query)

findTotalRecords computes the number of total results and calculates the number of pages executeQuery supports pagination via the specified page number (1-based) Limited to page size unless pagesize is -1

Parameters:

ticket -

query -

See Also:

executeQuery(java.lang.String, com.tsgrp.opencontent.core.query.model.OCQuery)

findTotalRecords

java.util.Map<java.lang.String,java.lang.Object> findTotalRecords(java.lang.String ticket,
                                                                  OCQuery query)

Executes an OCQuery and returns the total number of results found for pagination

Parameters:

ticket -

query -

Returns:

a OCQuery state that includes the total records found and total pages

processResults

OCQuery processResults(java.lang.String ticket,
                       OCQuery query)

Hotspot function for client overrides of OCQuery results

Parameters:

ticket - valid OC ticket

query - results on which IQuery.executeQuery has already been called. No-op if no results found

Returns:

manipulated results without mutating the passed in OCQuery