flexagon.fd.model2.notification.payload

Class ProjectWorkflowRequestPayload

java.lang.Object

flexagon.ff.common.core.pojos.BasePOJO

flexagon.fd.model2.notification.payload.BaseNotificationPayload

flexagon.fd.model2.notification.payload.ProjectWorkflowRequestPayload

All Implemented Interfaces:

NotificationPayload, java.io.Serializable

public class ProjectWorkflowRequestPayload
extends BaseNotificationPayload

Notification Template payload representing a project workflow request.

See Also:

Serialized Form

Field Summary

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
ProjectWorkflowRequestPayload(WorkflowRequestDataObject pDataObject, java.lang.String pAttributeGroupName, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload

Method Summary

Modifier and Type	Method and Description
void	addRecipients()
java.util.List<java.lang.String>	getApprovalComments() Returns any approval comments for this project workflow request as a list of strings.
java.util.List<EmailAttachment>	getAttachments() Returns the list of all available email attachments for this request.
java.util.List<NotifScmCommit>	getChangeLogs() Returns the SCM change logs for this project workflow request.
java.lang.String	getCreatedBy() Returns the name of the user that submitted this request.
java.sql.Timestamp	getCreatedOn() Returns the timstamp of when this request was created.
NotifEnvironment	getEnvironment() Returns the environment the request was submitted for.
NotifFlexfield	getFlexfield(java.lang.String pCode) Returns the project worflow request flexfield with the given code.
java.util.List<NotifFlexfield>	getFlexFields() Returns the list of flexfields for this project workflow request.
java.lang.Long	getId() Returns the internal identifier of the project workflow request.
java.util.List<NotifInput>	getInputs() Returns the list of inputs for this project workflow request.
NotifProject	getProject() Returns the project linked to this workflow request.
NotifProjectVersion	getProjectVersion() Returns the generated project version for this this workflow request.
NotifRelease	getRelease() Returns the release associated to this project workflow request, if applicable.
java.lang.Long	getReleaseIdSnapshotId() Returns the internal identifier of the snapshot linked to this request.
java.lang.String	getRequestCreatedByFullName() Returns the full name of the user that submitted this request ("[First Name] [Last Name]").
java.lang.String	getRequestCreatedByUserAndFullName()
java.lang.String	getRequestStartTime() Returns the requested start time for this request, if applicable.
java.lang.String	getStatus() Returns the display name of the project workflow request status.
java.lang.String	getStatusCode() Returns the type name of the project workflow request status.
RequestStatusEnum	getStatusEnum() Returns the type enum of the project workflow request status.
NotifStream	getStream() Returns the stream for this project workflow request.
java.util.List<NotifTestSuiteExecution>	getTestSuiteExecutions() Returns the test suite executions for this project workflow request.
NotifWorkflow	getWorkflow() Returns the workflow linked to this workflow request's project.
java.util.List<NotifWorkflowExecution>	getWorkflowExecutions() Returns the list of workflow executions for this project workflow request.
boolean	isBuildWorkflow() Returns whether this request is a build request.
boolean	isDeployWorkflow() Returns whether this request is a deploy request.
boolean	isForce() Returns whether "force" was selected for this request.
boolean	isStopOnPkgError() Returns whether "stop on package error" was selected for this 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, getFolderWithHierarchy, getHumanTaskIdentityUuid, 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

Constructor Detail

ProjectWorkflowRequestPayload

public ProjectWorkflowRequestPayload(WorkflowRequestDataObject pDataObject,
                                     java.lang.String pAttributeGroupName,
                                     NotificationEventTypeEnum pNotificationEventTypeEnum)

Creates the notification payload

Parameters:

pDataObject - The workflow request data.

pAttributeGroupName - The medium settings group name.

pMediumEnum - The medium type.

pNotificationEventTypeEnum - The event type.

Method Detail

addRecipients

public void addRecipients()

getId

public java.lang.Long getId()

Returns the internal identifier of the project workflow request.

Returns:

The internal identifier of the project workflow request.

getStatus

public java.lang.String getStatus()

Returns the display name of the project workflow request status.

Returns:

The display name of the project workflow request status.

getStatusCode

public java.lang.String getStatusCode()

Returns the type name of the project workflow request status.

Returns:

The type name of the project workflow request status.

getStatusEnum

public RequestStatusEnum getStatusEnum()

Returns the type enum of the project workflow request status.

Returns:

The type enum of the project workflow request status.

getProject

public NotifProject getProject()
                        throws java.sql.SQLException

Returns the project linked to this workflow request.

Returns:

The project linked to this workflow request.

Throws:

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

getProjectVersion

public NotifProjectVersion getProjectVersion()
                                      throws java.sql.SQLException

Returns the generated project version for this this workflow request.

Returns:

The generated project version for this this workflow request.

Throws:

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

getStream

public NotifStream getStream()
                      throws java.sql.SQLException

Returns the stream for this project workflow request.

Returns:

The stream for this project workflow request.

Throws:

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

getWorkflow

public NotifWorkflow getWorkflow()
                          throws java.sql.SQLException

Returns the workflow linked to this workflow request's project.

Returns:

The workflow linked to this workflow request's project.

Throws:

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

getEnvironment

public NotifEnvironment getEnvironment()

Returns the environment the request was submitted for.

Returns:

The environment the request was submitted for.

getInputs

public java.util.List<NotifInput> getInputs()
                                     throws java.sql.SQLException

Returns the list of inputs for this project workflow request.

Returns:

The list of inputs for this project workflow request.

Throws:

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

getRequestCreatedByFullName

public java.lang.String getRequestCreatedByFullName()

Returns the full name of the user that submitted this request ("[First Name] [Last Name]").

Returns:

The full name of the user that submitted this request.

getRequestCreatedByUserAndFullName

public java.lang.String getRequestCreatedByUserAndFullName()

getRequestStartTime

public java.lang.String getRequestStartTime()

Returns the requested start time for this request, if applicable.

Returns:

The requested start time for this request, if applicable.

isBuildWorkflow

public boolean isBuildWorkflow()
                        throws java.sql.SQLException

Returns whether this request is a build request.

Returns:

Whether this request is a build request.

Throws:

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

isDeployWorkflow

public boolean isDeployWorkflow()
                         throws java.sql.SQLException

Returns whether this request is a deploy request.

Returns:

Whether this request is a deploy request.

Throws:

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

getFlexFields

public java.util.List<NotifFlexfield> getFlexFields()
                                             throws java.sql.SQLException

Returns the list of flexfields for this project workflow request.

Returns:

The list of inputs for this project workflow request.

Throws:

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

getFlexfield

public NotifFlexfield getFlexfield(java.lang.String pCode)
                            throws java.sql.SQLException

Returns the project worflow request flexfield with the given code.

Parameters:

The - flexfield code.

Returns:

The project worflow request flexfield

Throws:

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

getCreatedBy

public java.lang.String getCreatedBy()

Returns the name of the user that submitted this request.

Returns:

The name of the user that submitted this request.

isForce

public boolean isForce()

Returns whether "force" was selected for this request.

Returns:

Whether "force" was selected for this request.

isStopOnPkgError

public boolean isStopOnPkgError()

Returns whether "stop on package error" was selected for this request. Applicable for partial deployment projects only.

Returns:

Whether "stop on package error" was selected for this request.

getCreatedOn

public java.sql.Timestamp getCreatedOn()

Returns the timstamp of when this request was created.

Returns:

The timstamp of when this request was created.

getReleaseIdSnapshotId

public java.lang.Long getReleaseIdSnapshotId()

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

Returns:

The internal identifier of the snapshot linked to this request.

getWorkflowExecutions

public java.util.List<NotifWorkflowExecution> getWorkflowExecutions()
                                                             throws java.sql.SQLException

Returns the list of workflow executions for this project workflow request.

Returns:

The list of workflow executions for this project workflow request.

Throws:

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

getChangeLogs

public java.util.List<NotifScmCommit> getChangeLogs()
                                             throws java.sql.SQLException

Returns the SCM change logs for this project workflow request.

Returns:

The SCM change logs for this project workflow request.

Throws:

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

getRelease

public NotifRelease getRelease()
                        throws java.sql.SQLException

Returns the release associated to this project workflow request, if applicable.

Returns:

The release associated to this project workflow request

Throws:

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

getAttachments

public java.util.List<EmailAttachment> getAttachments()
                                               throws java.sql.SQLException

Returns the list of all available email attachments for this request.

Specified by:

getAttachments in interface NotificationPayload

Overrides:

getAttachments in class BaseNotificationPayload

Returns:

The list of all available email attachments for this request.

Throws:

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

getApprovalComments

public java.util.List<java.lang.String> getApprovalComments()
                                                     throws java.sql.SQLException

Returns any approval comments for this project workflow request as a list of strings.

Returns:

Any approval comments for this project workflow request.

Throws:

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

getTestSuiteExecutions

public java.util.List<NotifTestSuiteExecution> getTestSuiteExecutions()
                                                               throws java.sql.SQLException

Returns the test suite executions for this project workflow request.

Returns:

The test suite executions for this project workflow request.

Throws:

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