flexagon.fd.model2.notification.payload

Class NotifPipelineStepTask

java.lang.Object

BasePOJO

flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

flexagon.fd.model2.notification.payload.NotifTask

flexagon.fd.model2.notification.payload.NotifPipelineStepTask

All Implemented Interfaces:

NotificationPayload

public class NotifPipelineStepTask
extends NotifTask

Notification Template payload representing an approval task for a pipeline step.

Field Summary

Fields inherited from class flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

mAttributeGroupName, mNotificationEventTypeEnum, mNotificationMediumEnum, mPipelineAttachments, mPipelineNotes

Fields inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload

DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
NotifPipelineStepTask(HumanTaskDataObject pHumanTaskDataObject, java.lang.String pAttributeGroupName, NotificationMediumEnum pMediumEnum, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload

Method Summary

Modifier and Type	Method and Description
void	addRecipients()
java.util.List<EmailAttachment>	getAttachments() Returns a list of email attachments pertaining to the event which has occurred.
NotifEnvironment	getEnvironment() Returns the environment data for this task's linked pipeline stage execution.
java.util.List<java.lang.String>	getNotes() Returns the notes attached to this task's step execution as a list of strings.
NotifPipelineStageExecInfo	getPipelineStageExecInfo() Returns the execution info data provided in the linked pipeline stage.
NotifSnapshot	getSnapshot() Returns the snapshot data linked to this task's pipeline execution.
java.lang.String	getSnapshotCreatedByFullName()
NotifStep	getStep() Returns the pipeline step linked to this task.
java.lang.String	getStepExecutionStatus() Returns the display name of this step's execution status.
java.lang.String	getStepExecutionStatusCode() Returns the step execution status type name of the task.
ExecutionUnitStatus	getStepExecutionStatusEnum() Returns the step execution status enum of the task.

Methods inherited from class flexagon.fd.model2.notification.payload.NotifTask

getActionBy, getActionByFullName, getActionOn, getChangeLogsFromSnapshot, getExternalSystemId, getExternalTicket, getGroupId, getHumanTaskIdentityUuid, getId, getPipelineStageGateExecId, getPipelineStageStepExecId, getReleaseDefinitionId, getStatus, getStatusCode, getStatusEnum, getWorkflowRequestId

Methods inherited from class flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

addAttachment, addAttachment, addAttachment, addAttachment, addRecipientsByCommittersIfEligible, addRecipientsByGroupId, addRecipientsByGroupNameIfEligible, addRecipientsByPipelineRoleMember, addRecipientsByPipelineRoleUserOrEmailMember, addRecipientsBySubscriptions, addRecipientsByUserNameIfEligible, addRecipientsForPiplelineGate, addRecipientsForPiplelineStepExecution, getApprovalGateRoleByGateId, getApprovalTaskUrlPath, getFolderWithHierarchy, getHumanTaskUrlPath, getManualStepRoleByStepId, getPipelineStageExecutionSnapshotQueryResultRow, getRecipients, getUserFullName, hasAttachments, isGroupMemberOfPipelineRole, isSendLogAttachments, isShowNotesAndSendAttachments, populatePipelineAttachmentsAndNotes, sendLogAttachments, showNotesAndSendAttachments, showTextForMissingUrlSetup, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload

getRecipients, hasAttachments

Constructor Detail

NotifPipelineStepTask

public NotifPipelineStepTask(HumanTaskDataObject pHumanTaskDataObject,
                             java.lang.String pAttributeGroupName,
                             NotificationMediumEnum pMediumEnum,
                             NotificationEventTypeEnum pNotificationEventTypeEnum)

Creates the notification payload

Parameters:

pHumanTaskDataObject - The task data.

pAttributeGroupName - The medium settings group name.

pMediumEnum - The medium type.

pNotificationEventTypeEnum - The event type.

Method Detail

addRecipients

public void addRecipients()

getPipelineStageExecInfo

public NotifPipelineStageExecInfo getPipelineStageExecInfo()
                                                    throws java.sql.SQLException

Returns the execution info data provided in the linked pipeline stage.

Returns:

The execution info data provided in the linked pipeline stage.

Throws:

java.sql.SQLException - If the information cannot be retrieved from the database.

getStep

public NotifStep getStep()
                  throws java.sql.SQLException

Returns the pipeline step linked to this task.

Returns:

The pipeline step linked to this task.

Throws:

java.sql.SQLException - If the information cannot be retrieved from the database.

getSnapshot

public NotifSnapshot getSnapshot()
                          throws java.sql.SQLException

Returns the snapshot data linked to this task's pipeline execution.

Returns:

The snapshot data linked to this task's pipeline execution.

Throws:

java.sql.SQLException - If the information cannot be retrieved from the database.

getEnvironment

public NotifEnvironment getEnvironment()

Returns the environment data for this task's linked pipeline stage execution.

Returns:

The environment data for this task's linked pipeline stage execution.

Throws:

java.sql.SQLException - If the information cannot be retrieved from the database.

getAttachments

public java.util.List<EmailAttachment> getAttachments()
                                               throws java.sql.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 AbstractNotifBaseRequest

Returns:

A list of email attachements.

Throws:

java.sql.SQLException

getNotes

public java.util.List<java.lang.String> getNotes()
                                          throws java.sql.SQLException

Returns the notes attached to this task's step execution as a list of strings.

Returns:

Returns the notes attached to this task's step execution as a list of strings.

Throws:

java.sql.SQLException - If the information cannot be retrieved from the database.

getSnapshotCreatedByFullName

public java.lang.String getSnapshotCreatedByFullName()
                                              throws java.sql.SQLException

Throws:

java.sql.SQLException

getStepExecutionStatus

public java.lang.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 step execution status enum of the task.

Returns:

The step execution status enum of the task.

getStepExecutionStatusCode

public java.lang.String getStepExecutionStatusCode()

Returns the step execution status type name of the task.

Returns:

The step execution status type of the task.