public class ProjectWorkflowRequestPayload extends BaseNotificationPayload
mNotificationEventTypeEnum, mPipelineAttachments, mPipelineNotes
DATE_FORMAT
Constructor and Description |
---|
ProjectWorkflowRequestPayload(WorkflowRequestDataObject pDataObject,
NotificationEventTypeEnum pNotificationEventTypeEnum)
Creates the notification payload
|
Modifier and Type | Method and Description |
---|---|
void |
addRecipients(java.lang.String pAttributeGroupName) |
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.
|
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
public ProjectWorkflowRequestPayload(WorkflowRequestDataObject pDataObject, NotificationEventTypeEnum pNotificationEventTypeEnum)
pDataObject
- The workflow request data.pAttributeGroupName
- The medium settings group name.pMediumEnum
- The medium type.pNotificationEventTypeEnum
- The event type.public void addRecipients(java.lang.String pAttributeGroupName)
public java.lang.Long getId()
public java.lang.String getStatus()
public java.lang.String getStatusCode()
public RequestStatusEnum getStatusEnum()
public NotifProject getProject() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifProjectVersion getProjectVersion() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifStream getStream() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifWorkflow getWorkflow() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifEnvironment getEnvironment()
public java.util.List<NotifInput> getInputs() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.lang.String getRequestCreatedByFullName()
public java.lang.String getRequestCreatedByUserAndFullName()
public java.lang.String getRequestStartTime()
public boolean isBuildWorkflow() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public boolean isDeployWorkflow() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.util.List<NotifFlexfield> getFlexFields() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifFlexfield getFlexfield(java.lang.String pCode) throws java.sql.SQLException
The
- flexfield code.java.sql.SQLException
- If the information cannot be retrieved from the database.public java.lang.String getCreatedBy()
public boolean isForce()
public boolean isStopOnPkgError()
public java.sql.Timestamp getCreatedOn()
public java.lang.Long getReleaseIdSnapshotId()
public java.util.List<NotifWorkflowExecution> getWorkflowExecutions() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.util.List<NotifScmCommit> getChangeLogs() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public NotifRelease getRelease() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.util.List<EmailAttachment> getAttachments() throws java.sql.SQLException
getAttachments
in interface NotificationPayload
getAttachments
in class BaseNotificationPayload
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.util.List<java.lang.String> getApprovalComments() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.public java.util.List<NotifTestSuiteExecution> getTestSuiteExecutions() throws java.sql.SQLException
java.sql.SQLException
- If the information cannot be retrieved from the database.