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

All Superinterfaces:

java.lang.Cloneable, java.io.Serializable, SituationType

All Known Implementing Classes:

CreateSituationImpl

public interface CreateSituation
extends SituationType

Interface representing a CreateSituation.

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 CreateSituation deals with the situations documenting when a component creates an entity. Messages telling that a document, file, or EJB was created all fall into this category. Existing message include words like "was created", "about to create", and "now exists", for example:

• ADMR0009I: Document cells/flatfootNetwork/applications/Dynamic


• Cache Monitor.ear/Dynamic Cache Monitor.ear was created

Method Summary

java.lang.String	getSuccessDisposition() Returns the value of the 'Success Disposition' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setSuccessDisposition(java.lang.String value) Sets the value of the ' Success Disposition' attribute.

Methods inherited from interface org.eclipse.tptp.logging.events.cbe.SituationType

getReasoningScope, setReasoningScope, validate

Method Detail

getSuccessDisposition

java.lang.String getSuccessDisposition()

Returns the value of the 'Success Disposition' attribute.

Returns:

the value of the 'Success Disposition' attribute.

See Also:

setSuccessDisposition(String)

setSuccessDisposition

void setSuccessDisposition(java.lang.String value)

Sets the value of the ' Success Disposition' attribute.

This property specifies whether or not the operation that caused the situation to be reported was successful. The successDisposition is a string with the following set of values:

• SUCCESSFUL
• UNSUCCESSFUL

This is a required property and once it is set it must not change. The string length for this property must not exceed 64 characters.

Parameters:

value - the new value of the 'Success Disposition' attribute.

See Also:

getSuccessDisposition()

init

void init()

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

Specified by:

init in interface SituationType