ErrorCollection (Atlassian Bamboo 6.3.2 API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AboutAction, AbstractAdminRestAction, AbstractContinuableBuildAction, AbstractCreateDeploymentVersion, AbstractCreateNewJiraIssueAction, AbstractDeploymentProjectDetailsAction, AbstractDeploymentVersionAction, AbstractDeploymentVersionHistoryAction, AbstractEntityPagerSupport, AbstractJiraIssueAction, AbstractJiraRelatedAction, AbstractLinkedRepositoryAction, AbstractLinkedRepositoryAdminAction, AbstractMigrationAction, AbstractNotificationBulkAction, AbstractPermissionAction, AbstractPluginConfigurationAction, AbstractRemoteAgentAuthenticationAction, AbstractRepositoryBulkAction, AbstractSetupAction, AbstractViewCapabilitiesByType, AccessDeniedAction, AddNotificationBulkAction, AddPermissionAction, AddRemoteAgent, AddSharedLocalBuilderCapability, AddSharedLocalCapability, AddSharedRemoteCapability, AddStageAction, AdminErrorAction, AdministerAction, AdministerAuthors, AdminUpdateLicenseAction, AgentConsoleAction, AgentJsonProvider, AllBuildsRssFeedAction, AllElasticInstancesAction, AllowLicenseUpdateOrShowExpirationInfo, ArtifactUrlRedirectAction, AvailableVariablesAction, Backup, BambooActionSupport, BambooAgentInstallerAction, BambooCancellableAction, BrowseGroupsAction, BuildActionSupport, BuildConfigurationSupport, BuildExpiryAction, BuildJsonProviderAction, BuildResultsAction, BulkEditBuildPermissions, BulkPlanAction, CapabilityConfigurationSupport, ChainActionSupport, ChainResultProviderAction, ChainResultsAction, ChangeEmail, ChangeForgottenPassword, ChangePassword, CloneDeploymentProject, CloneEnvironment, ConfigurationAction, ConfigureAgentAssignments, ConfigureAgentCapability, ConfigureAgentDetails, ConfigureAgents, ConfigureAlias, ConfigureArtifactHandlers, ConfigureArtifactStorage, ConfigureArtifactSubscription, ConfigureBranches, ConfigureBuildArtifact, ConfigureBuildDetails, ConfigureBuildMiscellaneousOptions, ConfigureBuildNotification, ConfigureBuildPermissions, ConfigureBuildRequirement, ConfigureBuildTasks, ConfigureCapability, ConfigureCapabilityKey, ConfigureChainBranchRepositories, ConfigureChainNotification, ConfigureChainRepositories, ConfigureChainTrigger, ConfigureChainTriggers, ConfigureCloverPlugin, ConfigureConcurrentBuilds, ConfigureDeploymentProject, ConfigureDeploymentProjectDetails, ConfigureDeploymentProjectPermissions, ConfigureDeploymentProjectSpecsRepositories, ConfigureDeploymentProjectVersioning, ConfigureElasticCapability, ConfigureElasticCloudAction, ConfigureElasticImageConfiguration, ConfigureElasticImageConfigurationAssignments, ConfigureElasticInstanceSchedule, ConfigureElasticInstanceSchedules, ConfigureEnvironment, ConfigureEnvironmentAgents, ConfigureEnvironmentNotifications, ConfigureEnvironmentPermissions, ConfigureEnvironmentTasks, ConfigureEnvironmentTriggers, ConfigureGlobalBuildHangingDetection, ConfigureGlobalPermissions, ConfigureGlobalVariables, ConfigureGroup, ConfigureInstantMessagingServer, ConfigureLinkedRepositories, ConfigureLocalAgentDetails, ConfigureLog4jAction, ConfigureMailServer, ConfigureNotificationPreferences, ConfigurePerforceManager, ConfigurePlanDependencies, ConfigurePlanVariables, ConfigureProfile, ConfigureQuickFilterAction, ConfigureQuickFiltersAction, ConfigureRemoteAgentAuthentications, ConfigureRepository, ConfigureSecurity, ConfigureSharedCapability, ConfigureSharedCredentials, ConfigureSharedLocalCapability, ConfigureSharedRemoteCapability, ConfigureSpotInstancesAction, ConfigureSystemNotifications, ConfigureUser, ConfigureVariablesForEnvironment, ContinueBuild, ControlRemoteAgentsAuthentication, ControlRemoteAgentsAvailability, ControlRemoteAgentsTokenVerification, ConvertLocalToGlobalRepository, CreateChain, CreateChainBranch, CreateChainTrigger, CreateDeploymentProjectDetails, CreateDeploymentVersion, CreateEnvironment, CreateEnvironmentTask, CreateEnvironmentTrigger, CreateGlobalVariable, CreateInstantMessagingServer, CreateJob, CreateLinkedRepository, CreateNewJiraIssueForBuildResultAction, CreateNewJiraIssueForTestAction, CreatePlanVariable, CreateProject, CreateRemoteJiraLinkAction, CreateRepository, CreateSharedCredentials, CreateTask, CreateTasksChainWizard, CreateTasksJobWizard, CreateVariableForEnvironment, CronExpressionGeneratorAction, CvsBulkAction, DashboardFilter, DashboardSummaryAction, DeleteAllNotificationBulkAction, DeleteBuildFiles, DeleteBuilds, DeleteChainAuditLog, DeleteChainTrigger, DeleteDeploymentProject, DeleteDeploymentResult, DeleteDeploymentVersion, DeleteEnvironment, DeleteEnvironmentTask, DeleteEnvironmentTrigger, DeleteGitCacheDirectoryAction, DeleteGlobalVariable, DeleteHgCacheDirectory, DeleteLinkedRepository, DeletePlan, DeletePlanResults, DeletePlanVariable, DeleteRepository, DeleteSharedCredentials, DeleteStageAction, DeleteTask, DeleteVariableForEnvironment, DescribeAgentAvailability, DescribeAgentAvailability, DetectBranches, DisablePlanBulkAction, EditAgentCapability, EditChainBranchDetails, EditChainBranchNotifications, EditChainBranchRepository, EditChainDetails, EditChainTrigger, EditCommentAction, EditDeploymentVersionCommentAction, EditElasticCapability, EditEnvironmentTask, EditEnvironmentTrigger, EditJiraIssues, EditLabelsAction, EditLinkedRepository, EditPlanPermissions, EditProjectDetails, EditProjectPermissions, EditProjectRepositories, EditQuickFilterRuleAction, EditRemoteAgentAuthenticationIp, EditRepository, EditSharedCapability, EditSharedCredentials, EditTask, EnablePlanBulkAction, ErrorAction, ErrorEventsAction, ExecuteManualDeployment, ExecuteRenameAgentCapability, Export, FilterCookieWriterAction, FinishSetupAction, FiveOhOh, ForgotPassword, GetFingerprintAction, GetJiraIssueSchemaAction, GetPkFileAction, GlobalAdminAction, GlobalTrackingConfiguration, GotoAuthors, GotoBuildResult, Import, ImportMavenPlanAction, ImportMavenPlanCheckoutPomAction, ImportMavenPlanCreatePlanAction, JiraRedirectAction, LabelRssFeedAction, LinkTestToJiraIssueAction, ListBuildResults, ListChainResults, ListJobsForChain, ListProjects, ListRunningInstances, LoadGitHubRepositories, Login, Login, Logout, Logout, LogToServer, ManageElasticInstancesAction, ManualBuildBulkAction, MoveBuilds, MoveEnvironment, MoveEnvironmentTask, MoveJobAction, MoveRepository, MoveStageAction, MoveTask, ParameterisedManualBuild, PerformanceStatsAction, PerformanceStatsJmxAction, PlanActionSupport, PlanResultsAction, PlanStatusHistoryAction, Profile, ProjectActionSupport, QuarantineSettingsAction, QuickFilterAction, ReindexAction, RemoveAdminErrorAction, RemoveBuildArtifacts, RemoveBuildError, RenameAgentCapability, RenameDeploymentVersion, ReorderBuild, ReplaceTriggersAction, ReplaceTriggersBulkAction, RepositorySettingsAction, RerunBuild, ResetChainBranchRepository, ResponsibleAvatars, RestartBuild, RssFeedAction, SearchUserAction, SelectAgentsAction, SelectBuildConfigurationTab, SelectSetupStepAction, SetAgentBuildFilter, SetFavouriteAction, SetResultsFilter, SetupAdminUserAction, SetupDatabaseAction, SetupDatabaseConnectionAction, SetupDefaultsAction, SetupEmbeddedDatabaseAction, SetupGeneralConfiguration, SetupImportDataAction, SetupLicenseAction, SetupUpdateLicenseAction, ShowLatestBuildStatus, SignupUser, SimpleErrorCollection, SimpleErrorCollectionInternal, StageAction, StartElasticAgents, StarterAction, StopAllElasticAgents, StopDeployment, StopElasticAgents, StopPlan, SuspendBuild, SvnBulkAction, SystemErrorList, SystemInfoAction, TestOgnlEscaping, ToggleArtifactDefinitionSharing, TransitionJiraIssueAction, TriggerManualBuild, TriggerRemoteBuild, TrustedKeysAction, UnlinkTestToJiraIssueAction, UpdateCvsModuleBulkAction, UpdateCvsRootCredentialsBulkAction, UpdateDefaultsLocalCapability, UpdateGlobalVariable, UpdateLicenseAction, UpdatePlanVariable, UpdateResponsibilitiesAction, UpdateSvnCredentialsBulkAction, UpdateSvnUrlBulkAction, UpdateTaskState, UpdateVariableForEnvironment, UpdateWebUrlBulkAction, UserManagement, UserPickerAction, ViewActivityLog, ViewAdministrators, ViewAgent, ViewAgentAdmin, ViewAgentDetails, ViewAgentDetailsAction, ViewAgentPlanMatrix, ViewAgentPlanMatrixWizard, ViewAgentRecentBuildsSummary, ViewAgents, ViewAggregatedAuthors, ViewAggregatedJobPlugins, ViewAllDeploymentProjects, ViewAllRepositories, ViewAuthor, ViewAuthorChart, ViewAuthors, ViewAuthors, ViewBambooInternals, ViewBuild, ViewBuildError, ViewBuilders, ViewBuildFiles, ViewBuildLogs, ViewBuildNumberChart, ViewBuildResults, ViewBuildResultsByJiraKey, ViewBuildResultsForLabelAction, ViewBuildResultsSuccessfulTests, ViewBuildResultsTable, ViewBuildResultsTableByPlans, ViewBuildResultsTests, ViewBuildTaskTypes, ViewChainArtifacts, ViewChainAuditLog, ViewChainBranches, ViewChainLogs, ViewChainResult, ViewChainSummary, ViewChainTestResults, ViewCloverBuildResults, ViewCloverCoverageSummary, ViewCombinedByTimePeriodChart, ViewDatabaseConfigurationAction, ViewDeploymentProjects, ViewDeploymentProjectSpecs, ViewDeploymentProjectYaml, ViewDeploymentResult, ViewDeploymentVersion, ViewDeploymentVersionCommits, ViewDeploymentVersionJiraIssues, ViewDeploymentVersionVariables, ViewElasticAgentHistoryAction, ViewElasticInstanceAction, ViewEnvironment, ViewEnvironmentTaskTypes, ViewGadgetUrls, ViewGlobalAuditLogAction, ViewInstancesForConfigurationAction, ViewJdks, ViewJiraIssueForPlan, ViewJiraIssues, ViewLabels, ViewLinkedRepository, ViewLog4jAction, ViewMaven2ChainSummary, ViewNextBuildResults, ViewOfflineAgents, ViewOfflineElasticAgentDetailsAction, ViewOfflineElasticAgentDetailsAdminAction, ViewPlanConfiguration, ViewPlanSpecs, ViewPlanStatusByJiraKey, ViewPlanUpdates, ViewPlanYaml, ViewPreviousBuildResults, ViewProject, ViewQuarantinedTests, ViewRejectedRequirements, ViewRemoteAgentAuthentications, ViewReport, ViewReportChart, ViewResponsibilitiesForUser, ViewRunningPlans, ViewTelemetryAction, ViewTestCaseAction, ViewTestCaseResultAction, ViewTestClassResultAction, ViewTestsSummary, ViewTestsSummaryForPlan, ViewTrackingForBuildResult, ViewUserSummary
```
public interface ErrorCollection
extends Serializable
```
A very simple interface to collect errors. This is typically used during form validation for collecting field validation errors (use addError(String, String)), and general errors (addErrorMessage(String)) that aren't field-specific (eg. permission problems).

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addError(String field, String message)` Add a field-specific error message.
`void`	`addError(String prefix, String field, String message)` Adds a new form validation error with a given prefix.
`void`	`addErrorCollection(ErrorCollection errors)` Populate this ErrorCollection with general and field-specific errors.
`String`	`addErrorMessage(String message)` Add error message relating to system state (not field-specific).
`String`	`addErrorMessage(String message, Exception e)`
`void`	`addErrorMessages(Collection<String> errorMessages)` Append new error messages to those already collected.
`void`	`addErrors(Map<String,?> errors)` Deprecated. since 5.1 use `addFieldErrors(java.util.Map)` instead
`void`	`addFieldErrors(Map<String,List<String>> errors)` Append new field-specific errors to those already collected.
`default List<String>`	`getAllErrorMessages()` Get all error messages from this error collection.
`Collection<String>`	`getErrorMessages()` Get all non field-specific error messages.
`Map<String,List<String>>`	`getErrors()` Get all field-specific errors.
`Map<String,List<String>>`	`getFieldErrors()`
`Collection<String>`	`getFlushedErrorMessages()` Get error messages, then get rid of them.
`int`	`getTotalErrors()`
`boolean`	`hasAnyErrors()` Whether any errors (of any type - field-specific or otherwise) have been collected.
`void`	`setErrorMessages(Collection<String> errorMessages)` Populate this ErrorCollection with a new set of messages (existing errors are lost).

- Method Detail
  - addError
```
void addError(String field,
              String message)
```
    Add a field-specific error message.
    
    Parameters:
    
    field - Field name, eg. "assignee"
    
    message - Error message.
  - addError
```
void addError(String prefix,
              String field,
              String message)
```
    Adds a new form validation error with a given prefix. ie. prefix of "builder.ant" and field "target" will result in a key of "builder.ant.target"
    
    Parameters:
    
    prefix - The prefix of the field in . form
    
    field - The id of the form element in error
    
    message - The error message to display to the user
  - addErrorMessage
```
String addErrorMessage(String message)
```
    Add error message relating to system state (not field-specific).
    
    Parameters:
    
    message - Error message.
  - addErrorMessage
```
String addErrorMessage(String message,
                       Exception e)
```
  - getErrorMessages
```
Collection<String> getErrorMessages()
```
    Get all non field-specific error messages.
    
    Returns:
    
    Collection of error Strings.
  - setErrorMessages
```
void setErrorMessages(Collection<String> errorMessages)
```
    Populate this ErrorCollection with a new set of messages (existing errors are lost).
    
    Parameters:
    
    errorMessages - List of error message Strings.
  - getFlushedErrorMessages
```
Collection<String> getFlushedErrorMessages()
```
    Get error messages, then get rid of them.
    
    Returns:
    
    The (now cleared) error messages.
  - getErrors
```
Map<String,List<String>> getErrors()
```
    Get all field-specific errors.
    
    Returns:
    
    Map of String: String pairs, eg. {"assignee": "Assignee is required"}
  - addErrorCollection
```
void addErrorCollection(@NotNull
                        ErrorCollection errors)
```
    Populate this ErrorCollection with general and field-specific errors.
    
    Parameters:
    
    errors - ErrorCollection whose errors/messages we obtain.
  - addErrorMessages
```
void addErrorMessages(Collection<String> errorMessages)
```
    Append new error messages to those already collected.
    
    Parameters:
    
    errorMessages - Collection of error strings.
  - addErrors
```
@Deprecated
void addErrors(Map<String,?> errors)
```
    Deprecated. since 5.1 use addFieldErrors(java.util.Map) instead
    
    Append new field-specific errors to those already collected.
    
    Parameters:
    
    errors - A Map from String field names, to String error messages, or Collections of String error messages.
  - addFieldErrors
```
void addFieldErrors(Map<String,List<String>> errors)
```
    Append new field-specific errors to those already collected.
    
    Parameters:
    
    errors - A Map from String field names, to String error messages, or Collections of String error messages.
  - hasAnyErrors
```
boolean hasAnyErrors()
```
    Whether any errors (of any type - field-specific or otherwise) have been collected.
    
    Returns:
    
    true if there are errors; false otherwise.
  - getFieldErrors
```
Map<String,List<String>> getFieldErrors()
```
  - getTotalErrors
```
int getTotalErrors()
```
  - getAllErrorMessages
```
@NotNull
default List<String> getAllErrorMessages()
```
    Get all error messages from this error collection. Includes error messages and field errors. Field names are skipped.

Interface ErrorCollection

Method Summary

Method Detail

addError

addError

addErrorMessage

addErrorMessage

getErrorMessages

setErrorMessages

getFlushedErrorMessages

getErrors

addErrorCollection

addErrorMessages

addErrors

addFieldErrors

hasAnyErrors

getFieldErrors

getTotalErrors

getAllErrorMessages