Package Thor.API.Operations

Interface tcEmailOperationsIntf

All Superinterfaces:
tcUtilityOperationsIntf
public interface tcEmailOperationsIntf extends tcUtilityOperationsIntf

  • Method Details

    • findEmailDefinition

      Thor.API.tcResultSet findEmailDefinition(Map phAttributeList) throws 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

    • getProvisioningEmailBody

      String getProvisioningEmailBody(long plEmailDefinitionKey, long plTaskInstanceKey) throws tcAPIException, 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

      String getEmailSubject(long plEmailDefinitionKey) throws 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

    • getProvisioningEmailFrom

      String getProvisioningEmailFrom(long plEmailDefinitionKey, long plTaskInstanceKey) throws 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

    • getEmailAddressForGroup

      String getEmailAddressForGroup(long plGroupKey) throws tcAPIException, tcNoEmailAddressException, tcAPIException
      Throws:
      tcAPIException
      tcNoEmailAddressException
      tcAPIException