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,Serializable
- Direct Known Subclasses:
PipelineGateApprovalAssignedForUserPayload,PipelineGateApprovalAssignedOrRejectedPayload,PipelineManualStepAssignedForUserPayload,PipelineManualStepAssignedPayload,ProjectApprovalTaskPayload,ProjectReviewTaskPayload
public abstract class BaseHumanTaskPayload
extends BaseNotificationPayload
implements NotificationPayload
Abstract Notification Template payload base class for FlexDeploy task events.
- See Also:
-
Field Summary
FieldsFields inherited from class flexagon.fd.model2.notification.payload.BaseNotificationPayload
mNotificationEventTypeEnum, mPipelineAttachments, mPipelineNotesFields inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload
DATE_FORMAT -
Constructor Summary
ConstructorsConstructorDescriptionBaseHumanTaskPayload(HumanTaskDataObject pHumanTaskDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload -
Method Summary
Modifier and TypeMethodDescriptionReturns the name of the user who performed the last action on the task.Returns the full name of the user who performed the last action on the task.Returns the timestamp of when the last action was performed on the task.protected List<NotifScmCommit>getChangeLogsFromSnapshot(NotifSnapshot pNotifSnapshot) Returns the internal identifier of the external system linked to an external approval gate.Returns the CMS ticket number linked to an external approval task.Returns the internal identifier of the group assigned to the task.Returns the UUID for the human task.getId()Returns the internal identifier of the task.Returns the internal identifier of the linked pipeline gate execution.Returns the internal identifier of the linked pipelne step execution.Returns the internal identifier of the release linked to this task.Returns the display name of this task's status.Returns the status type name of the task.Returns the status enum of the task.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, addRecipientsForPipelineStepExecFailure, evaluatePipelineRoleScript, getApprovalGateRoleByGateId, getApprovalTaskUrlPath, getAttachments, getFolderWithHierarchy, getHumanTaskUrlPath, getInputFieldsForStep, getManualStepRoleByStepId, getPipelineRoleScriptForGate, getPipelineRoleScriptForStep, getPipelineStageExecutionSnapshotQueryResultRow, getRecipients, getUserFullName, hasAttachments, isGroupMemberOfPipelineRole, isSendLogAttachments, isShowNotesAndSendAttachments, populatePipelineAttachmentsAndNotes, sendLogAttachments, showNotesAndSendAttachments, showTextForMissingUrlSetup, toNotifScmCommits, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload
addRecipients, getAttachments, getRecipients, hasAttachments, isImportant
-
Field Details
-
mHumanTaskDataObject
-
-
Constructor Details
-
BaseHumanTaskPayload
public BaseHumanTaskPayload(HumanTaskDataObject pHumanTaskDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload- Parameters:
pHumanTaskDataObject- The task data.pNotificationEventTypeEnum- The event type.
-
-
Method Details
-
getGroupId
Returns the internal identifier of the group assigned to the task.- Returns:
- The internal identifier of the group assigned to the task.
-
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
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
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
Returns the status enum of the task.- Returns:
- The status enum of the task.
-
getStatusCode
Returns the status type name of the task.- Returns:
- The status type of the task.
-
getStatus
Returns the display name of this task's status.- Returns:
- The display name of this task's status.
-
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
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
Returns the internal identifier of the task.- Specified by:
getIdin interfaceNotificationPayload- Returns:
- The internal identifier of the task.
-
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
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
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
Returns the UUID for the human task.- Specified by:
getHumanTaskIdentityUuidin interfaceNotificationPayload- Overrides:
getHumanTaskIdentityUuidin classBaseNotificationPayload- Returns:
- The UUID for the human task.
-
getReleaseDefinitionId
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:
SQLException
-
getChangeLogsFromSnapshot
protected List<NotifScmCommit> getChangeLogsFromSnapshot(NotifSnapshot pNotifSnapshot) throws SQLException - Throws:
SQLException
-