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

All Superinterfaces:

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

All Known Implementing Classes:

DestroySituationImpl

public interface DestroySituation

extends SituationType

Interface representing a DestroySituation.

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

• CONM6007I: The connection pool was destroyed for data source (UDDI.Datasource.techs8.server1).

Since:

1.0.1

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.
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

public java.lang.String getSuccessDisposition()

Returns the value of the 'Success Disposition' attribute.

Returns:

the value of the 'Success Disposition' attribute.

See Also:

setSuccessDisposition(String), org.eclipse.tptp.logging.events.cbe.EventPackage#getDestroySituation_SuccessDisposition()

setSuccessDisposition

public 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

public 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

Since:

1.0