Interface AssociationService

All Known Implementing Classes:
AssociationServiceImplV2

public interface AssociationService

AssociationService interface provides methods for managing associations between nodes in the repository.

This service handles both child and regular associations, with support for caching and filtering.

Version:
1.0
Author:
matthieu
  • Method Summary

    Modifier and Type
    Method
    Description
    org.alfresco.service.cmr.repository.NodeRef
    getChildAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Retrieves the child association for a given node with the specified association type.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getChildAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Retrieves the child associations for a given node with the specified association type.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getChildAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, org.alfresco.service.namespace.QName childTypeQName)
    Retrieves the child associations for a given node with the specified association type and child type.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getChildAssocs(org.alfresco.service.cmr.repository.NodeRef listNodeRef, org.alfresco.service.namespace.QName assocContains, org.alfresco.service.namespace.QName listQNameFilter, Map<String,Boolean> sortMap)
    Retrieves the child associations for a given list node with the specified association type and list type.
    getChildAssocsByType(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Retrieves the child associations by type for a given node with the specified association type.
    getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters)
    Retrieves entity source associations with filtering and pagination.
    getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters, org.alfresco.query.PagingRequest pagingRequest)
    Retrieves entity source associations with filtering, pagination, and permission checking.
    getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters, org.alfresco.query.PagingRequest pagingRequest, boolean checkPermissions)
    Retrieves entity source associations with filtering, pagination, and permission checking.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    Retrieves the source associations for a given node.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern)
    Retrieves the source associations for a given node with the specified association type.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern, Boolean includeVersions)
    Retrieves the source associations for a given node with the specified association type and versioning options.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern, Boolean includeVersions, Integer maxResults, Integer offset)
    Retrieves the source associations for a given node with the specified association type, versioning options, and pagination.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, Boolean includeVersions, Integer maxResults, Integer offset, boolean checkPermissions)
    Retrieves the source associations for a given node with the specified association type, versioning options, pagination, and permission checking.
    org.alfresco.service.cmr.repository.NodeRef
    getTargetAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Retrieves the target association for a given node with the specified association type.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getTargetAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Retrieves the target associations for a given node with the specified association type.
    void
    removeAllCacheAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    Removes all cached associations for a given node.
    void
    removeChildCachedAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
    Removes the child cached association for a given node with the specified association type.
    void
    update(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, List<org.alfresco.service.cmr.repository.NodeRef> assocNodeRefs)
    Updates the associations for a given node with the specified association type.
    void
    update(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, org.alfresco.service.cmr.repository.NodeRef assocNodeRef)
    Updates the associations for a given node with the specified association type.
  • Method Details

    • update

      void update(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, List<org.alfresco.service.cmr.repository.NodeRef> assocNodeRefs)
      Updates the associations for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to update associations for
      qName - the association type QName
      assocNodeRefs - the list of node references to associate with the node
    • update

      void update(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, org.alfresco.service.cmr.repository.NodeRef assocNodeRef)
      Updates the associations for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to update associations for
      qName - the association type QName
      assocNodeRef - the node reference to associate with the node
    • getTargetAssoc

      org.alfresco.service.cmr.repository.NodeRef getTargetAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Retrieves the target association for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the target association for
      qName - the association type QName
      Returns:
      the target association node reference
    • getTargetAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getTargetAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Retrieves the target associations for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the target associations for
      qName - the association type QName
      Returns:
      the list of target association node references
    • getChildAssoc

      org.alfresco.service.cmr.repository.NodeRef getChildAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Retrieves the child association for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the child association for
      qName - the association type QName
      Returns:
      the child association node reference
    • getChildAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getChildAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Retrieves the child associations for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the child associations for
      qName - the association type QName
      Returns:
      the list of child association node references
    • getChildAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getChildAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, org.alfresco.service.namespace.QName childTypeQName)
      Retrieves the child associations for a given node with the specified association type and child type.
      Parameters:
      nodeRef - the node reference to retrieve the child associations for
      qName - the association type QName
      childTypeQName - the child type QName
      Returns:
      the list of child association node references
    • getChildAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getChildAssocs(org.alfresco.service.cmr.repository.NodeRef listNodeRef, org.alfresco.service.namespace.QName assocContains, org.alfresco.service.namespace.QName listQNameFilter, @Nullable Map<String,Boolean> sortMap)
      Retrieves the child associations for a given list node with the specified association type and list type.
      Parameters:
      listNodeRef - the list node reference to retrieve the child associations for
      assocContains - the association type QName
      listQNameFilter - the list type QName filter
      sortMap - the sort map
      Returns:
      the list of child association node references
    • getSourcesAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Retrieves the source associations for a given node.
      Parameters:
      nodeRef - the node reference to retrieve the source associations for
      Returns:
      the list of source association node references
    • getSourcesAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern)
      Retrieves the source associations for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the source associations for
      qNamePattern - the association type QName pattern
      Returns:
      the list of source association node references
    • getSourcesAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern, Boolean includeVersions)
      Retrieves the source associations for a given node with the specified association type and versioning options.
      Parameters:
      nodeRef - the node reference to retrieve the source associations for
      qNamePattern - the association type QName pattern
      includeVersions - whether to include versioned associations
      Returns:
      the list of source association node references
    • getSourcesAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qNamePattern, Boolean includeVersions, Integer maxResults, Integer offset)
      Retrieves the source associations for a given node with the specified association type, versioning options, and pagination.
      Parameters:
      nodeRef - the node reference to retrieve the source associations for
      qNamePattern - the association type QName pattern
      includeVersions - whether to include versioned associations
      maxResults - the maximum number of results to return
      offset - the offset for pagination
      Returns:
      the list of source association node references
    • getSourcesAssocs

      List<org.alfresco.service.cmr.repository.NodeRef> getSourcesAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName, Boolean includeVersions, Integer maxResults, Integer offset, boolean checkPermissions)
      Retrieves the source associations for a given node with the specified association type, versioning options, pagination, and permission checking.
      Parameters:
      nodeRef - the node reference to retrieve the source associations for
      qName - the association type QName
      includeVersions - whether to include versioned associations
      maxResults - the maximum number of results to return
      offset - the offset for pagination
      checkPermissions - whether to check permissions
      Returns:
      the list of source association node references
    • getEntitySourceAssocs

      List<EntitySourceAssoc> getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters)
      Retrieves entity source associations with filtering and pagination.
      Parameters:
      nodeRefs - the node references to check
      assocQName - the association type QName
      listTypeQname - the list type QName
      isOrOperator - whether to use OR operator for filtering
      criteriaFilters - the criteria filters to apply
      Returns:
      the list of entity source associations
    • getEntitySourceAssocs

      List<EntitySourceAssoc> getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters, org.alfresco.query.PagingRequest pagingRequest)
      Retrieves entity source associations with filtering, pagination, and permission checking.
      Parameters:
      nodeRefs - the node references to check
      assocQName - the association type QName
      listTypeQname - the list type QName
      isOrOperator - whether to use OR operator for filtering
      criteriaFilters - the criteria filters to apply
      pagingRequest - the pagination request
      Returns:
      the list of entity source associations
    • getEntitySourceAssocs

      List<EntitySourceAssoc> getEntitySourceAssocs(List<org.alfresco.service.cmr.repository.NodeRef> nodeRefs, org.alfresco.service.namespace.QName assocQName, org.alfresco.service.namespace.QName listTypeQname, boolean isOrOperator, List<AssociationCriteriaFilter> criteriaFilters, org.alfresco.query.PagingRequest pagingRequest, boolean checkPermissions)
      Retrieves entity source associations with filtering, pagination, and permission checking.
      Parameters:
      nodeRefs - the node references to check
      assocQName - the association type QName
      listTypeQname - the list type QName
      isOrOperator - whether to use OR operator for filtering
      criteriaFilters - the criteria filters to apply
      pagingRequest - the pagination request
      checkPermissions - whether to check permissions
      Returns:
      the list of entity source associations
    • removeChildCachedAssoc

      void removeChildCachedAssoc(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Removes the child cached association for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to remove the child cached association for
      qName - the association type QName
    • removeAllCacheAssocs

      void removeAllCacheAssocs(org.alfresco.service.cmr.repository.NodeRef nodeRef)
      Removes all cached associations for a given node.
      Parameters:
      nodeRef - the node reference to remove all cached associations for
    • getChildAssocsByType

      ChildAssocCacheEntry getChildAssocsByType(org.alfresco.service.cmr.repository.NodeRef nodeRef, org.alfresco.service.namespace.QName qName)
      Retrieves the child associations by type for a given node with the specified association type.
      Parameters:
      nodeRef - the node reference to retrieve the child associations by type for
      qName - the association type QName
      Returns:
      the child association cache entry