Interface EntityService

All Known Implementing Classes:
EntityServiceImpl

public interface EntityService
Entity service
Version:
$Id: $Id
Author:
querephi
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    changeEntityListStates(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, EntityListState state)
    changeEntityListStates.
    void
    copyFiles(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetNodeRef)
    copyFiles.
    org.alfresco.service.cmr.repository.NodeRef
    createDefaultImage(org.alfresco.service.cmr.repository.NodeRef nodeRef)
    createDefaultImage.
    org.alfresco.service.cmr.repository.NodeRef
    createOrCopyFrom(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName entityType, String entityName)
    createOrCopyFrom.
    void
    deleteDataLists(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean deleteArchivedNodes)
    deleteDataLists.
    void
    deleteFiles(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean deleteArchivedNodes)
    deleteFiles.
    getDefaultImageName(org.alfresco.service.namespace.QName entityTypeQName)
    getDefaultImageName.
    Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.NodeRef>>
    getDocumentsByType(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getDocumentsByType.
    org.alfresco.service.cmr.repository.NodeRef
    getDocumentsFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean create)
    getDocumentsFolder.
    org.alfresco.service.cmr.repository.NodeRef
    getEntityDefaultIcon(org.alfresco.service.cmr.repository.NodeRef nodeRef, String resolution)
    getEntityDefaultIcon.
    org.alfresco.service.cmr.repository.NodeRef
    getEntityDefaultImage(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getEntityDefaultImage.
    Map<String,org.alfresco.service.cmr.repository.NodeRef>
    getEntityIcons.
    org.alfresco.service.cmr.repository.NodeRef
    getEntityNodeRef(org.alfresco.service.cmr.repository.NodeRef childNodeRef, org.alfresco.service.namespace.QName itemType)
    getEntityNodeRef.
    byte[]
    getImage(org.alfresco.service.cmr.repository.NodeRef imgNodeRef)
    getImage.
    org.alfresco.service.cmr.repository.NodeRef
    getImage(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String imgName)
    getImage.
    org.alfresco.service.cmr.repository.NodeRef
    getImageFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getImageFolder.
    List<org.alfresco.service.cmr.repository.NodeRef>
    getImages(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getImages.
    org.alfresco.service.cmr.repository.NodeRef
    getOrCreateDocumentsFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getOrCreateDocumentsFolder.
    org.alfresco.service.cmr.repository.NodeRef
    getOrCreateImageFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)
    getOrCreateImageFolder.
    boolean
    hasAssociatedImages(org.alfresco.service.namespace.QName type)
    hasAssociatedImages.
    void
    moveFiles(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetNodeRef)
    moveFiles.
    void
    writeImages(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,byte[]> images)
    writeImages.
  • Method Details

    • getImage

      org.alfresco.service.cmr.repository.NodeRef getImage(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, String imgName)

      getImage.

      Parameters:
      entityNodeRef - a NodeRef object.
      imgName - a String object.
      Returns:
      a NodeRef object.
    • getImages

      List<org.alfresco.service.cmr.repository.NodeRef> getImages(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getImages.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a List object.
    • getEntityDefaultImage

      org.alfresco.service.cmr.repository.NodeRef getEntityDefaultImage(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getEntityDefaultImage.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a NodeRef object.
    • writeImages

      void writeImages(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, Map<String,byte[]> images)

      writeImages.

      Parameters:
      entityNodeRef - a NodeRef object.
      images - a Map object.
    • getImageFolder

      org.alfresco.service.cmr.repository.NodeRef getImageFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getImageFolder.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a NodeRef object.
    • getOrCreateImageFolder

      org.alfresco.service.cmr.repository.NodeRef getOrCreateImageFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getOrCreateImageFolder.

      Parameters:
      entityNodeRef - a NodeRef object
      Returns:
      a NodeRef object
    • getImage

      byte[] getImage(org.alfresco.service.cmr.repository.NodeRef imgNodeRef)

      getImage.

      Parameters:
      imgNodeRef - a NodeRef object.
      Returns:
      an array of byte objects.
    • getDefaultImageName

      String getDefaultImageName(org.alfresco.service.namespace.QName entityTypeQName)

      getDefaultImageName.

      Parameters:
      entityTypeQName - a QName object.
      Returns:
      a String object.
    • hasAssociatedImages

      boolean hasAssociatedImages(org.alfresco.service.namespace.QName type)

      hasAssociatedImages.

      Parameters:
      type - a QName object.
      Returns:
      a boolean.
    • createOrCopyFrom

      org.alfresco.service.cmr.repository.NodeRef createOrCopyFrom(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef parentNodeRef, org.alfresco.service.namespace.QName entityType, String entityName)

      createOrCopyFrom.

      Parameters:
      sourceNodeRef - a NodeRef object.
      parentNodeRef - a NodeRef object.
      entityType - a QName object.
      entityName - a String object.
      Returns:
      a NodeRef object.
    • copyFiles

      void copyFiles(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetNodeRef)

      copyFiles.

      Parameters:
      sourceNodeRef - a NodeRef object.
      targetNodeRef - a NodeRef object.
    • moveFiles

      void moveFiles(org.alfresco.service.cmr.repository.NodeRef sourceNodeRef, org.alfresco.service.cmr.repository.NodeRef targetNodeRef)

      moveFiles.

      Parameters:
      sourceNodeRef - a NodeRef object.
      targetNodeRef - a NodeRef object.
    • deleteFiles

      void deleteFiles(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean deleteArchivedNodes)

      deleteFiles.

      Parameters:
      entityNodeRef - a NodeRef object.
      deleteArchivedNodes - a boolean.
    • deleteDataLists

      void deleteDataLists(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean deleteArchivedNodes)

      deleteDataLists.

      Parameters:
      entityNodeRef - a NodeRef object.
      deleteArchivedNodes - a boolean.
    • getOrCreateDocumentsFolder

      org.alfresco.service.cmr.repository.NodeRef getOrCreateDocumentsFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getOrCreateDocumentsFolder.

      Parameters:
      entityNodeRef - a NodeRef object.
      Returns:
      a NodeRef object.
    • createDefaultImage

      org.alfresco.service.cmr.repository.NodeRef createDefaultImage(org.alfresco.service.cmr.repository.NodeRef nodeRef)

      createDefaultImage.

      Parameters:
      nodeRef - a NodeRef object.
      Returns:
      a NodeRef object.
    • getEntityNodeRef

      org.alfresco.service.cmr.repository.NodeRef getEntityNodeRef(org.alfresco.service.cmr.repository.NodeRef childNodeRef, org.alfresco.service.namespace.QName itemType)

      getEntityNodeRef.

      Parameters:
      childNodeRef - a NodeRef object.
      itemType - a QName object.
      Returns:
      a NodeRef object.
    • changeEntityListStates

      boolean changeEntityListStates(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, EntityListState state)

      changeEntityListStates.

      Parameters:
      entityNodeRef - a NodeRef object.
      state - a EntityListState object.
      Returns:
      a boolean.
    • getDocumentsFolder

      org.alfresco.service.cmr.repository.NodeRef getDocumentsFolder(org.alfresco.service.cmr.repository.NodeRef entityNodeRef, boolean create)

      getDocumentsFolder.

      Parameters:
      entityNodeRef - a NodeRef object.
      create - a boolean.
      Returns:
      a NodeRef object.
    • getEntityDefaultIcon

      org.alfresco.service.cmr.repository.NodeRef getEntityDefaultIcon(org.alfresco.service.cmr.repository.NodeRef nodeRef, String resolution)

      getEntityDefaultIcon.

      Parameters:
      nodeRef - a NodeRef object
      resolution - a String object
      Returns:
      a NodeRef object
    • getEntityIcons

      Map<String,org.alfresco.service.cmr.repository.NodeRef> getEntityIcons()

      getEntityIcons.

      Returns:
      a Map object
    • getDocumentsByType

      Map<org.alfresco.service.cmr.repository.NodeRef,List<org.alfresco.service.cmr.repository.NodeRef>> getDocumentsByType(org.alfresco.service.cmr.repository.NodeRef entityNodeRef)

      getDocumentsByType.

      Parameters:
      entityNodeRef - a NodeRef object
      Returns:
      a Map object