org.nuxeo.ecm.automation.core.operations.services

Class DocumentPageProviderOperation

java.lang.Object

org.nuxeo.ecm.automation.core.operations.services.DocumentPageProviderOperation

public class DocumentPageProviderOperation
extends Object

Operation to execute a query or a named provider with support for Pagination.

Since:

5.4.2

Author:

Tiry (tdelprat@nuxeo.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	ASC
protected OperationContext	context
static String	CURRENT_REPO_PATTERN
static String	CURRENT_USERID_PATTERN
protected Integer	currentPageIndex
static String	DESC
protected String	documentLinkBuilder
protected boolean	escapePatternParameters
static String	ID
protected String	lang
protected String	maxResults
protected Properties	namedParameters
protected Integer	page Deprecated.
protected Integer	pageSize
protected PageProviderService	ppService
protected String	providerName
protected String	query Deprecated. since 6.0 use instead .core.operations.services.query.DocumentQuery.
protected boolean	quotePatternParameters
protected CoreSession	session
protected String	sortBy
protected StringList	sortInfoAsStringList Deprecated. since 6.0 use instead and @link #sortOrder.
protected String	sortOrder
protected StringList	strParameters

Constructor Summary

Constructors

Constructor and Description
DocumentPageProviderOperation()

Method Summary

Modifier and Type	Method and Description
static DocumentModel	getSearchDocumentModel(CoreSession session, PageProviderService pps, String providerName, Properties namedParameters)
PaginableDocumentModelListImpl	run()

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

CURRENT_USERID_PATTERN

public static final String CURRENT_USERID_PATTERN

See Also:

Constant Field Values

CURRENT_REPO_PATTERN

public static final String CURRENT_REPO_PATTERN

See Also:

Constant Field Values

ASC

public static final String ASC

See Also:

Constant Field Values

DESC

public static final String DESC

See Also:

Constant Field Values

context

protected OperationContext context

session

protected CoreSession session

ppService

protected PageProviderService ppService

providerName

protected String providerName

query

@Deprecated
protected String query

Deprecated. since 6.0 use instead .core.operations.services.query.DocumentQuery.

lang

protected String lang

page

@Deprecated
protected Integer page

Deprecated.

currentPageIndex

protected Integer currentPageIndex

pageSize

protected Integer pageSize

sortInfoAsStringList

@Deprecated
protected StringList sortInfoAsStringList

Deprecated. since 6.0 use instead and @link #sortOrder.

strParameters

protected StringList strParameters

documentLinkBuilder

protected String documentLinkBuilder

maxResults

protected String maxResults

Since:

5.7

namedParameters

protected Properties namedParameters

Since:

6.0

sortBy

protected String sortBy

Since:

6.0

quotePatternParameters

protected boolean quotePatternParameters

Since:

7.10

escapePatternParameters

protected boolean escapePatternParameters

Since:

7.10

sortOrder

protected String sortOrder

Since:

6.0

Constructor Detail

DocumentPageProviderOperation

public DocumentPageProviderOperation()

Method Detail

run

public PaginableDocumentModelListImpl run()
                                   throws OperationException

Throws:

OperationException

getSearchDocumentModel

public static DocumentModel getSearchDocumentModel(CoreSession session,
                                                   PageProviderService pps,
                                                   String providerName,
                                                   Properties namedParameters)

Since:

7.1