Package se.conciliate.extensions.documentservice

Interface Document

@Deprecated public interface Document
Deprecated.
A document is a unique, named link with a creation date and an icon. The link might however be human readable only, such as "Shelf 'A' in London Library".
Author:
Per-Erik

  • Method Summary

    Modifier and Type
    Method
    Description
    Date
    getCreated()
    Deprecated.
    Returns when the document was most recently validated/changed or when the document was created.
    Icon
    getIcon()
    Deprecated.
    Returns an icon for this document.
    URI
    getLocation()
    Deprecated.
    This method should NOT be expected to always give a web adresses.
    String
    getName()
    Deprecated.
    Returns the name of the document.
    UUID
    getUniqueID()
    Deprecated.
    This method returns a unique id as a UUID.
    boolean
    isNew()
    Deprecated.
    Returns true if this document is new in some arbitrary, by the implementation decided way.

  • Method Details

    • getName

      String getName() throws DocumentServiceException
      Deprecated.
      Returns the name of the document.

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

    • getUniqueID

      UUID getUniqueID() throws DocumentServiceException
      Deprecated.
      This method returns a unique id as a UUID. The id, however need not be universally unique as long as it is unique in the domain of the document service. The id returned is used for persistance and later to read in the data associated with this id from the service.
      Returns:
      a unique id as a UUID. The id must be unique for the document service but may or may not be universally unique.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getCreated

      Date getCreated() throws DocumentServiceException
      Deprecated.
      Returns when the document was most recently validated/changed or when the document was created.
      Returns:
      a date when the document was created
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getLocation

      URI getLocation() throws DocumentServiceException
      Deprecated.
      This method should NOT be expected to always give a web adresses. It could be a URI that is only understandable by humans such as 'In library'.
      Returns:
      A URI describing how to get this document, not allways computer readable.
      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 for this document. Notice that you may return different icons for different types of documents.

      Note: May be called from event dispatch thread.
      Returns:
      an icon to be displayed next to the name of this document when the document name needs to be rendered in some way.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • isNew

      boolean isNew() throws DocumentServiceException
      Deprecated.
      Returns true if this document is new in some arbitrary, by the implementation decided way.
      Returns:
      true if this document is new in some arbitrary, by the implementation decided way.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.