Package se.conciliate.extensions.documents

Interface DocumentSource.DocumentKind

Enclosing interface:
DocumentSource
public static interface DocumentSource.DocumentKind
A document kind is used to differentiate between documents from a source that need different meta data types. For example a template might require different meta data types than the documents created from the template. Technically, this can also be used to let users create, say, a pdf-document or a word-document (if those two for some reason require different sets of meta data to describe).

  • Method Summary

    Modifier and Type
    Method
    Description
    URL
    getIcon()
    Returns a 24x24 icon for this kind.
    String
    getId()
    Returns the id of this kind.
    String
    getTitle()
    Returns a user presentable title for this kind.

  • Method Details

    • getId

      String getId()
      Returns the id of this kind. The id will be sent to DocumentSource.Creator.create(String) where the create method will use the id to populate a document with meta data needed for this document kind.
      Returns:
      The id of this kind, for example "org.acme.documentSource.template".

    • getTitle

      String getTitle()
      Returns a user presentable title for this kind. The title will be displayed to users to let them choose between which kind to create when creating a new document from the document source.
      Returns:
      A user presentable title for this kind, for example "ACME Templates".

    • getIcon

      URL getIcon()
      Returns a 24x24 icon for this kind.
      Returns:
      An icon.