Thor.API.Operations
Interface tcEmailOperationsIntf

public interface tcEmailOperationsIntf

Method Summary

Thor.API.tcResultSet	findEmailDefinition(java.util.Map phAttributeList) Returns a list of emails (in the form of tcResultSet) that match the provided attribute list.
java.lang.String	getEmailSubject(long plEmailDefinitionKey) Retrieves the email subject for an email definition.
java.lang.String	getProvisioningEmailBody(long plEmailDefinitionKey, long plTaskInstanceKey) Retrieves the processed email body for a provisioning type email definition.
java.lang.String	getProvisioningEmailFrom(long plEmailDefinitionKey, long plTaskInstanceKey) Retrieves the email address of the sender of the provisioning email according to the provisioning email definition.
java.lang.String	getRequestEmailBody(long plEmailDefinitionKey, long plRequestKey) Retrieves the processed email body for a request type email definition.
java.lang.String	getRequestEmailFrom(long plEmailDefinitionKey, long plRequestKey) Retrieves the email address of the sender of the Request email according to the request email definition.

Method Detail

findEmailDefinition

public Thor.API.tcResultSet findEmailDefinition(java.util.Map phAttributeList)
                                         throws Thor.API.Exceptions.tcAPIException,
                                                tcAPIException

Returns a list of emails (in the form of tcResultSet) that match the provided attribute list.

Parameters:

phAttributeList - - A map object, each entry holding the attribute-value pairs to match the email definition against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).

Returns:

A tcResultSet containing multiple rows, each holding information about the email definition.

Throws:

tcAPIException - thrown if data set errors occur

getRequestEmailBody

public java.lang.String getRequestEmailBody(long plEmailDefinitionKey,
                                            long plRequestKey)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            Thor.API.Exceptions.tcInvalidEmailTypeException,
                                            tcAPIException

Retrieves the processed email body for a request type email definition.

Parameters:

plEmailDefinitionKey - The key of the email definition to process

plRequestKey - The key of the request to process the email for

Returns:

A string containing the email body.

Throws:

tcAPIException - thrown if data set errors occur

tcInvalidEmailTypeException - thrown if the email definition is not of type request

getProvisioningEmailBody

public java.lang.String getProvisioningEmailBody(long plEmailDefinitionKey,
                                                 long plTaskInstanceKey)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 Thor.API.Exceptions.tcInvalidEmailTypeException,
                                                 tcAPIException

Retrieves the processed email body for a provisioning type email definition.

Parameters:

plEmailDefinitionKey - The key of the email definition to process

plTaskInstanceKey - The key of the task instance to process the email for

Returns:

A string containing the email body.

Throws:

tcAPIException - thrown if data set errors occur

tcInvalidEmailTypeException - thrown if the email definition is not of type provisioning

getEmailSubject

public java.lang.String getEmailSubject(long plEmailDefinitionKey)
                                 throws Thor.API.Exceptions.tcAPIException,
                                        tcAPIException

Retrieves the email subject for an email definition.

Parameters:

plEmailDefinitionKey - The key of the email definition to process

Returns:

A string containing the email subject.

Throws:

tcAPIException - thrown if data set errors occur

getRequestEmailFrom

public java.lang.String getRequestEmailFrom(long plEmailDefinitionKey,
                                            long plRequestKey)
                                     throws Thor.API.Exceptions.tcAPIException,
                                            tcAPIException

Retrieves the email address of the sender of the Request email according to the request email definition.

Parameters:

plEmailDefinitionKey - The key of the email definition to process

plRequestKey - The key of the request for which the email was sent

Returns:

A string containing the email address of the sender.

Throws:

tcAPIException - thrown if data set errors occur

getProvisioningEmailFrom

public java.lang.String getProvisioningEmailFrom(long plEmailDefinitionKey,
                                                 long plTaskInstanceKey)
                                          throws Thor.API.Exceptions.tcAPIException,
                                                 tcAPIException

Retrieves the email address of the sender of the provisioning email according to the provisioning email definition.

Parameters:

plEmailDefinitionKey - The key of the email definition to process

plTaskInstanceKey - The key of the task instance to process email for

Returns:

A string containing the email address of the sender.

Throws:

tcAPIException - thrown if data set errors occur