Class GetChildrenCannedQueryFactory

java.lang.Object
org.alfresco.query.AbstractCannedQueryFactory<NodeRef>
org.alfresco.repo.node.getchildren.GetChildrenCannedQueryFactory
All Implemented Interfaces:
org.alfresco.query.CannedQueryFactory<NodeRef>, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean
Direct Known Subclasses:
GetChildrenCannedQueryFactory

public class GetChildrenCannedQueryFactory extends org.alfresco.query.AbstractCannedQueryFactory<NodeRef>
GetChildren canned query factory - to get paged list of children of a parent node
Since:
4.0
Author:
janv
  • Field Details

  • Constructor Details

    • GetChildrenCannedQueryFactory

      public GetChildrenCannedQueryFactory()
  • Method Details

    • setDictionaryService

      public void setDictionaryService(DictionaryService dictionaryService)
    • setNodeDAO

      public void setNodeDAO(NodeDAO nodeDAO)
    • setQnameDAO

      public void setQnameDAO(QNameDAO qnameDAO)
    • setLocaleDAO

      public void setLocaleDAO(LocaleDAO localeDAO)
    • setContentDataDAO

      public void setContentDataDAO(ContentDataDAO contentDataDAO)
    • setCannedQueryDAO

      public void setCannedQueryDAO(CannedQueryDAO cannedQueryDAO)
    • setTenantService

      public void setTenantService(TenantService tenantService)
    • setNodeService

      public void setNodeService(NodeService nodeService)
    • setMethodSecurity

      public void setMethodSecurity(MethodSecurityBean<NodeRef> methodSecurity)
    • getCannedQuery

      public org.alfresco.query.CannedQuery<NodeRef> getCannedQuery(org.alfresco.query.CannedQueryParameters parameters)
    • getCannedQuery

      public org.alfresco.query.CannedQuery<NodeRef> getCannedQuery(NodeRef parentRef, String pattern, Set<QName> assocTypeQNames, Set<QName> childTypeQNames, List<FilterProp> filterProps, List<Pair<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 '*')
      assocTypeQNames - qnames of assocs to include (may be null)
      childTypeQNames - type qnames of children nodes (pre-filter)
      filterProps - filter properties
      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
    • getCannedQuery

      public org.alfresco.query.CannedQuery<NodeRef> getCannedQuery(NodeRef parentRef, String pattern, Set<QName> assocTypeQNames, Set<QName> childTypeQNames, Set<QName> inclusiveAspects, Set<QName> exclusiveAspects, List<FilterProp> filterProps, List<Pair<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 '*')
      assocTypeQNames - qnames of assocs to include (may be null)
      childTypeQNames - type qnames of children nodes (pre-filter)
      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.
      filterProps - filter properties
      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
    • getCannedQuery

      public org.alfresco.query.CannedQuery<NodeRef> getCannedQuery(NodeRef parentRef, String pattern, Set<QName> assocTypeQNames, Set<QName> childTypeQNames, org.alfresco.query.PagingRequest pagingRequest)
      Retrieve an unsorted instance of a CannedQuery based on parameters including request for a total count (up to a given max)
      Parameters:
      parentRef - parent node ref
      pattern - the pattern to use to filter children (wildcard character is '*')
      assocTypeQNames - qnames of assocs to include (may be null)
      childTypeQNames - type qnames of children nodes
      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<NodeRef>
      Throws:
      Exception