CommonMessageID (Butor Framework Core - Utils Module 1.0.29 API)

java.lang.Object
- java.lang.Enum<CommonMessageID>
- - org.butor.utils.CommonMessageID

All Implemented Interfaces:: Serializable, Comparable<CommonMessageID>, MessageID

public enum CommonMessageID
extends Enum<CommonMessageID>
implements MessageID

Enum Constant Summary

Enum Constants
Enum Constant and Description
`INVALID_ARG`
`MISSING_ARG`
`MISSING_CONFIG`
`NOT_FOUND`
`SERVICE_FAILURE`
`SERVICE_NOT_AVAILABLE`
`SERVICE_TIMEOUT`
`SUCCESS`
`SUCCESSFULL_UPDATE`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getId()`
`Message`	`getMessage()`
`Message`	`getMessage(String message)`
`Message.MessageType`	`getMessageType()`
`String`	`getSysId()`
`void`	`setSysId(String sysId)`
`static CommonMessageID`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CommonMessageID[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - SERVICE_NOT_AVAILABLE
```
public static final CommonMessageID SERVICE_NOT_AVAILABLE
```
  - SUCCESS
```
public static final CommonMessageID SUCCESS
```
  - SUCCESSFULL_UPDATE
```
public static final CommonMessageID SUCCESSFULL_UPDATE
```
  - SERVICE_TIMEOUT
```
public static final CommonMessageID SERVICE_TIMEOUT
```
  - SERVICE_FAILURE
```
public static final CommonMessageID SERVICE_FAILURE
```
  - MISSING_ARG
```
public static final CommonMessageID MISSING_ARG
```
  - MISSING_CONFIG
```
public static final CommonMessageID MISSING_CONFIG
```
  - INVALID_ARG
```
public static final CommonMessageID INVALID_ARG
```
  - NOT_FOUND
```
public static final CommonMessageID NOT_FOUND
```
- Method Detail
  - values
```
public static CommonMessageID[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (CommonMessageID c : CommonMessageID.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CommonMessageID valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getMessage
```
public Message getMessage()
```
  - getMessage
```
public Message getMessage(String message)
```
  - getId
```
public String getId()
```
    Specified by:
    
    getId in interface MessageID
  - getSysId
```
public String getSysId()
```
    Specified by:
    
    getSysId in interface MessageID
  - setSysId
```
public void setSysId(String sysId)
```
  - getMessageType
```
public Message.MessageType getMessageType()
```
    Specified by:
    
    getMessageType in interface MessageID

Enum CommonMessageID

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SERVICE_NOT_AVAILABLE

SUCCESS

SUCCESSFULL_UPDATE

SERVICE_TIMEOUT

SERVICE_FAILURE

MISSING_ARG

MISSING_CONFIG

INVALID_ARG

NOT_FOUND

Method Detail

values

valueOf

getMessage

getMessage

getId

getSysId

setSysId

getMessageType