Package se.conciliate.extensions.store

Interface MTExtensionDocument

public interface MTExtensionDocument
An extension document is a document defined by a plugin. The behaviour of the document in the program and in HTML is defined by the plugin.
Since:
3.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    connectTo(MTModelHeader model)
    Connects this document to the specified model.
    void
    connectTo(MTSymbolHeader symbol)
    Connects this document to the specified symbol.
    Date
    getCreated()
    Returns the creation date of the document.
    String
    getHref()
    Returns the document references.
    byte[]
    getIcon()
    Returns the document icon.
    long
    getID()
    Returns the ID of the document.
    String
    getName()
    Returns the name of the document.
    String
    getProvider()
    Returns the unique provider string.
    String
    getUUID()
    Returns a unique UUID for the document.
    boolean
    isLeaf()
    Returns true if the document is a leaf in the document tree hierarchy.
    void
    queueSave()
    Asynchronously saves this document.
    void
    remove()
    Removes the extension document.
    void
    save()
    Saves this MTExtensionDocument.

  • Method Details

    • queueSave

      void queueSave()
      Asynchronously saves this document. It is guaranteed to be saved at some point in time, unless the underlying platforms (OS, JVM) shuts down abruptly.

    • save

      void save() throws MTAccessException
      Saves this MTExtensionDocument.
      Throws:
      MTAccessException - if the user issuing the command lacks the access rights.

    • remove

      void remove()
      Removes the extension document.

    • connectTo

      void connectTo(MTModelHeader model)
      Connects this document to the specified model. Note that this will replace any previous connection. That is, a document can only connect to either one model or one symbol.
      Parameters:
      model - The model to connect to.

    • connectTo

      void connectTo(MTSymbolHeader symbol)
      Connects this document to the specified symbol. Note that this will replace any previous connection. That is, a document can only connect to either one model or one symbol.
      Parameters:
      symbol - The symbol to connect to.

    • getID

      long getID()
      Returns the ID of the document.
      Returns:
      The document ID
      Since:
      3.0

    • getHref

      String getHref()
      Returns the document references.
      Returns:
      The document reference.
      Since:
      3.0

    • getName

      String getName()
      Returns the name of the document.
      Returns:
      The document name.
      Since:
      3.0

    • getProvider

      String getProvider()
      Returns the unique provider string.
      Returns:
      A string uniquely defining the plugin (the provider).
      Since:
      3.0

    • getUUID

      String getUUID()
      Returns a unique UUID for the document.
      Returns:
      The document UUID.
      Since:
      3.0

    • getCreated

      Date getCreated()
      Returns the creation date of the document.
      Returns:
      The creation date.
      Since:
      3.0

    • isLeaf

      boolean isLeaf()
      Returns true if the document is a leaf in the document tree hierarchy.
      Returns:
      true if the document is a leaf, false otherwise.
      Since:
      3.0

    • getIcon

      byte[] getIcon()
      Returns the document icon.
      Returns:
      The icon of the document.
      Since:
      3.0