flexagon.fd.model2.notification.payload

Class PipelineGateApprovalAssignedForUserOrEmailPayload

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.model2.notification.payload.BaseNotificationPayload

flexagon.fd.model2.notification.payload.BaseHumanTaskPayload

flexagon.fd.model2.notification.payload.PipelineGateApprovalAssignedForUserOrEmailPayload

All Implemented Interfaces:

NotificationPayload, java.io.Serializable

public class PipelineGateApprovalAssignedForUserOrEmailPayload
extends BaseHumanTaskPayload

See Also:

Serialized Form

Field Summary

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

mHumanTaskDataObject

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

mAttributeGroupName, mNotificationEventTypeEnum, mPipelineAttachments, mPipelineNotes

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

DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
PipelineGateApprovalAssignedForUserOrEmailPayload(PipelineStageGateExecDataObject pDataObject, java.lang.String pAttributeGroupName, 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()
NotifGate	getGate()
java.lang.String	getGateExecutionStatus() Returns the display name of this gate's execution status.
java.lang.String	getGateExecutionStatusCode() Returns the gate execution status type name of the task.
ExecutionUnitStatus	getGateExecutionStatusEnum() Returns the gate execution status enum of the task.
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()
java.lang.String	getSnapshotCreatedByUserAndFullName()
java.lang.String	getTaskNotes() Returns the notes entered by the approver who approves/rejects the approval task.

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

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

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

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

Methods inherited from class flexagon.ff.common.core.pojos.BasePOJO

areEqual

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

PipelineGateApprovalAssignedForUserOrEmailPayload

public PipelineGateApprovalAssignedForUserOrEmailPayload(PipelineStageGateExecDataObject pDataObject,
                                                         java.lang.String pAttributeGroupName,
                                                         NotificationEventTypeEnum pNotificationEventTypeEnum)

Method Detail

addRecipients

public void addRecipients()

getId

public java.lang.Long getId()

Description copied from class: BaseHumanTaskPayload

Returns the internal identifier of the task.

Specified by:

getId in interface NotificationPayload

Overrides:

getId in class BaseHumanTaskPayload

Returns:

The internal identifier of the task.

getPipelineStageExecInfo

public NotifPipelineStageExecInfo getPipelineStageExecInfo()
                                                    throws java.sql.SQLException

Throws:

java.sql.SQLException

getGate

public NotifGate getGate()
                  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 BaseNotificationPayload

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

getSnapshotCreatedByUserAndFullName

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

Throws:

java.sql.SQLException

getGateExecutionStatus

public java.lang.String getGateExecutionStatus()

Returns the display name of this gate's execution status.

Returns:

The display name of this gate's execution status.

getGateExecutionStatusEnum

public ExecutionUnitStatus getGateExecutionStatusEnum()

Returns the gate execution status enum of the task.

Returns:

The gate execution status enum of the task.

getGateExecutionStatusCode

public java.lang.String getGateExecutionStatusCode()

Returns the gate execution status type name of the task.

Returns:

The gate execution status type of the task.

getReleaseDefinitionId

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

Description copied from class: BaseHumanTaskPayload

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 BaseHumanTaskPayload

Returns:

The internal identifier of the release linked to this task.

Throws:

java.sql.SQLException

getTaskNotes

public java.lang.String getTaskNotes()

Returns the notes entered by the approver who approves/rejects the approval task.

Returns:

The notes entered by the approver