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

All Superinterfaces:

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

All Known Implementing Classes:

ConnectSituationImpl

public interface ConnectSituation
extends SituationType

Interface representing a ConnectSituation.

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 ConnectSituation deals with the situations that identify aspects about a connection to another component. Messages that say a connection failed, that a connection was created, or that a connection was ended all fall into this category. Existing messages include words like connection reset, connection failed, and failed to get a connection, for example:

• DBMN0015W: Failure while creating connection {0}


• DBMN0023W: Failed to close a connection {0}

Method Summary

java.lang.String	getSituationDisposition() Returns the value of the 'Situation Disposition' 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	setSituationDisposition(java.lang.String value) Sets the value of the ' Situation Disposition' 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

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

getSituationDisposition

java.lang.String getSituationDisposition()

Returns the value of the 'Situation Disposition' attribute.

Returns:

the value of the 'Situation Disposition' attribute.

See Also:

setSituationDisposition(String)

setSituationDisposition

void setSituationDisposition(java.lang.String value)

Sets the value of the ' Situation Disposition' attribute.

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

• INUSE
• FREED
• CLOSED
• AVAILABLE

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 Disposition' attribute.

See Also:

getSituationDisposition()

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