Summary: Methods | [Expand All]
@PublicApi public interface

ServiceResult

com.atlassian.jira.bc.ServiceResult
Known Indirect Subclasses

@PublicApi

This interface is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

This interface defines a service method call result in JIRA that can contain human readable errors. New service methods should prefer the generic ServiceOutcome.

See Also

Summary

Public Methods
ErrorCollection getErrorCollection()
WarningCollection getWarningCollection()
boolean hasWarnings()
boolean isValid()

Public Methods

public ErrorCollection getErrorCollection ()

Returns
  • an ErrorCollection that contains any errors that may have happened as a result of the validations.

public WarningCollection getWarningCollection ()

Returns
  • an WarningCollection that contains all warnings that may have happened as a result of the validation.

public boolean hasWarnings ()

public boolean isValid ()

Returns
  • true if there are no errors, false otherwise.