Package se.conciliate.extensions.documentservice

Interface DocumentHierarchy

@Deprecated public interface DocumentHierarchy
Deprecated.
A hierarchy is the abstract concept of folders. Folders are however only applicable in file systems. When working with document management systems, they will often have another implementation behind their "folders". This is the interface that all document management systems must have to be able to organize documents. As an example of a DMS that do not use folders, see Centuri and their concept of Unit, or in Swedish "kopplingspunkt".
Author:
Per-Erik

  • Method Summary

    Modifier and Type
    Method
    Description
    Document
    find(UUID searchCriteria)
    Deprecated.
    Finds a certain document in this hierarchy.
    Collection<DocumentHierarchy>
    getChildHierarchies()
    Deprecated.
    Returns all child hierarhies.
    Collection<Document>
    getDocuments()
    Deprecated.
    Returns all documents directly contained in this hierarchy.
    Icon
    getIcon()
    Deprecated.
    Returns an icon that corresponds to this hierarchy.
    URI
    getLocation()
    Deprecated.
    Returns a URI describing how to get to this hierarchy.
    String
    getName()
    Deprecated.
    Returns the name (should be displayable) of this hierarchy.
    UUID
    getPersistableID()
    Deprecated.
    Returns a UUID that can be used to persist this hierarchy toghether with other hierarchies that might have the same name.
    DocumentHierarchy
    getRoot()
    Deprecated.
    Returns the root of this hierarchy or 'this' if this is the root.
    boolean
    hasChildHierarchies()
    Deprecated.
    Returns true if this hierarchy has child hierarchies, false otherwise.
    boolean
    hasDocuments()
    Deprecated.
    Returns true if this hierarchy has documents directly contained in it, false otherwise.
    boolean
    isRoot()
    Deprecated.
    Returns true if this is the root of the hierarchy.

  • Method Details

    • getDocuments

      Collection<Document> getDocuments() throws DocumentServiceException
      Deprecated.
      Returns all documents directly contained in this hierarchy.
      Returns:
      All documents in this hierarchy. Does not include documents from child hierarchies.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • find

      Document find(UUID searchCriteria) throws DocumentServiceException
      Deprecated.
      Finds a certain document in this hierarchy. The search continues to all child hierarchies if not found in this hierarchy.
      Parameters:
      searchCriteria - A UUID that enables this hierarchy to find the document.
      Returns:
      A specific document contained directly in this hierarchy or in any child hierarchies or their children. For ever and ever. If the document cannot be found, null is returned.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getChildHierarchies

      Collection<DocumentHierarchy> getChildHierarchies() throws DocumentServiceException
      Deprecated.
      Returns all child hierarhies.
      Returns:
      A collection containing all child hierarchies to this hierarchy.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getRoot

      DocumentHierarchy getRoot() throws DocumentServiceException
      Deprecated.
      Returns the root of this hierarchy or 'this' if this is the root.
      Returns:
      This hierarchies root hierarchy. If this hierarchy is the root, returns 'this'.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getName

      String getName() throws DocumentServiceException
      Deprecated.
      Returns the name (should be displayable) of this hierarchy. This would correspond to the name of a folder in a filesystem.

      Note: May be called from event dispatch thread.
      Returns:
      The name of this hierarchy.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getPersistableID

      UUID getPersistableID() throws DocumentServiceException
      Deprecated.
      Returns a UUID that can be used to persist this hierarchy toghether with other hierarchies that might have the same name.
      Returns:
      A UUID used to persist this hierarchy. The UUID need not be universally unique as long as it is unique to the source of the hierarchy.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • hasChildHierarchies

      boolean hasChildHierarchies() throws DocumentServiceException
      Deprecated.
      Returns true if this hierarchy has child hierarchies, false otherwise. True would correspond to a folder containing subfolders in a filesystem.
      Returns:
      True if this hierarchy has child hierarchies, false otherwise.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • hasDocuments

      boolean hasDocuments() throws DocumentServiceException
      Deprecated.
      Returns true if this hierarchy has documents directly contained in it, false otherwise. False would thus correspond to a folder that does only contain other folders, no documents. The subfolder might of course contain documents but this method would return false anyway, since this very folder does not (directly) contain documents.
      Returns:
      True if this hierarchy has documents directly contained in it (does not include children). If this method returns true, a non-empty collection will be returned from getDocuments().
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • isRoot

      boolean isRoot() throws DocumentServiceException
      Deprecated.
      Returns true if this is the root of the hierarchy.
      Returns:
      True if this hierarchy is the root, false otherwise.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getIcon

      Icon getIcon() throws DocumentServiceException
      Deprecated.
      Returns an icon that corresponds to this hierarchy. For example a folder- icon. Can also return null in wich case a default icon will be chosen. Notice that you can return different icons for different types of hierarchies.

      Note: May be called from event dispatch thread.
      Returns:
      an icon or null.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getLocation

      URI getLocation() throws DocumentServiceException
      Deprecated.
      Returns a URI describing how to get to this hierarchy.
      Returns:
      a URI describing how to get to this hierarchy.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.