Package se.conciliate.extensions.store

Interface MTColorSchemeHeader

All Known Subinterfaces:
MTColorScheme
public interface MTColorSchemeHeader
Author:
sebastian

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_COLOR_SCHEME_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    MTColorScheme
    expand()
    Returns a MTColorScheme for this color scheme.
    long
    getID()
    Returns the unique ID of the color scheme.
    String
    getTitle()
    Return the title of the color scheme.
    boolean
    isDefaultColorScheme()
    Checks if the color scheme is the default color scheme on the server.
    boolean
    isTitleAvailable()
    Makes a database trip to check if the title is available or not.
    void
    remove()
    Removes the color scheme.

  • Field Details

  • Method Details

    • getID

      long getID()
      Returns the unique ID of the color scheme. This ID is unique across the entire database.
      Returns:
      The unique ID.
      Since:
      3.0

    • getTitle

      String getTitle()
      Return the title of the color scheme.
      Returns:
      The color scheme title.
      Since:
      3.0

    • isTitleAvailable

      boolean isTitleAvailable()
      Makes a database trip to check if the title is available or not.
      Returns:
      true if the title is available, otherwise false
      Since:
      3.0

    • isDefaultColorScheme

      boolean isDefaultColorScheme()
      Checks if the color scheme is the default color scheme on the server.
      Returns:
      true if this color scheme is the default, false otherwise.
      Since:
      3.0

    • expand

      MTColorScheme expand() throws MTAccessException
      Returns a MTColorScheme for this color scheme. Beware that this might require querying the storage layer for more data.
      Returns:
      A MTColorScheme representing this color scheme.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      3.0

    • remove

      void remove() throws MTAccessException
      Removes the color scheme.
      Throws:
      MTAccessException - If an MTAccessException occurs.
      Since:
      3.0