org.eclipse.tptp.logging.events.cbe.impl
Class StartSituationImpl

java.lang.Object
  org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl
      org.eclipse.tptp.logging.events.cbe.impl.StartSituationImpl

All Implemented Interfaces:

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

public class StartSituationImpl

extends SituationTypeImpl

implements StartSituation

Interface representing a StartSituation.

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 StartSituation deals with the start up process for a component. Messages that indicate that a component has begun the startup process, that it has finished the startup process, or that it has aborted the startup process all fall into this category. Existing messages include words like "starting", "started", "initializing", and "initialized", for example:

• DIA3206I The TCP/IP protocol support was started successfully.


• DIA3000I "%1S" protocol support was successfully started.


• DIA3001E "%1S" protocol support was not successfully started.


• WSVR0037I: Starting EJB jar: {0}

Since:

1.0.1

See Also:

Serialized Form

Field Summary

protected java.lang.String	situationQualifier The cached value of the ' Situation Qualifier' attribute.
protected java.lang.String	successDisposition The cached value of the ' Success Disposition' attribute.

Fields inherited from class org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl

reasoningScope

Constructor Summary

protected

StartSituationImpl()

Method Summary

java.lang.Object	clone() Return a cloned (copy by value) object of this object.
boolean	equals(java.lang.Object object) Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.
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 newSituationQualifier) Sets the value of the ' Situation Qualifier' attribute.
void	setSuccessDisposition(java.lang.String newSuccessDisposition) Sets the value of the ' Success Disposition' attribute.
java.lang.String	toString()
void	validate() Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Methods inherited from class org.eclipse.tptp.logging.events.cbe.impl.SituationTypeImpl

getReasoningScope, setReasoningScope

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getReasoningScope, setReasoningScope

Field Detail

successDisposition

protected java.lang.String successDisposition

The cached value of the ' Success Disposition' attribute.

See Also:

getSuccessDisposition()

situationQualifier

protected java.lang.String situationQualifier

The cached value of the ' Situation Qualifier' attribute.

See Also:

getSituationQualifier()

Constructor Detail

StartSituationImpl

protected StartSituationImpl()

Method Detail

getSuccessDisposition

public java.lang.String getSuccessDisposition()

Description copied from interface: StartSituation

Returns the value of the 'Success Disposition' attribute.

Specified by:

getSuccessDisposition in interface StartSituation

Returns:

the value of the 'Success Disposition' attribute.

See Also:

StartSituation.setSuccessDisposition(String)

setSuccessDisposition

public void setSuccessDisposition(java.lang.String newSuccessDisposition)

Description copied from interface: StartSituation

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.

Specified by:

setSuccessDisposition in interface StartSituation

Parameters:

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

See Also:

StartSituation.getSuccessDisposition()

getSituationQualifier

public java.lang.String getSituationQualifier()

Description copied from interface: StartSituation

Returns the value of the 'Situation Qualifier' attribute.

Specified by:

getSituationQualifier in interface StartSituation

Returns:

the value of the 'Situation Qualifier' attribute.

See Also:

StartSituation.setSituationQualifier(String)

setSituationQualifier

public void setSituationQualifier(java.lang.String newSituationQualifier)

Description copied from interface: StartSituation

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:

• START INITIATED
• RESTART INITIATED
• START 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.

Specified by:

setSituationQualifier in interface StartSituation

Parameters:

newSituationQualifier - the new value of the 'Situation Qualifier' attribute.

See Also:

StartSituation.getSituationQualifier()

toString

public java.lang.String toString()

Overrides:

toString in class SituationTypeImpl

validate

public void validate()
              throws ValidationException

Checks whether the contents of the instance conform to the Common Base Event specification as described in "Canonical Situation Data Format: The Common Base Event V1.0.1".

Specified by:

validate in interface SituationType

Overrides:

validate in class SituationTypeImpl

Throws:

ValidationException - If the event instance does not conform to the Common Base Event specification.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Return a cloned (copy by value) object of this object.

This is a deep copy version, in which all the objects within this object will be copied by value.

Overrides:

clone in class SituationTypeImpl

Returns:

Object The cloned (copy by value) object of this object.

Throws:

java.lang.CloneNotSupportedException - If a instance variable of this object does not implement the Cloneable interface.

equals

public boolean equals(java.lang.Object object)

Overrides the java.lang.Object's equals() API to determine if the parameter object is equal to this object.

Overrides:

equals in class SituationTypeImpl

Parameters:

object - The java.lang.Object to be compared to this object.

Returns:

True, if this object is the same as the parameter object, otherwise false.

See Also:

Object.equals(java.lang.Object)

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 StartSituation

Overrides:

init in class SituationTypeImpl

Since:

1.0