Class PipelineManualStepAssignedPayload
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.PipelineManualStepAssignedPayload
- All Implemented Interfaces:
NotificationPayload,Serializable
Notification Template payload representing an approval task for a pipeline step.
- See Also:
-
Field Summary
Fields inherited from class flexagon.fd.model2.notification.payload.BaseHumanTaskPayload
mHumanTaskDataObjectFields 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
ConstructorsConstructorDescriptionPipelineManualStepAssignedPayload(HumanTaskDataObject pHumanTaskDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload -
Method Summary
Modifier and TypeMethodDescriptionvoidaddRecipients(String pAttributeGroupName) Returns a list of email attachments pertaining to the event which has occurred.Returns the environment data for this task's linked pipeline stage execution.getNotes()Returns the notes attached to this task's step execution as a list of strings.Returns the execution info data provided in the linked pipeline stage.Returns the snapshot data linked to this task's pipeline execution.getStep()Returns the pipeline step linked to this task.Returns the display name of this step's execution status.Returns the step execution status type name of the task.Returns the step execution status enum of the task.Methods inherited from class flexagon.fd.model2.notification.payload.BaseHumanTaskPayload
getActionBy, getActionByFullName, getActionOn, getChangeLogsFromSnapshot, getExternalSystemId, getExternalTicket, getGroupId, getHumanTaskIdentityUuid, getId, getPipelineStageGateExecId, getPipelineStageStepExecId, getReleaseDefinitionId, getStatus, getStatusCode, getStatusEnum, getWorkflowRequestIdMethods 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, 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
getRecipients, hasAttachments, isImportant
-
Constructor Details
-
PipelineManualStepAssignedPayload
public PipelineManualStepAssignedPayload(HumanTaskDataObject pHumanTaskDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload- Parameters:
pHumanTaskDataObject- The task data.pNotificationEventTypeEnum- The event type.
-
-
Method Details
-
addRecipients
-
getPipelineStageExecInfo
Returns the execution info data provided in the linked pipeline stage.- Returns:
- The execution info data provided in the linked pipeline stage.
- Throws:
SQLException- If the information cannot be retrieved from the database.
-
getStep
Returns the pipeline step linked to this task.- Returns:
- The pipeline step linked to this task.
- Throws:
SQLException- If the information cannot be retrieved from the database.
-
getSnapshot
Returns the snapshot data linked to this task's pipeline execution.- Returns:
- The snapshot data linked to this task's pipeline execution.
- Throws:
SQLException- If the information cannot be retrieved from the database.
-
getEnvironment
Returns the environment data for this task's linked pipeline stage execution.- Returns:
- The environment data for this task's linked pipeline stage execution.
- Throws:
SQLException- If the information cannot be retrieved from the database.
-
getAttachments
Description copied from interface:NotificationPayloadReturns a list of email attachments pertaining to the event which has occurred.- Specified by:
getAttachmentsin interfaceNotificationPayload- Overrides:
getAttachmentsin classBaseNotificationPayload- Returns:
- A list of email attachements.
- Throws:
SQLException
-
getNotes
Returns the notes attached to this task's step execution as a list of strings.- Returns:
- Returns the notes attached to this task's step execution as a list of strings.
- Throws:
SQLException- If the information cannot be retrieved from the database.
-
getSnapshotCreatedByFullName
- Throws:
SQLException
-
getSnapshotCreatedByUserAndFullName
- Throws:
SQLException
-
getStepExecutionStatus
Returns the display name of this step's execution status.- Returns:
- The display name of this step's execution status.
-
getStepExecutionStatusEnum
Returns the step execution status enum of the task.- Returns:
- The step execution status enum of the task.
-
getStepExecutionStatusCode
Returns the step execution status type name of the task.- Returns:
- The step execution status type of the task.
-
getTaskInputFields
- Throws:
SQLException
-