flexagon.fd.model2.notification.payload

Class NotifPipelineStepRequest

java.lang.Object

BasePOJO

flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

flexagon.fd.model2.notification.payload.NotifTask

flexagon.fd.model2.notification.payload.NotifPipelineStepRequest

All Implemented Interfaces:

NotificationPayload

public class NotifPipelineStepRequest
extends NotifTask

Field Summary

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

mHumanTaskDataObject

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
NotifPipelineStepRequest(PipelineStageStepExecDataObject pDataObject, java.lang.String pAttributeGroupName, NotificationMediumEnum pMediumEnum, NotificationEventTypeEnum pNotificationEventTypeEnum)

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()
java.lang.Long	getId() Returns the internal identifier of the task.
java.util.List<java.lang.String>	getNotes()
NotifPipelineStageExecInfo	getPipelineStageExecInfo()
java.lang.Long	getReleaseDefinitionId() Returns the internal identifier of the release linked to this task.
NotifSnapshot	getSnapshot()
java.lang.String	getSnapshotCreatedByFullName()
NotifStep	getStep()
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, getPipelineStageGateExecId, getPipelineStageStepExecId, 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

NotifPipelineStepRequest

public NotifPipelineStepRequest(PipelineStageStepExecDataObject pDataObject,
                                java.lang.String pAttributeGroupName,
                                NotificationMediumEnum pMediumEnum,
                                NotificationEventTypeEnum pNotificationEventTypeEnum)

Method Detail

addRecipients

public void addRecipients()

getId

public java.lang.Long getId()

Description copied from class: NotifTask

Returns the internal identifier of the task.

Specified by:

getId in interface NotificationPayload

Overrides:

getId in class NotifTask

Returns:

The internal identifier of the task.

getPipelineStageExecInfo

public NotifPipelineStageExecInfo getPipelineStageExecInfo()
                                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getStep

public NotifStep getStep()
                  throws java.sql.SQLException

Throws:

java.sql.SQLException

getSnapshot

public NotifSnapshot getSnapshot()
                          throws java.sql.SQLException

Throws:

java.sql.SQLException

getEnvironment

public NotifEnvironment getEnvironment()
                                throws java.sql.SQLException

Throws:

java.sql.SQLException

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

Throws:

java.sql.SQLException

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.

getReleaseDefinitionId

public java.lang.Long getReleaseDefinitionId()
                                      throws java.sql.SQLException

Description copied from class: NotifTask

Returns the internal identifier of the release linked to this task. Null if task is not part of a release execution.

Overrides:

getReleaseDefinitionId in class NotifTask

Returns:

The internal identifier of the release linked to this task.

Throws:

java.sql.SQLException