flexagon.fd.model2.notification.functions

Class NotificationFunctions

java.lang.Object

flexagon.fd.model2.notification.functions.NotificationFunctions

public class NotificationFunctions
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NotificationFunctions()

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatDateTime(java.sql.Timestamp pTimestamp) Returns date in format dd MMM, yyyy HH:mm a z
java.util.List<NotifEnvironment>	getActiveBuildEnvironments() Returns list of all active build environments
java.util.List<NotifEnvironment>	getActiveEnvironments() Returns list of all active environments
java.util.List<NotifEnvironment>	getAllEnvironments() Returns list of all environments in topology
java.util.List<NotifEnvironment>	getBuildEnvironments() Returns list of all build environments
java.lang.String	getDescriptionForInputField(InputField pInputField)
java.lang.String	getEmailApprovalByReplySection(NotificationPayload pPayload) This method is used to generate the Approval reply links for an event to attach to the event template
java.lang.String	getEmailApprovalByReplySectionForManualStep(NotificationPayload pPayload)
NotifEnvironment	getEnvironmentByCode(java.lang.String pEnvironmentCode) Returns environment object for environment with supplied code, or null if environment is not found
NotifEnvironment	getEnvironmentById(java.lang.Long pEnvironmentId) Returns environment object for environment with supplied id, or null if environment is not found
java.lang.String	getFlexDeployBaseUrl() Returns base FlexDeploy URL as configured in system settings
java.util.List<NotifProjectState>	getFullDeployProjectEnvironmentState(NotifProjectVersion pProjectVersion, java.lang.Long pProjectId, java.lang.Long pEnvironmentId, NotifPipelineStageExecInfo pNotifPipelineStageExecInfo) Gets the current project state for a particular full deploy project version and environment
NotifInstance	getInstanceByCode(java.lang.String pInstanceCode) Returns instance object for instance with supplied code, or null if instance is not found
NotifInstance	getInstanceById(java.lang.Long pInstanceId) Returns instance object for instance with supplied id, or null if instance is not found
java.util.List<NotifProjectState>	getPartialDeployProjectEnvironmentState(NotifProjectVersion pProjectVersion, java.lang.Long pProjectId, java.lang.Long pEnvironmentId, NotifPipelineStageExecInfo pNotifPipelineStageExecInfo) Gets the current project state for a particular partial deploy project version and environment
boolean	isAttachLogsAlways() Returns true if the Attach Logs system setting is set to Always
boolean	isAttachLogsNever() Returns true if the Attach Logs system setting is set to Never
boolean	isAttachLogsOnFailure() Returns true if the Attach Logs system setting is set to On Failure

Methods inherited from class java.lang.Object

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

Constructor Detail

NotificationFunctions

public NotificationFunctions()

Method Detail

getEmailApprovalByReplySection

public java.lang.String getEmailApprovalByReplySection(NotificationPayload pPayload)

This method is used to generate the Approval reply links for an event to attach to the event template

Parameters:

pPayload - Notification payload

Returns:

HTML for email approval links section

getEmailApprovalByReplySectionForManualStep

public java.lang.String getEmailApprovalByReplySectionForManualStep(NotificationPayload pPayload)
                                                             throws java.sql.SQLException

Throws:

java.sql.SQLException

getDescriptionForInputField

public java.lang.String getDescriptionForInputField(InputField pInputField)

getPartialDeployProjectEnvironmentState

public java.util.List<NotifProjectState> getPartialDeployProjectEnvironmentState(NotifProjectVersion pProjectVersion,
                                                                                 java.lang.Long pProjectId,
                                                                                 java.lang.Long pEnvironmentId,
                                                                                 NotifPipelineStageExecInfo pNotifPipelineStageExecInfo)
                                                                          throws java.sql.SQLException

Gets the current project state for a particular partial deploy project version and environment

Throws:

java.sql.SQLException

getFullDeployProjectEnvironmentState

public java.util.List<NotifProjectState> getFullDeployProjectEnvironmentState(NotifProjectVersion pProjectVersion,
                                                                              java.lang.Long pProjectId,
                                                                              java.lang.Long pEnvironmentId,
                                                                              NotifPipelineStageExecInfo pNotifPipelineStageExecInfo)
                                                                       throws java.sql.SQLException

Gets the current project state for a particular full deploy project version and environment

Throws:

java.sql.SQLException

formatDateTime

public java.lang.String formatDateTime(java.sql.Timestamp pTimestamp)

Returns date in format dd MMM, yyyy HH:mm a z

getFlexDeployBaseUrl

public java.lang.String getFlexDeployBaseUrl()

Returns base FlexDeploy URL as configured in system settings

getAllEnvironments

public java.util.List<NotifEnvironment> getAllEnvironments()

Returns list of all environments in topology

getEnvironmentById

public NotifEnvironment getEnvironmentById(java.lang.Long pEnvironmentId)

Returns environment object for environment with supplied id, or null if environment is not found

getEnvironmentByCode

public NotifEnvironment getEnvironmentByCode(java.lang.String pEnvironmentCode)

Returns environment object for environment with supplied code, or null if environment is not found

getBuildEnvironments

public java.util.List<NotifEnvironment> getBuildEnvironments()

Returns list of all build environments

getActiveEnvironments

public java.util.List<NotifEnvironment> getActiveEnvironments()

Returns list of all active environments

getActiveBuildEnvironments

public java.util.List<NotifEnvironment> getActiveBuildEnvironments()

Returns list of all active build environments

getInstanceById

public NotifInstance getInstanceById(java.lang.Long pInstanceId)

Returns instance object for instance with supplied id, or null if instance is not found

getInstanceByCode

public NotifInstance getInstanceByCode(java.lang.String pInstanceCode)

Returns instance object for instance with supplied code, or null if instance is not found

isAttachLogsAlways

public boolean isAttachLogsAlways()

Returns true if the Attach Logs system setting is set to Always

isAttachLogsOnFailure

public boolean isAttachLogsOnFailure()

Returns true if the Attach Logs system setting is set to On Failure

isAttachLogsNever

public boolean isAttachLogsNever()

Returns true if the Attach Logs system setting is set to Never