Package org.opencastproject.email.template.impl

Class EmailData

java.lang.Object

org.opencastproject.util.doc.DocData

org.opencastproject.email.template.impl.EmailData

public class EmailData
extends org.opencastproject.util.doc.DocData

Holds data to be displayed in an email message. The following data will be available: mediaPackage, workflow, workflowConfig: workflow configuration as key-value pairs, catalogs: hash of catalogs whose key is the catalog flavor sub-type e.g. "series", "episode", failedOperation: the last operation marked as "failOnError" that failed.

Field Summary

Fields inherited from class org.opencastproject.util.doc.DocData

meta, notes, TEMPLATE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
EmailData(String name, org.opencastproject.workflow.api.WorkflowInstance workflow, HashMap<String,HashMap<String,String>> catalogs, org.opencastproject.workflow.api.WorkflowOperationInstance failed, List<org.opencastproject.job.api.Incident> incidents, Map<String,String> orgProperties)	Create the base data object for populating email fields.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	toMap()
String	toString()	Returns a string representation of this object.

Methods inherited from class org.opencastproject.util.doc.DocData

addNote, getDefaultTemplatePath, getMeta, getMetaData, getNotes, isValidName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

EmailData

public EmailData(String name,
 org.opencastproject.workflow.api.WorkflowInstance workflow,
 HashMap<String,HashMap<String,String>> catalogs,
 org.opencastproject.workflow.api.WorkflowOperationInstance failed,
 List<org.opencastproject.job.api.Incident> incidents,
 Map<String,String> orgProperties)

Create the base data object for populating email fields.

Parameters:

name - a name for this object

workflow - workflow instance

catalogs - hash map of media package catalogs

failed - workflow operation that caused the workflow to fail

incidents - incidents

orgProperties - organization properties

Method Details

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

a string representation of this object

toMap

public Map<String,Object> toMap()
                         throws IllegalStateException

Overrides:

toMap in class org.opencastproject.util.doc.DocData

Throws:

IllegalStateException