Package se.conciliate.extensions.documentservice

Interface DocumentService

@Deprecated public interface DocumentService
Deprecated.
This class is the base of a document service plugin. Through it, document hierarchies are created and a name and icon is retrieved to help the user distinguish between different document services.
Author:
Per-Erik

  • Method Summary

    Modifier and Type
    Method
    Description
    DocumentHierarchy
    createHierarchy()
    Deprecated.
    Creates a new DocumentHierarchy from this DocumentServices source.
    DocumentHierarchy
    createHierarchy(UUID uuid)
    Deprecated.
    Returns a new DocumentHierarchy with the root set to the DocumentHierarchy with UUID equal to uuid.
    Map<String,byte[]>
    getHTMLIcons()
    Deprecated.
    Returns icons needed by the supplied JavaScript files.
    Icon
    getIcon()
    Deprecated.
    Use #getIcon(int) instead.
    default Icon
    getIcon(int preferredSize)
    Deprecated.
    Returns an icon that represents this service.
    Map<String,String>
    getJavaScriptFiles()
    Deprecated.
    Returns the JavaScript needed by the service when publishing documents to HTML.
    String
    getServiceName()
    Deprecated.
    Returns a displayable and unique name for this service.

  • Method Details

    • createHierarchy

      DocumentHierarchy createHierarchy() throws DocumentServiceException
      Deprecated.
      Creates a new DocumentHierarchy from this DocumentServices source. The root of the returned DocumentHierarchy is the root of this services source. Hence, this call is equal to createHierarchy(rootUUID).
      Returns:
      a new DocumentHierarchy from this DocumentServices source
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • createHierarchy

      DocumentHierarchy createHierarchy(UUID uuid) throws DocumentServiceException
      Deprecated.
      Returns a new DocumentHierarchy with the root set to the DocumentHierarchy with UUID equal to uuid.
      Parameters:
      uuid - The return value from some hierarchys getPersistableID(). This means that the uuid may not be universally unique.
      Returns:
      a new DocumentHierarchy with the root set to the DocumentHierarchy with UUID equal to uuid.
      Throws:
      DocumentServiceException - if the service provider cannot reach its service host or a communication error occurs.

    • getServiceName

      String getServiceName()
      Deprecated.
      Returns a displayable and unique name for this service.

      Note: May be called from event dispatch thread.
      Returns:
      a displayable and unique name for this service.

    • getIcon

      Icon getIcon()
      Deprecated.
      Use #getIcon(int) instead.
      Returns a displayable icon that is shown with this service.

      Note: May be called from event dispatch thread.
      Returns:
      a displayable icon that is shown with this service.

    • getIcon

      default Icon getIcon(int preferredSize)
      Deprecated.
      Returns an icon that represents this service. The returned icon may be any size but may be rescaled to the given preferred size if not provided in that size.
      Parameters:
      preferredSize - The preferred size of the icon. The returned icon may be scaled to this width and height unless it is already in this width and height.
      Returns:
      An icon that will look best if its dimension is preferredSize*preferredSize and may otherwise be scaled to such a dimension.

    • getJavaScriptFiles

      Map<String,String> getJavaScriptFiles()
      Deprecated.
      Returns the JavaScript needed by the service when publishing documents to HTML.
      Returns:
      A map where the keys are the names of the JavaScript files and the values are the content.

    • getHTMLIcons

      Map<String,byte[]> getHTMLIcons()
      Deprecated.
      Returns icons needed by the supplied JavaScript files. These icons will be included in the published HTML at the path: "pages/images/extension-document-icons/"
      Returns:
      A map with icon names as keys and icon data as values.