flexagon.fd.model2.notification.payload

Class NotifPipelineStepExectionRequest

java.lang.Object

BasePOJO

flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

flexagon.fd.model2.notification.payload.NotifPipelineStepExectionRequest

All Implemented Interfaces:

NotificationPayload

public class NotifPipelineStepExectionRequest
extends AbstractNotifBaseRequest

Notification Template payload representing a pipeline step execution request.

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
NotifPipelineStepExectionRequest(PipelineStageStepExecDataObject pPipelineStageStepExecDataObject, 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 request's linked pipeline stage execution.
java.lang.String	getErrorMessage() Returns any error message from this pipeline step execution.
java.lang.Long	getId() Returns the internal identifier of the object on which the event originated.
NotifPipelineStageExecInfo	getPipelineStageExecInfo() Returns the execution info data provided in the linked pipeline stage.
NotifSnapshot	getSnapshot() Returns the snapshot data linked to this request's pipeline execution.
java.lang.String	getSnapshotCreatedBy() Returns the name of the user who created the snapshot linked to this step execution.
java.lang.String	getSnapshotCreatedByFullName() Returns the full name of the user who created the snapshot linked to this step execution ("[First Name] [Last Name]").
NotifStep	getStep() Returns the pipeline step linked to this execution.
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 step.
ExecutionUnitStatus	getStepExecutionStatusEnum() Returns the execution status enum of the step.
java.util.List<NotifWorkflowRequest>	getWorkflowRequestList() Returns the list of workflow execution requests that are part of this step execution.

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, getHumanTaskIdentityUuid, 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

Constructor Detail

NotifPipelineStepExectionRequest

public NotifPipelineStepExectionRequest(PipelineStageStepExecDataObject pPipelineStageStepExecDataObject,
                                        java.lang.String pAttributeGroupName,
                                        NotificationMediumEnum pMediumEnum,
                                        NotificationEventTypeEnum pNotificationEventTypeEnum)

Creates the notification payload

Parameters:

pPipelineStageStepExecDataObject - The pipeline stage step execution data.

pAttributeGroupName - The medium settings group name.

pMediumEnum - The medium type.

pNotificationEventTypeEnum - The event type.

Method Detail

addRecipients

public void addRecipients()

getStep

public NotifStep getStep()
                  throws java.sql.SQLException

Returns the pipeline step linked to this execution.

Returns:

The pipeline step linked to this execution.

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 request's pipeline execution.

Returns:

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

Throws:

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

getEnvironment

public NotifEnvironment getEnvironment()
                                throws java.sql.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:

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

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.

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

getErrorMessage

public java.lang.String getErrorMessage()

Returns any error message from this pipeline step execution.

Returns:

Any error message from this pipeline step execution.

Throws:

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

getWorkflowRequestList

public java.util.List<NotifWorkflowRequest> getWorkflowRequestList()
                                                            throws java.sql.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:

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

getSnapshotCreatedBy

public java.lang.String getSnapshotCreatedBy()
                                      throws java.sql.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:

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

getSnapshotCreatedByFullName

public java.lang.String getSnapshotCreatedByFullName()
                                              throws java.sql.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:

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

getId

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

Returns:

The execution status enum of the step.

getStepExecutionStatusCode

public java.lang.String getStepExecutionStatusCode()

Returns the step execution status type name of the step.

Returns:

The execution status type of the step.