IStatus (org.eclipse.osbp.runtime.feature.e4eventmanager 0.9.0-SNAPSHOT API)

All Known Implementing Classes:

Status
```
public interface IStatus
```
The status defines the current state of a process. It may be used for different usecases. For instance for validations, to determine veto before calling a process, to visualize thrown exceptions,... It is a general implementation.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class IStatus.Severity
The severity of the status.

Nested Classes
Modifier and Type	Interface and Description
`static class`	`IStatus.Severity` The severity of the status.

Field Summary

Fields
Modifier and Type	Field and Description
`static IStatus`	`CANCEL` A constant for cancel status.
`static IStatus`	`ERROR` A constant for error status.
`static IStatus`	`OK` A constant for ok status.
`static String`	`PROP_CREATOR` Class that created the message.
`static String`	`PROP_FIELD_I18N_KEY` I18nKey of the field.
`static String`	`PROP_FIELD_ID` The id of the field.
`static String`	`PROP_JAVAX_CONSTRAINT` javax constraint if created by bean validation.
`static String`	`PROP_JAVAX_LEAF_BEAN` leaf bean if created by bean validation.
`static String`	`PROP_JAVAX_PROPERTY_PATH` property path if created by bean validation.
`static String`	`PROP_UI_APPLICATION_ID` The id of the affected application.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`containsProperty(String key)` Returns true, if a property exists.
`String`	`getBundleSymblicName()` Returns symbolic name of the bundle that has created the status.
`String`	`getCode()` Returns the status code.
`Exception`	`getException()` Returns the exception of the status.
`String`	`getId()` Returns the id of the status.
`String`	`getMessage()` Returns the message of the status.
`Object`	`getProperty(String key)` Returns the value of the property.
`IStatus.Severity`	`getSeverity()` Returns the severity of the status.
`boolean`	`isCancel()` Returns true, if the status is `IStatus.Severity.CANCEL`.
`boolean`	`isError()` Returns true, if the status is `IStatus.Severity.ERROR`.
`boolean`	`isInfo()` Returns true, if the status is `IStatus.Severity.INFO`.
`boolean`	`isOK()` Returns true, if the status is `IStatus.Severity.OK` or `IStatus.Severity.INFO`.
`boolean`	`isWarning()` Returns true, if the status is `IStatus.Severity.WARNING`.
`void`	`putProperty(String key, Object value)` Puts a property into the status.

- Field Detail
  - OK
```
static final IStatus OK
```
    A constant for ok status.
  - CANCEL
```
static final IStatus CANCEL
```
    A constant for cancel status.
  - ERROR
```
static final IStatus ERROR
```
    A constant for error status.
  - PROP_UI_APPLICATION_ID
```
static final String PROP_UI_APPLICATION_ID
```
    The id of the affected application.
    
    See Also:
    
    Constant Field Values
  - PROP_FIELD_ID
```
static final String PROP_FIELD_ID
```
    The id of the field.
    
    See Also:
    
    Constant Field Values
  - PROP_FIELD_I18N_KEY
```
static final String PROP_FIELD_I18N_KEY
```
    I18nKey of the field.
    
    See Also:
    
    Constant Field Values
  - PROP_JAVAX_CONSTRAINT
```
static final String PROP_JAVAX_CONSTRAINT
```
    javax constraint if created by bean validation.
    
    See Also:
    
    Constant Field Values
  - PROP_JAVAX_LEAF_BEAN
```
static final String PROP_JAVAX_LEAF_BEAN
```
    leaf bean if created by bean validation.
    
    See Also:
    
    Constant Field Values
  - PROP_JAVAX_PROPERTY_PATH
```
static final String PROP_JAVAX_PROPERTY_PATH
```
    property path if created by bean validation.
    
    See Also:
    
    Constant Field Values
  - PROP_CREATOR
```
static final String PROP_CREATOR
```
    Class that created the message.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getId
```
String getId()
```
    Returns the id of the status. It is prepared by the pattern {bundleSymbolicName}.{code}. So every bundle may specify its own codes.
    
    Returns:
    
    the id
  - getCode
```
String getCode()
```
    Returns the status code. The code specifies the unique id of a status message in a bundle.
    
    Returns:
    
    the code
  - getBundleSymblicName
```
String getBundleSymblicName()
```
    Returns symbolic name of the bundle that has created the status.
    
    Returns:
    
    the bundle symblic name
  - getSeverity
```
IStatus.Severity getSeverity()
```
    Returns the severity of the status.
    
    Returns:
    
    the severity
  - getMessage
```
String getMessage()
```
    Returns the message of the status. May be null.
    
    Returns:
    
    the message
  - getException
```
Exception getException()
```
    Returns the exception of the status. May be null.
    
    Returns:
    
    the exception
  - isOK
```
boolean isOK()
```
    Returns true, if the status is IStatus.Severity.OK or IStatus.Severity.INFO.
    
    Returns:
    
    true, if is ok
  - isInfo
```
boolean isInfo()
```
    Returns true, if the status is IStatus.Severity.INFO.
    
    Returns:
    
    true, if is info
  - isWarning
```
boolean isWarning()
```
    Returns true, if the status is IStatus.Severity.WARNING.
    
    Returns:
    
    true, if is warning
  - isError
```
boolean isError()
```
    Returns true, if the status is IStatus.Severity.ERROR.
    
    Returns:
    
    true, if is error
  - isCancel
```
boolean isCancel()
```
    Returns true, if the status is IStatus.Severity.CANCEL. May be used to detect a "veto" for a process.
    
    Returns:
    
    true, if is cancel
  - putProperty
```
void putProperty(String key,
                 Object value)
```
    Puts a property into the status.
    
    Parameters:
    
    key - the key
    
    value - the value
  - containsProperty
```
boolean containsProperty(String key)
```
    Returns true, if a property exists.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    true, if successful
  - getProperty
```
Object getProperty(String key)
```
    Returns the value of the property.
    
    Parameters:
    
    key - the key
    
    Returns:
    
    the property

Interface IStatus

Nested Class Summary

Field Summary

Method Summary

Field Detail

OK

CANCEL

ERROR

PROP_UI_APPLICATION_ID

PROP_FIELD_ID

PROP_FIELD_I18N_KEY

PROP_JAVAX_CONSTRAINT

PROP_JAVAX_LEAF_BEAN

PROP_JAVAX_PROPERTY_PATH

PROP_CREATOR

Method Detail

getId

getCode

getBundleSymblicName

getSeverity

getMessage

getException

isOK

isInfo

isWarning

isError

isCancel

putProperty

containsProperty

getProperty