org.eclipse.tptp.logging.events.cbe
Interface MsgCatalogToken

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

MsgCatalogTokenImpl

public interface MsgCatalogToken

extends java.lang.Cloneable, java.io.Serializable

Interface representing a MsgCatalogToken.

The following description is from the Common Base Event v1.0.1 specification entitled "Canonical Situation Data Format: The Common Base Event V1.0.1":

A string used as substitution value for resolving an internationalized message into formatted text.

Since:

1.0.1

Method Summary

java.lang.String	getValue() Returns the value of the 'Value' attribute.
void	init() Resets the object's properties to their initial (e.g.
void	setValue(java.lang.String value) Sets the value of the ' Value' attribute.
void	validate() Checks whether the contents of the instance conform to the CBE specification.

Method Detail

getValue

public java.lang.String getValue()

Returns the value of the 'Value' attribute.

Returns:

the value of the 'Value' attribute.

See Also:

setValue(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getMsgCatalogToken_Value()

setValue

public void setValue(java.lang.String value)

Sets the value of the ' Value' attribute.

The string length for value must not exceed 256 characters.

Parameters:

value - the new value of the 'Value' attribute.

See Also:

getValue()

validate

public void validate()
              throws ValidationException

Checks whether the contents of the instance conform to the CBE specification.

Throws:

ValidationException - if the message catalog token does not follow the CBE specification.

init

public void init()

Resets the object's properties to their initial (e.g. null) state. All components are initialized to either zero or null.

Since:

1.0