Package com.adobe.granite.workflow.model

Interface WorkflowModelSerializer

public interface WorkflowModelSerializer
WorkflowModelSerializer is the interface for services that provide functionality for de-/serialising WorkflowModel from/to other (textual) representations.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MIME_TYPE
    Property for the mime type of the serialization format of the WorkflowModelSerializer.
    static final String
    TYPE
    Property for the type serialization type of the WorkflowModelSerializer.

  • Method Summary

    Modifier and Type
    Method
    Description
    WorkflowModel
    deserialize(String modelDefinition)
    Deserializes a WorkflowModel instance from the given (textual) model definition.
    String
    getMimeType()
    Returns the mime type of the WorkflowModelSerializers serialization format.
    String
    getType()
    Returns the type of the WorkflowModelSerializer.
    String
    serialize(WorkflowModel model)
    Serializes the given WorkflowModel into a textual representation.

  • Field Details

    • TYPE

      static final String TYPE
      Property for the type serialization type of the WorkflowModelSerializer.
      See Also:

    • MIME_TYPE

      static final String MIME_TYPE
      Property for the mime type of the serialization format of the WorkflowModelSerializer.
      See Also:

  • Method Details

    • getType

      String getType()
      Returns the type of the WorkflowModelSerializer. Must return a unique string describing the type of the WorkflowModelSerializer and serialization format respectively.
      Returns:
      Unique string identifier for the type of the WorkflowModelSerializer and serialization format.

    • getMimeType

      String getMimeType()
      Returns the mime type of the WorkflowModelSerializers serialization format.
      Returns:
      The mime type of the serialized format.

    • serialize

      String serialize(WorkflowModel model) throws Exception
      Serializes the given WorkflowModel into a textual representation.
      Parameters:
      model - The WorkflowModel to be serialized.
      Returns:
      A serialized (textual) representation of the WorkflowModel.
      Throws:
      Exception - if something goes wrong during serialization

    • deserialize

      WorkflowModel deserialize(String modelDefinition) throws Exception
      Deserializes a WorkflowModel instance from the given (textual) model definition.
      Parameters:
      modelDefinition - The model definition as string.
      Returns:
      The deserialized WorkflowModel.
      Throws:
      Exception - if something goes wrong during deserialization