com.day.cq.workflow.serialization

Interface SerializationService

public interface SerializationService

The SerializationService manages access to WorkflowModelSerializer services.

Method Summary

Modifier and Type	Method and Description
WorkflowModel	deserialize(java.lang.String modelDefinition, java.lang.String type) Deserializes a WorkflowModel instance from the given (textual) model definition.
java.lang.String	getMimeType(java.lang.String type) Returns the mime type associated with a given type.
java.lang.String	serialize(WorkflowModel model, java.lang.String type) Serializes the given WorkflowModel into a textual representation.

Method Detail

getMimeType

java.lang.String getMimeType(java.lang.String type)

Returns the mime type associated with a given type.

Parameters:

type - The type of the serialization format.

Returns:

The mime type associated with the given type or NULL if no serializer with the given type exists.

serialize

java.lang.String serialize(WorkflowModel model,
                           java.lang.String type)
                    throws java.lang.Exception

Serializes the given WorkflowModel into a textual representation.

Parameters:

model - The WorkflowModel to be serialized.

type - The type of the serialization format.

Returns:

A serialized (textual) representation of the WorkflowModel or NULL if no serializer with the given type was found.

Throws:

java.lang.Exception

deserialize

WorkflowModel deserialize(java.lang.String modelDefinition,
                          java.lang.String type)
                   throws java.lang.Exception

Deserializes a WorkflowModel instance from the given (textual) model definition.

Parameters:

modelDefinition - The model definition as string.

type - The type of the serialization format.

Returns:

The deserialized WorkflowModel or NULL if no serializer with the given type was found.

Throws:

java.lang.Exception