Package flexagon.fd.model2.notification.payload

Class PipelineStepExecFailedPayload

java.lang.Object
flexagon.ff.common.core.pojos.BasePOJO
flexagon.fd.model2.notification.payload.BaseNotificationPayload
flexagon.fd.model2.notification.payload.PipelineStepExecFailedPayload
All Implemented Interfaces:
NotificationPayload, Serializable
public class PipelineStepExecFailedPayload extends BaseNotificationPayload
Notification Template payload representing a pipeline step execution request.
See Also:

  • Constructor Details

    • PipelineStepExecFailedPayload

      public PipelineStepExecFailedPayload(PipelineStageStepExecDataObject pPipelineStageStepExecDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum)
      Creates the notification payload
      Parameters:
      pPipelineStageStepExecDataObject - The pipeline stage step execution data.
      pNotificationEventTypeEnum - The event type.

  • Method Details

    • addRecipients

      public void addRecipients(String pAttributeGroupName)

    • getStep

      public NotifStep getStep() throws SQLException
      Returns the pipeline step linked to this execution.
      Returns:
      The pipeline step linked to this execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getSnapshot

      public NotifSnapshot getSnapshot() throws SQLException
      Returns the snapshot data linked to this request's pipeline execution.
      Returns:
      The snapshot data linked to this request's pipeline execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getEnvironment

      public NotifEnvironment getEnvironment() throws SQLException
      Returns the environment data for this request's linked pipeline stage execution.
      Returns:
      The environment data for this request's linked pipeline stage execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getPipelineStageExecInfo

      public NotifPipelineStageExecInfo getPipelineStageExecInfo() throws SQLException
      Returns the execution info data provided in the linked pipeline stage.
      Returns:
      The execution info data provided in the linked pipeline stage.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getAttachments

      public List<EmailAttachment> getAttachments() throws SQLException
      Description copied from interface: NotificationPayload
      Returns a list of email attachments pertaining to the event which has occurred.
      Specified by:
      getAttachments in interface NotificationPayload
      Overrides:
      getAttachments in class BaseNotificationPayload
      Returns:
      A list of email attachements.
      Throws:
      SQLException

    • getErrorMessage

      public String getErrorMessage()
      Returns any error message from this pipeline step execution.
      Returns:
      Any error message from this pipeline step execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getWorkflowRequestList

      public List<NotifWorkflowRequest> getWorkflowRequestList() throws SQLException
      Returns the list of workflow execution requests that are part of this step execution.
      Returns:
      The list of workflow execution requests that are part of this step execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getSnapshotCreatedBy

      public String getSnapshotCreatedBy() throws SQLException
      Returns the name of the user who created the snapshot linked to this step execution.
      Returns:
      The name of the user who created the snapshot linked to this step execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getSnapshotCreatedByFullName

      public String getSnapshotCreatedByFullName() throws SQLException
      Returns the full name of the user who created the snapshot linked to this step execution ("[First Name] [Last Name]").
      Returns:
      The full name of the user who created the snapshot linked to this step execution.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getSnapshotCreatedByUserAndFullName

      public String getSnapshotCreatedByUserAndFullName() throws SQLException
      Throws:
      SQLException

    • getId

      public Long getId()
      Description copied from interface: NotificationPayload
      Returns the internal identifier of the object on which the event originated.
      Returns:
      The internal identifier of the object on which the event originated.

    • getStepExecutionStatus

      public String getStepExecutionStatus()
      Returns the display name of this step's execution status.
      Returns:
      The display name of this step's execution status.

    • getStepExecutionStatusEnum

      public ExecutionUnitStatus getStepExecutionStatusEnum()
      Returns the execution status enum of the step.
      Returns:
      The execution status enum of the step.

    • getStepExecutionStatusCode

      public String getStepExecutionStatusCode()
      Returns the step execution status type name of the step.
      Returns:
      The execution status type of the step.