Package 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, Serializable
public class ProjectWorkflowRequestPayload extends BaseNotificationPayload
Notification Template payload representing a project workflow request.
See Also:

  • Constructor Details

    • ProjectWorkflowRequestPayload

      public ProjectWorkflowRequestPayload(WorkflowRequestDataObject pDataObject, 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 Details

    • addRecipients

      public void addRecipients(String pAttributeGroupName)

    • getId

      public Long getId()
      Returns the internal identifier of the project workflow request.
      Returns:
      The internal identifier of the project workflow request.

    • getStatus

      public String getStatus()
      Returns the display name of the project workflow request status.
      Returns:
      The display name of the project workflow request status.

    • getStatusCode

      public 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 SQLException
      Returns the project linked to this workflow request.
      Returns:
      The project linked to this workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getProjectVersion

      public NotifProjectVersion getProjectVersion() throws SQLException
      Returns the generated project version for this this workflow request.
      Returns:
      The generated project version for this this workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getStream

      public NotifStream getStream() throws SQLException
      Returns the stream for this project workflow request.
      Returns:
      The stream for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getWorkflow

      public NotifWorkflow getWorkflow() throws SQLException
      Returns the workflow linked to this workflow request's project.
      Returns:
      The workflow linked to this workflow request's project.
      Throws:
      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 List<NotifInput> getInputs() throws SQLException
      Returns the list of inputs for this project workflow request.
      Returns:
      The list of inputs for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getRequestCreatedByFullName

      public 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 String getRequestCreatedByUserAndFullName()

    • getRequestStartTime

      public 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 SQLException
      Returns whether this request is a build request.
      Returns:
      Whether this request is a build request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • isDeployWorkflow

      public boolean isDeployWorkflow() throws SQLException
      Returns whether this request is a deploy request.
      Returns:
      Whether this request is a deploy request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getFlexFields

      public List<NotifFlexfield> getFlexFields() throws SQLException
      Returns the list of flexfields for this project workflow request.
      Returns:
      The list of inputs for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getFlexfield

      public NotifFlexfield getFlexfield(String pCode) throws SQLException
      Returns the project worflow request flexfield with the given code.
      Parameters:
      The - flexfield code.
      Returns:
      The project worflow request flexfield
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getCreatedBy

      public 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 Timestamp getCreatedOn()
      Returns the timstamp of when this request was created.
      Returns:
      The timstamp of when this request was created.

    • getReleaseIdSnapshotId

      public 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 List<NotifWorkflowExecution> getWorkflowExecutions() throws SQLException
      Returns the list of workflow executions for this project workflow request.
      Returns:
      The list of workflow executions for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getChangeLogs

      public List<NotifScmCommit> getChangeLogs() throws SQLException
      Returns the SCM change logs for this project workflow request.
      Returns:
      The SCM change logs for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getRelease

      public NotifRelease getRelease() throws SQLException
      Returns the release associated to this project workflow request, if applicable.
      Returns:
      The release associated to this project workflow request
      Throws:
      SQLException - If the information cannot be retrieved from the database.

    • getAttachments

      public List<EmailAttachment> getAttachments() throws 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:
      SQLException - If the information cannot be retrieved from the database.

    • getApprovalComments

      public List<String> getApprovalComments() throws 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:
      SQLException - If the information cannot be retrieved from the database.

    • getTestSuiteExecutions

      public List<NotifTestSuiteExecution> getTestSuiteExecutions() throws SQLException
      Returns the test suite executions for this project workflow request.
      Returns:
      The test suite executions for this project workflow request.
      Throws:
      SQLException - If the information cannot be retrieved from the database.