Package org.alfresco.repo.node.getchildren

Class GetChildrenCannedQueryFactory

  • 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
    Direct Known Subclasses:
    GetChildrenCannedQueryFactory
    public class GetChildrenCannedQueryFactory
extends org.alfresco.query.AbstractCannedQueryFactory<org.alfresco.service.cmr.repository.NodeRef>
    GetChildren canned query factory - to get paged list of children of a parent node
    Since:
    4.0
    Author:
    janv

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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, java.lang.String pattern, java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames, java.util.Set<org.alfresco.service.namespace.QName> childTypeQNames, java.util.List<FilterProp> filterProps, java.util.List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,​java.lang.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.
      org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery​(org.alfresco.service.cmr.repository.NodeRef parentRef, java.lang.String pattern, java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames, java.util.Set<org.alfresco.service.namespace.QName> childTypeQNames, java.util.Set<org.alfresco.service.namespace.QName> inclusiveAspects, java.util.Set<org.alfresco.service.namespace.QName> exclusiveAspects, java.util.List<FilterProp> filterProps, java.util.List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,​java.lang.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.
      org.alfresco.query.CannedQuery<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery​(org.alfresco.service.cmr.repository.NodeRef parentRef, java.lang.String pattern, java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames, java.util.Set<org.alfresco.service.namespace.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)
      void setCannedQueryDAO​(CannedQueryDAO cannedQueryDAO)  
      void setContentDataDAO​(ContentDataDAO contentDataDAO)  
      void setDictionaryService​(org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService)  
      void setLocaleDAO​(LocaleDAO localeDAO)  
      void setMethodSecurity​(MethodSecurityBean<org.alfresco.service.cmr.repository.NodeRef> methodSecurity)  
      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

      • dictionaryService

        protected org.alfresco.service.cmr.dictionary.DictionaryService dictionaryService

      • nodeDAO

        protected NodeDAO nodeDAO

      • tenantService

        protected org.alfresco.repo.tenant.TenantService tenantService

      • nodeService

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

      • methodSecurity

        protected MethodSecurityBean<org.alfresco.service.cmr.repository.NodeRef> methodSecurity

    • Constructor Detail

      • GetChildrenCannedQueryFactory

        public GetChildrenCannedQueryFactory()

    • Method Detail

      • setDictionaryService

        public void setDictionaryService​(org.alfresco.service.cmr.dictionary.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​(org.alfresco.repo.tenant.TenantService tenantService)

      • setNodeService

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

      • setMethodSecurity

        public void setMethodSecurity​(MethodSecurityBean<org.alfresco.service.cmr.repository.NodeRef> methodSecurity)

      • 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,
                                                                                                  java.lang.String pattern,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> childTypeQNames,
                                                                                                  java.util.List<FilterProp> filterProps,
                                                                                                  java.util.List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,​java.lang.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<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery​(org.alfresco.service.cmr.repository.NodeRef parentRef,
                                                                                                  java.lang.String pattern,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> childTypeQNames,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> inclusiveAspects,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> exclusiveAspects,
                                                                                                  java.util.List<FilterProp> filterProps,
                                                                                                  java.util.List<org.alfresco.util.Pair<org.alfresco.service.namespace.QName,​java.lang.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<org.alfresco.service.cmr.repository.NodeRef> getCannedQuery​(org.alfresco.service.cmr.repository.NodeRef parentRef,
                                                                                                  java.lang.String pattern,
                                                                                                  java.util.Set<org.alfresco.service.namespace.QName> assocTypeQNames,
                                                                                                  java.util.Set<org.alfresco.service.namespace.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 java.lang.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:
        java.lang.Exception