org.alfresco.repo.security.person

Class GetPeopleCannedQueryFactory

java.lang.Object

org.alfresco.query.AbstractCannedQueryFactory<org.alfresco.service.cmr.repository.NodeRef>

org.alfresco.repo.security.person.GetPeopleCannedQueryFactory

All Implemented Interfaces:

org.alfresco.query.CannedQueryFactory<org.alfresco.service.cmr.repository.NodeRef>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class GetPeopleCannedQueryFactory
extends org.alfresco.query.AbstractCannedQueryFactory<org.alfresco.service.cmr.repository.NodeRef>

GetPeople canned query factory - to get paged list of people

Since:

4.1.2

Author:

janv

Field Summary

Fields

Modifier and Type	Field and Description
protected AuthorityService	authorityService
protected CannedQueryDAO	cannedQueryDAO
protected NodeDAO	nodeDAO
protected org.alfresco.service.cmr.repository.NodeService	nodeService
protected QNameDAO	qnameDAO
protected org.alfresco.repo.tenant.TenantService	tenantService

Constructor Summary

Constructors

Constructor and Description
GetPeopleCannedQueryFactory()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef>	getCannedQuery(org.alfresco.query.CannedQueryParameters parameters)
org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef>	getCannedQuery(org.alfresco.service.cmr.repository.NodeRef parentRef, String pattern, List<org.alfresco.service.namespace.QName> filterProps, Set<org.alfresco.service.namespace.QName> inclusiveAspects, Set<org.alfresco.service.namespace.QName> exclusiveAspects, boolean includeAdministrators, List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps, org.alfresco.query.PagingRequest pagingRequest) Retrieve an optionally filtered/sorted instance of a CannedQuery based on parameters including request for a total count (up to a given max) Note: if both filtering and sorting is required then the combined total of unique QName properties should be the 0 to 3.
void	setAuthorityService(AuthorityService authorityService)
void	setCannedQueryDAO(CannedQueryDAO cannedQueryDAO)
void	setNodeDAO(NodeDAO nodeDAO)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setQnameDAO(QNameDAO qnameDAO)
void	setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

Methods inherited from class org.alfresco.query.AbstractCannedQueryFactory

getCannedQuery, getQueryExecutionId, setBeanName, setRegistry

Methods inherited from class java.lang.Object

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

Field Detail

nodeDAO

protected NodeDAO nodeDAO

qnameDAO

protected QNameDAO qnameDAO

cannedQueryDAO

protected CannedQueryDAO cannedQueryDAO

tenantService

protected org.alfresco.repo.tenant.TenantService tenantService

nodeService

protected org.alfresco.service.cmr.repository.NodeService nodeService

authorityService

protected AuthorityService authorityService

Constructor Detail

GetPeopleCannedQueryFactory

public GetPeopleCannedQueryFactory()

Method Detail

setNodeDAO

public void setNodeDAO(NodeDAO nodeDAO)

setQnameDAO

public void setQnameDAO(QNameDAO qnameDAO)

setCannedQueryDAO

public void setCannedQueryDAO(CannedQueryDAO cannedQueryDAO)

setTenantService

public void setTenantService(org.alfresco.repo.tenant.TenantService tenantService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

getCannedQuery

public org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery(org.alfresco.query.CannedQueryParameters parameters)

getCannedQuery

public org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery(org.alfresco.service.cmr.repository.NodeRef parentRef,
                                                                                                  String pattern,
                                                                                                  List<org.alfresco.service.namespace.QName> filterProps,
                                                                                                  Set<org.alfresco.service.namespace.QName> inclusiveAspects,
                                                                                                  Set<org.alfresco.service.namespace.QName> exclusiveAspects,
                                                                                                  boolean includeAdministrators,
                                                                                                  List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,Boolean>> sortProps,
                                                                                                  org.alfresco.query.PagingRequest pagingRequest)

Retrieve an optionally filtered/sorted instance of a CannedQuery based on parameters including request for a total count (up to a given max) Note: if both filtering and sorting is required then the combined total of unique QName properties should be the 0 to 3.

Parameters:

parentRef - parent node ref

pattern - the pattern to use to filter children (wildcard character is '*')

filterProps - filter props

inclusiveAspects - If not null, only child nodes with any aspect in this collection will be included in the results.

exclusiveAspects - If not null, any child nodes with any aspect in this collection will be excluded in the results.

includeAdministrators - include administrators in the returned results

sortProps - sort property pairs (QName and Boolean - true if ascending)

pagingRequest - skipCount, maxItems - optionally queryExecutionId and requestTotalCountMax

Returns:

an implementation that will execute the query

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Overrides:

afterPropertiesSet in class org.alfresco.query.AbstractCannedQueryFactory<org.alfresco.service.cmr.repository.NodeRef>

Throws:

Exception