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

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable

All Known Implementing Classes:

ContextDataElementImpl

public interface ContextDataElement
extends java.lang.Cloneable, java.io.Serializable

Interface representing a ContextDataElement.

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":

The ContextDataElement type defines the contexts that this event references. This complex type holds data that is used to assist with problem diagnostics by correlating messages or events generated during execution of a unit of work.

Method Summary

java.lang.String	getContextId() Returns the value of the 'Context Id' attribute.
java.lang.String	getContextValue() Returns the value of the 'Context Value' attribute.
java.lang.String	getName() Returns the value of the 'Name' attribute.
java.lang.String	getType() Returns the value of the 'Type' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setContextId(java.lang.String value) Sets the value of the ' Context Id' attribute.
void	setContextValue(java.lang.String value) Sets the value of the ' Context Value' attribute.
void	setName(java.lang.String value) Sets the value of the ' Name' attribute.
void	setType(java.lang.String value) Sets the value of the ' Type' attribute.
void	validate() Checks whether the contents of this object conforms to the CBE specification.

Method Detail

getContextId

java.lang.String getContextId()

Returns the value of the 'Context Id' attribute.

Returns:

the value of the 'Context Id' attribute.

See Also:

setContextId(String)

setContextId

void setContextId(java.lang.String value)

Sets the value of the ' Context Id' attribute.

This property is the reference to the globally unique identifier of the element that contains the context.

This is required unless contextValue specifies a value.

Parameters:

value - the new value of the 'Context Id' attribute.

See Also:

getContextId()

getContextValue

java.lang.String getContextValue()

Returns the value of the 'Context Value' attribute.

Returns:

the value of the 'Context Value' attribute.

See Also:

setContextValue(String)

setContextValue

void setContextValue(java.lang.String value)

Sets the value of the ' Context Value' attribute.

The value of the context with respect to the implementation of the context.

This is required unless contextId specifies a value. The string length for this property must not exceed 1024 characters.

Parameters:

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

See Also:

getContextValue()

getName

java.lang.String getName()

Returns the value of the 'Name' attribute.

Returns:

the value of the 'Name' attribute.

See Also:

setName(String)

setName

void setName(java.lang.String value)

Sets the value of the ' Name' attribute.

Name of the application that created this context data element.

This is a required property. The string length for this property must not exceed 64 characters.

Parameters:

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

See Also:

getName()

getType

java.lang.String getType()

Returns the value of the 'Type' attribute.

Returns:

the value of the 'Type' attribute.

See Also:

setType(String)

setType

void setType(java.lang.String value)

Sets the value of the ' Type' attribute.

The data type of the contextValue property.

This is a required property. The string length for this property must not exceed 64 characters.

Parameters:

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

See Also:

getType()

validate

void validate()
              throws ValidationException

Checks whether the contents of this object conforms to the CBE specification.

Throws:

ValidationException - if the object does not follow the CBE specification.

init

void init()

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