flexagon.fd.model2.notification.payload

Class BaseHumanTaskPayload

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.model2.notification.payload.BaseNotificationPayload

flexagon.fd.model2.notification.payload.BaseHumanTaskPayload

All Implemented Interfaces:

NotificationPayload, java.io.Serializable

Direct Known Subclasses:

PipelineGateApprovalAssignedForUserOrEmailPayload, PipelineGateApprovalAssignedOrRejectedPayload, PipelineManualStepAssignedForUserOrEmailPayload, PipelineManualStepAssignedPayload, ProjectApprovalTaskPayload, ProjectReviewTaskPayload

public abstract class BaseHumanTaskPayload
extends BaseNotificationPayload
implements NotificationPayload

Abstract Notification Template payload base class for FlexDeploy task events.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HumanTaskDataObject	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
BaseHumanTaskPayload(HumanTaskDataObject pHumanTaskDataObject, java.lang.String pAttributeGroupName, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionBy() Returns the name of the user who performed the last action on the task.
java.lang.String	getActionByFullName() Returns the full name of the user who performed the last action on the task.
java.sql.Timestamp	getActionOn() Returns the timestamp of when the last action was performed on the task.
protected java.util.List<NotifScmCommit>	getChangeLogsFromSnapshot(NotifSnapshot pNotifSnapshot)
java.lang.Long	getExternalSystemId() Returns the internal identifier of the external system linked to an external approval gate.
java.lang.String	getExternalTicket() Returns the CMS ticket number linked to an external approval task.
java.lang.Long	getGroupId() Returns the internal identifier of the group assigned to the task.
java.lang.String	getHumanTaskIdentityUuid() Returns the UUID for the human task.
java.lang.Long	getId() Returns the internal identifier of the task.
java.lang.Long	getPipelineStageGateExecId() Returns the internal identifier of the linked pipeline gate execution.
java.lang.Long	getPipelineStageStepExecId() Returns the internal identifier of the linked pipelne step execution.
java.lang.Long	getReleaseDefinitionId() Returns the internal identifier of the release linked to this task.
java.lang.String	getStatus() Returns the display name of this task's status.
java.lang.String	getStatusCode() Returns the status type name of the task.
TaskStatusEnum	getStatusEnum() Returns the status enum of the task.
java.lang.Long	getWorkflowRequestId() Returns the internal identifier of the linked workflow request.

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

addRecipients, getAttachments, getRecipients, hasAttachments

Field Detail

mHumanTaskDataObject

protected final HumanTaskDataObject mHumanTaskDataObject

Constructor Detail

BaseHumanTaskPayload

public BaseHumanTaskPayload(HumanTaskDataObject pHumanTaskDataObject,
                            java.lang.String pAttributeGroupName,
                            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

getGroupId

public java.lang.Long getGroupId()

Returns the internal identifier of the group assigned to the task.

Returns:

The internal identifier of the group assigned to the task.

getActionBy

public java.lang.String getActionBy()

Returns the name of the user who performed the last action on the task. Null if no action performed.

Returns:

The name of the user who performed the last action on the task.

getActionByFullName

public java.lang.String getActionByFullName()

Returns the full name of the user who performed the last action on the task. Null if no action performed ("[First Name] [Last Name]").

Returns:

The full name of the user who performed the last action on the task.

getActionOn

public java.sql.Timestamp getActionOn()

Returns the timestamp of when the last action was performed on the task. Null if no action performed.

Returns:

The timestamp of when the last action was performed on the task.

getStatusEnum

public TaskStatusEnum getStatusEnum()

Returns the status enum of the task.

Returns:

The status enum of the task.

getStatusCode

public java.lang.String getStatusCode()

Returns the status type name of the task.

Returns:

The status type of the task.

getStatus

public java.lang.String getStatus()

Returns the display name of this task's status.

Returns:

The display name of this task's status.

getPipelineStageGateExecId

public java.lang.Long getPipelineStageGateExecId()

Returns the internal identifier of the linked pipeline gate execution. Null if task is not for a pipeline gate.

Returns:

The internal identifier of the linked pipeline gate execution.

getPipelineStageStepExecId

public java.lang.Long getPipelineStageStepExecId()

Returns the internal identifier of the linked pipelne step execution. Null if task is not for a pipeline step.

Returns:

The internal identifier of the linked pipeline step execution.

getId

public java.lang.Long getId()

Returns the internal identifier of the task.

Specified by:

getId in interface NotificationPayload

Returns:

The internal identifier of the task.

getExternalSystemId

public java.lang.Long getExternalSystemId()

Returns the internal identifier of the external system linked to an external approval gate. Null if task is not for an external approval gate.

Returns:

The internal identifier of the external system linked to an external approval gate.

getExternalTicket

public java.lang.String getExternalTicket()

Returns the CMS ticket number linked to an external approval task. Null if task is not for an external approval gate, or if no ticket is assigned.

Returns:

The CMS ticket number linked to an external approval task.

getWorkflowRequestId

public java.lang.Long getWorkflowRequestId()

Returns the internal identifier of the linked workflow request. Null if task is not for a workflow request.

Returns:

The internal identifier of the linked workflow request.

getHumanTaskIdentityUuid

public java.lang.String getHumanTaskIdentityUuid()

Returns the UUID for the human task.

Specified by:

getHumanTaskIdentityUuid in interface NotificationPayload

Overrides:

getHumanTaskIdentityUuid in class BaseNotificationPayload

Returns:

The UUID for the human task.

getReleaseDefinitionId

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

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

Returns:

The internal identifier of the release linked to this task.

Throws:

java.sql.SQLException

getChangeLogsFromSnapshot

protected java.util.List<NotifScmCommit> getChangeLogsFromSnapshot(NotifSnapshot pNotifSnapshot)
                                                            throws java.sql.SQLException

Throws:

java.sql.SQLException