|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
getEmailAddressForGroup(long plGroupKey) |
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. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
Thor.API.tcResultSet findEmailDefinition(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
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 (%).tcAPIException
- thrown if data set errors occurjava.lang.String getRequestEmailBody(long plEmailDefinitionKey, long plRequestKey) throws tcAPIException, tcInvalidEmailTypeException, tcAPIException
plEmailDefinitionKey
- The key of the email definition to processplRequestKey
- The key of the request to process the email fortcAPIException
- thrown if data set errors occurtcInvalidEmailTypeException
- thrown if the email definition is not of type requestjava.lang.String getProvisioningEmailBody(long plEmailDefinitionKey, long plTaskInstanceKey) throws tcAPIException, tcInvalidEmailTypeException, tcAPIException
plEmailDefinitionKey
- The key of the email definition to processplTaskInstanceKey
- The key of the task instance to process the email fortcAPIException
- thrown if data set errors occurtcInvalidEmailTypeException
- thrown if the email definition is not of type provisioningjava.lang.String getEmailSubject(long plEmailDefinitionKey) throws tcAPIException, tcAPIException
plEmailDefinitionKey
- The key of the email definition to processtcAPIException
- thrown if data set errors occurjava.lang.String getRequestEmailFrom(long plEmailDefinitionKey, long plRequestKey) throws tcAPIException, tcAPIException
plEmailDefinitionKey
- The key of the email definition to processplRequestKey
- The key of the request for which the email was senttcAPIException
- thrown if data set errors occurjava.lang.String getProvisioningEmailFrom(long plEmailDefinitionKey, long plTaskInstanceKey) throws tcAPIException, tcAPIException
plEmailDefinitionKey
- The key of the email definition to processplTaskInstanceKey
- The key of the task instance to process email fortcAPIException
- thrown if data set errors occurjava.lang.String getEmailAddressForGroup(long plGroupKey) throws tcAPIException, tcNoEmailAddressException, tcAPIException
tcAPIException
tcNoEmailAddressException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |