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

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

All Implemented Interfaces:

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

public class CreateSituationImpl
extends SituationTypeImpl
implements CreateSituation

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

See Also:

Serialized Form

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

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

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

getReasoningScope, setReasoningScope

Method Detail

getSuccessDisposition

public java.lang.String getSuccessDisposition()

Description copied from interface: CreateSituation

Returns the value of the 'Success Disposition' attribute.

Specified by:

getSuccessDisposition in interface CreateSituation

Returns:

the value of the 'Success Disposition' attribute.

See Also:

CreateSituation.setSuccessDisposition(String)

setSuccessDisposition

public void setSuccessDisposition(java.lang.String newSuccessDisposition)

Description copied from interface: CreateSituation

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 CreateSituation

Parameters:

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

See Also:

CreateSituation.getSuccessDisposition()

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 CreateSituation

Specified by:

init in interface SituationType

Overrides:

init in class SituationTypeImpl