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

All Superinterfaces:

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

All Known Implementing Classes:

StopSituationImpl

public interface StopSituation

extends SituationType

Interface representing a StopSituation.

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 StopSituation deals with the shutdown process for a component. Message that indicate that a component has begun to stop, that it has stopped, or that the stopping process has failed all fall into this category. Existing messages include words like "stop", "stopping", "stopped", "completed", and "exiting", for example:

• WSVR0220I: Application stopped: {0}


• WSVR0102E: An error occurred stopping, {0}


• MSGS0657I: Stopping the MQJD JMS Provider

Since:

1.0.1

Method Summary

java.lang.String	getSituationQualifier() Returns the value of the 'Situation Qualifier' attribute.
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	setSituationQualifier(java.lang.String value) Sets the value of the ' Situation Qualifier' attribute.
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)

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()

getSituationQualifier

public java.lang.String getSituationQualifier()

Returns the value of the 'Situation Qualifier' attribute.

Returns:

the value of the 'Situation Qualifier' attribute.

See Also:

setSituationQualifier(String)

setSituationQualifier

public void setSituationQualifier(java.lang.String value)

Sets the value of the ' Situation Qualifier' attribute.

This property specifies the situation qualifiers that are representation of the parameters necessary to describe the situation. The situationQualifier is a string with the following set of values:

• STOP INITIATED
• ABORT INITIATED
• PAUSE INITIATED
• STOP COMPLETED

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 'Situation Qualifier' attribute.

See Also:

getSituationQualifier()

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