Package se.conciliate.extensions.content

Interface RestModel

All Superinterfaces:
RestAttributeEnabled, RestData
public interface RestModel extends RestData, RestAttributeEnabled

  • Method Details

    • getId

      long getId()

    • getUUID

      String getUUID()

    • getModelType

      String getModelType()

    • getPrefix

      String getPrefix()

    • getWebId

      String getWebId()
      Returns the name this model is expected to have on the web. If the user has entered the field "ID for web" in the user interface this method will return that value. If the user has not, this method will return the model's UUID. The intent is that any URL referencing this model should use this value. A dear child has many names. -- Swedish proverb. In the database this field is called alt_id. In MTModel it is called referenceID. In the user interface it was called "ID for web" last time I checked. When we created the XML for a model in the old publication we used this value for the name of the file. Likewise in Pages we named the json file for the model with this value.
      Returns:
      the model's WebID, will never be null

    • getRevision

      int getRevision()

    • getParentRevision

      Integer getParentRevision()

    • isRevisionLocked

      boolean isRevisionLocked()

    • getWorkflowState

      String getWorkflowState()

    • getTitle

      String getTitle(se.conciliate.mt.rest.RestLocale locale)

    • getPropertyProviders

      Set<String> getPropertyProviders()

    • getProperties

      Map<String,String> getProperties(String provider)

    • getDocuments

      List<RestDocument> getDocuments()

    • getDocumentIDs

      List<Document.DocumentID> getDocumentIDs()

    • getObjects

      List<RestObject> getObjects()

    • getVertices

      List<RestVertex> getVertices()

    • getEdges

      List<RestEdge> getEdges()

    • getRevisionLog

      List<RestRevisionEntry> getRevisionLog()

    • getMaintainers

      List<RestUser> getMaintainers()

    • getReviewers

      List<RestUser> getReviewers()

    • getApprovers

      List<RestUser> getApprovers()

    • getSubscribers

      List<RestSubscriber> getSubscribers()

    • getBounds

      Rectangle getBounds()

    • getLastModified

      ZonedDateTime getLastModified()

    • getOwner

      RestUser getOwner()

    • getGroup

      RestGroup getGroup()

    • getCreated

      ZonedDateTime getCreated()

    • getLastModifiedBy

      RestUser getLastModifiedBy()

    • wrap

      MTCompleteModel wrap()

    • render

      void render(ModelImageExporter exporter, OutputStream output, se.conciliate.mt.rest.RestLocale locale, Map<String,Object> properties) throws IOException
      Throws:
      IOException

    • render

      @Deprecated default void render(ModelImageExporter exporter, OutputStream output, se.conciliate.mt.rest.RestLocale locale, Properties properties) throws IOException
      Deprecated.
      Throws:
      IOException