Interface NotificationPayload

All Known Implementing Classes:
BaseHumanTaskPayload, BaseNotificationPayload, FlexDeployMentionPayload, HealthMetricAlertPayload, PasswordExpirationPayload, PasswordUpdatedPayload, PipelineGateApprovalAssignedForEmailPayload, PipelineGateApprovalAssignedForUserPayload, PipelineGateApprovalAssignedOrRejectedPayload, PipelineManualStepAssignedForEmailPayload, PipelineManualStepAssignedForUserPayload, PipelineManualStepAssignedPayload, PipelineNotificationStepPayload, PipelineStepExecFailedPayload, ProjectApprovalTaskPayload, ProjectReviewTaskPayload, ProjectWorkflowRequestPayload, SavedQuerySharedPayload, SavedQuerySubscriptionPayload, SimpleNotificationPayload, TokenExpirationPayload, WorkItemSubscriptionPayload

public interface NotificationPayload
Interface for all Notification Template payloads, representing data which is used to build template content.
  • Field Details

  • Method Details

    • addRecipients

      void addRecipients(String pAttributeGroupName)
    • getRecipients

      List<NotificationRecipient> getRecipients()
    • hasAttachments

      boolean hasAttachments()
      Whether the payload has attachments to be delivered with the notification.
      Returns:
      Whether the payload has attachments to be delivered with the notification.
    • getAttachments

      List<EmailAttachment> getAttachments() throws SQLException
      Returns a list of email attachments pertaining to the event which has occurred.
      Returns:
      A list of email attachements.
      Throws:
      SQLException
    • getHumanTaskIdentityUuid

      String getHumanTaskIdentityUuid()
    • getId

      Long getId()
      Returns the internal identifier of the object on which the event originated.
      Returns:
      The internal identifier of the object on which the event originated.
    • isImportant

      default boolean isImportant()