org.alfresco.repo.node.getchildren

Class GetChildrenCannedQuery

java.lang.Object

org.alfresco.query.AbstractCannedQuery<R>

org.alfresco.repo.security.permissions.impl.acegi.AbstractCannedQueryPermissions<NodeRef>

org.alfresco.repo.node.getchildren.GetChildrenCannedQuery

All Implemented Interfaces:

CannedQuery<NodeRef>

Direct Known Subclasses:

GetChildrenCannedQuery

public class GetChildrenCannedQuery
extends AbstractCannedQueryPermissions<NodeRef>

GetChildren canned query To get paged list of children of a parent node filtered by child type. Also optionally filtered and/or sorted by one or more properties (up to three).

Since:

4.0

Author:

janv

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	GetChildrenCannedQuery.DefaultFilterSortChildQueryCallback
protected class	GetChildrenCannedQuery.DefaultUnsortedChildQueryCallback
protected static interface	GetChildrenCannedQuery.FilterSortChildQueryCallback
protected class	GetChildrenCannedQuery.FilterSortNode
protected class	GetChildrenCannedQuery.FilterSortResultHandler
protected static interface	GetChildrenCannedQuery.UnsortedChildQueryCallback

Field Summary

Fields

Modifier and Type	Field and Description
static QName	FILTER_QNAME_NODE_IS_PRIMARY
static int	MAX_FILTER_SORT_PROPS
protected NodeService	nodeService
static QName	SORT_QNAME_CONTENT_MIMETYPE
static QName	SORT_QNAME_CONTENT_SIZE
static QName	SORT_QNAME_NODE_IS_FOLDER
static QName	SORT_QNAME_NODE_TYPE

Constructor Summary

Constructors

Constructor and Description
GetChildrenCannedQuery(NodeDAO nodeDAO, QNameDAO qnameDAO, CannedQueryDAO cannedQueryDAO, NodePropertyHelper nodePropertyHelper, TenantService tenantService, NodeService nodeService, MethodSecurityBean<NodeRef> methodSecurity, CannedQueryParameters params)

Method Summary

Modifier and Type	Method and Description
protected List<NodeRef>	applyPostQueryPermissions(List<NodeRef> results, int requestedCount)
protected GetChildrenCannedQuery.FilterSortChildQueryCallback	getFilterSortChildQuery(List<GetChildrenCannedQuery.FilterSortNode> children, List<FilterProp> filterProps, GetChildrenCannedQueryParams paramBean)
protected GetChildrenCannedQuery.UnsortedChildQueryCallback	getUnsortedChildQueryCallback(List<NodeRef> rawResult, int requestedCount, GetChildrenCannedQueryParams paramBean)
protected boolean	isApplyPostQueryPermissions() By default, the is a permission checking class.
protected boolean	isApplyPostQuerySorting()
protected List<NodeRef>	queryAndFilter(CannedQueryParameters parameters)

Methods inherited from class org.alfresco.repo.security.permissions.impl.acegi.AbstractCannedQueryPermissions

getTotalResultCount

Methods inherited from class org.alfresco.query.AbstractCannedQuery

applyPostQueryPaging, applyPostQuerySorting, execute, getParameters, isApplyPostQueryPaging, toString

Methods inherited from class java.lang.Object

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

Field Detail

MAX_FILTER_SORT_PROPS

public static final int MAX_FILTER_SORT_PROPS

See Also:

Constant Field Values

SORT_QNAME_CONTENT_SIZE

public static final QName SORT_QNAME_CONTENT_SIZE

SORT_QNAME_CONTENT_MIMETYPE

public static final QName SORT_QNAME_CONTENT_MIMETYPE

SORT_QNAME_NODE_TYPE

public static final QName SORT_QNAME_NODE_TYPE

SORT_QNAME_NODE_IS_FOLDER

public static final QName SORT_QNAME_NODE_IS_FOLDER

FILTER_QNAME_NODE_IS_PRIMARY

public static final QName FILTER_QNAME_NODE_IS_PRIMARY

nodeService

protected NodeService nodeService

Constructor Detail

GetChildrenCannedQuery

public GetChildrenCannedQuery(NodeDAO nodeDAO,
                              QNameDAO qnameDAO,
                              CannedQueryDAO cannedQueryDAO,
                              NodePropertyHelper nodePropertyHelper,
                              TenantService tenantService,
                              NodeService nodeService,
                              MethodSecurityBean<NodeRef> methodSecurity,
                              CannedQueryParameters params)

Method Detail

getFilterSortChildQuery

protected GetChildrenCannedQuery.FilterSortChildQueryCallback getFilterSortChildQuery(List<GetChildrenCannedQuery.FilterSortNode> children,
                                                                                      List<FilterProp> filterProps,
                                                                                      GetChildrenCannedQueryParams paramBean)

getUnsortedChildQueryCallback

protected GetChildrenCannedQuery.UnsortedChildQueryCallback getUnsortedChildQueryCallback(List<NodeRef> rawResult,
                                                                                          int requestedCount,
                                                                                          GetChildrenCannedQueryParams paramBean)

queryAndFilter

protected List<NodeRef> queryAndFilter(CannedQueryParameters parameters)

Specified by:

queryAndFilter in class AbstractCannedQuery<NodeRef>

isApplyPostQuerySorting

protected boolean isApplyPostQuerySorting()

Overrides:

isApplyPostQuerySorting in class AbstractCannedQuery<NodeRef>

isApplyPostQueryPermissions

protected boolean isApplyPostQueryPermissions()

Description copied from class: AbstractCannedQueryPermissions

By default, the is a permission checking class. Override the method if you wish to switch the behaviour at runtime.

Overrides:

isApplyPostQueryPermissions in class AbstractCannedQueryPermissions<NodeRef>

Returns:

true always

applyPostQueryPermissions

protected List<NodeRef> applyPostQueryPermissions(List<NodeRef> results,
                                                  int requestedCount)

Overrides:

applyPostQueryPermissions in class AbstractCannedQueryPermissions<NodeRef>