flexagon.fd.model2.notification.payload

Class NotifApplicationRequest

java.lang.Object

BasePOJO

flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

flexagon.fd.model2.notification.payload.NotifApplicationRequest

All Implemented Interfaces:

NotificationPayload

public class NotifApplicationRequest
extends AbstractNotifBaseRequest

Notification Template payload representing a application request.

Field Summary

Fields inherited from class flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

mAttributeGroupName, mNotificationEventTypeEnum, mNotificationMediumEnum, mPipelineAttachments, mPipelineNotes

Fields inherited from interface flexagon.fd.model2.notification.payload.NotificationPayload

DATE_FORMAT

Constructor Summary

Constructors

Constructor and Description
NotifApplicationRequest(FolderRequestDataObject pFolderDataObject, java.lang.String pAttributeGroupName, NotificationMediumEnum pMediumEnum, NotificationEventTypeEnum pNotificationEventTypeEnum) Creates the notification payload

Method Summary

Modifier and Type	Method and Description
void	addRecipients()
NotifFolder	getApplication() Returns the linked application for this application request.
NotifFolderVersion	getApplicationVersion() Returns the generated version for this request.
java.lang.String	getApplicationWorkflowType() Returns the type name of the request (i.e.
java.lang.String	getApplicationWorkflowTypeCode() Returns the display name of the request type (i.e.
Project.ProjectWFTypeEnum	getApplicationWorkflowTypeEnum() Returns the type enum of the request (i.e.
java.util.List<java.lang.String>	getApprovalComments() Returns any approval comments for this application request as a list of strings.
java.util.List<EmailAttachment>	getAttachments() Returns a list of email attachments pertaining to the event which has occurred.
java.lang.String	getCreatedBy() Returns the name of the user that submitted this request.
java.sql.Timestamp	getCreatedOn() Returns the timestamp of when this request was submitted.
NotifEnvironment	getEnvironment() Returns the environment the request was submitted for.
java.lang.Long	getId() Returns the internal identifier of the application request.
java.lang.String	getRequestCreatedByFullName() Returns the full name of the user that submitted this request ("[First Name] [Last Name]").
java.lang.String	getRequestStartTime() Returns the requested start time for this request, if applicable.
java.lang.String	getStatus() Returns the display name of the application request status (e.g.
java.lang.String	getStatusCode() Returns the type name of the application request status (e.g.
RequestStatusEnum	getStatusEnum() Returns the type enum of the application request status (e.g.

Methods inherited from class flexagon.fd.model2.notification.payload.AbstractNotifBaseRequest

addAttachment, addAttachment, addAttachment, addAttachment, addRecipientsByCommittersIfEligible, addRecipientsByGroupId, addRecipientsByGroupNameIfEligible, addRecipientsByPipelineRoleMember, addRecipientsByPipelineRoleUserOrEmailMember, addRecipientsBySubscriptions, addRecipientsByUserNameIfEligible, addRecipientsForPiplelineGate, addRecipientsForPiplelineStepExecution, getApprovalGateRoleByGateId, getApprovalTaskUrlPath, getFolderWithHierarchy, getHumanTaskIdentityUuid, getHumanTaskUrlPath, getManualStepRoleByStepId, getPipelineStageExecutionSnapshotQueryResultRow, getRecipients, getUserFullName, hasAttachments, isGroupMemberOfPipelineRole, isSendLogAttachments, isShowNotesAndSendAttachments, populatePipelineAttachmentsAndNotes, sendLogAttachments, showNotesAndSendAttachments, showTextForMissingUrlSetup, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NotifApplicationRequest

public NotifApplicationRequest(FolderRequestDataObject pFolderDataObject,
                               java.lang.String pAttributeGroupName,
                               NotificationMediumEnum pMediumEnum,
                               NotificationEventTypeEnum pNotificationEventTypeEnum)

Creates the notification payload

Parameters:

pFolderDataObject - The application 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 application request.

Returns:

The internal identifier of the application request.

getApplicationWorkflowTypeCode

public java.lang.String getApplicationWorkflowTypeCode()

Returns the display name of the request type (i.e. BUILD, DEPLOY)

Returns:

The display name of the request type.

getApplicationWorkflowTypeEnum

public Project.ProjectWFTypeEnum getApplicationWorkflowTypeEnum()

Returns the type enum of the request (i.e. BUILD, DEPLOY)

Returns:

The type enum of the request.

getApplicationWorkflowType

public java.lang.String getApplicationWorkflowType()

Returns the type name of the request (i.e. BUILD, DEPLOY, etc.)

Returns:

The type name of the request.

getEnvironment

public NotifEnvironment getEnvironment()

Returns the environment the request was submitted for.

Returns:

The environment the request was submitted for.

getStatus

public java.lang.String getStatus()

Returns the display name of the application request status (e.g. Completed, Failed).

Returns:

The display name of the application request status.

getStatusCode

public java.lang.String getStatusCode()

Returns the type name of the application request status (e.g. COMPLETED, FAILED).

Returns:

The type name of the application request status.

getStatusEnum

public RequestStatusEnum getStatusEnum()

Returns the type enum of the application request status (e.g. COMPLETED, FAILED).

Returns:

The type enum of the application request status.

getApplication

public NotifFolder getApplication()

Returns the linked application for this application request.

Returns:

The linked application for this application request.

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.

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.

getCreatedOn

public java.sql.Timestamp getCreatedOn()

Returns the timestamp of when this request was submitted.

Returns:

The timestamp of when this request was submitted.

getApplicationVersion

public NotifFolderVersion getApplicationVersion()
                                         throws java.sql.SQLException

Returns the generated version for this request.

Returns:

The generated version for this 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

Description copied from interface: NotificationPayload

Returns a list of email attachments pertaining to the event which has occurred.

Specified by:

getAttachments in interface NotificationPayload

Overrides:

getAttachments in class AbstractNotifBaseRequest

Returns:

A list of email attachements.

Throws:

java.sql.SQLException

getApprovalComments

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

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

Returns:

Any approval comments for this application request.

Throws:

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

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.