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

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

All Implemented Interfaces:

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

public class AvailableSituationImpl
extends SituationTypeImpl
implements AvailableSituation

Class representing an implementation of an AvailableSituation.

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 AvailableSituation deals with the situations reported from the component regarding its operational state and availability. This situation provides a context for operations that can be performed on the component by distinguishing if a product is installed, operational, and ready to process functional requests. Or, operational and ready/not ready to process management requests. Existing messages include words like those that indicate it is ready to take requests, both online and offline. For example:

• ADMC0013I: SOAP connector available at port 8880


• ADMC0026I: RMI Connector available at port 2809

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	getAvailabilityDisposition() Returns the value of the 'Availability Disposition' attribute.
java.lang.String	getOperationDisposition() Returns the value of the 'Operation Disposition' attribute.
java.lang.String	getProcessingDisposition() Returns the value of the 'Processing Disposition' attribute.
void	init() Resets the object's properties to their initial (e.g. null) state.
void	setAvailabilityDisposition(java.lang.String newAvailabilityDisposition) Sets the value of the ' Availability Disposition' attribute.
void	setOperationDisposition(java.lang.String newOperationDisposition) Sets the value of the ' Operation Disposition' attribute.
void	setProcessingDisposition(java.lang.String newProcessingDisposition) Sets the value of the ' Processing 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

getOperationDisposition

public java.lang.String getOperationDisposition()

Description copied from interface: AvailableSituation

Returns the value of the 'Operation Disposition' attribute.

Specified by:

getOperationDisposition in interface AvailableSituation

Returns:

the value of the 'Operation Disposition' attribute.

See Also:

AvailableSituation.setOperationDisposition(String)

setOperationDisposition

public void setOperationDisposition(java.lang.String newOperationDisposition)

Description copied from interface: AvailableSituation

Sets the value of the ' Operation Disposition' attribute.

This property specifies the operational state of the component reported by the situation. The operationalDisposition is a string with the values such as:

• STARTABLE
• NONSTARTABLE

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:

setOperationDisposition in interface AvailableSituation

Parameters:

newOperationDisposition - the new value of the 'Operation Disposition' attribute.

See Also:

AvailableSituation.getOperationDisposition()

getAvailabilityDisposition

public java.lang.String getAvailabilityDisposition()

Description copied from interface: AvailableSituation

Returns the value of the 'Availability Disposition' attribute.

Specified by:

getAvailabilityDisposition in interface AvailableSituation

Returns:

the value of the 'Availability Disposition' attribute.

See Also:

AvailableSituation.setAvailabilityDisposition(String)

setAvailabilityDisposition

public void setAvailabilityDisposition(java.lang.String newAvailabilityDisposition)

Description copied from interface: AvailableSituation

Sets the value of the ' Availability Disposition' attribute.

This property specifies the availability disposition of an entity or component that caused the situation to be reported.

The availabilityDisposition is a string with the following set of values:

• AVAILABLE
• NOT 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.

Specified by:

setAvailabilityDisposition in interface AvailableSituation

Parameters:

newAvailabilityDisposition - the new value of the 'Availability Disposition' attribute.

See Also:

AvailableSituation.getAvailabilityDisposition()

getProcessingDisposition

public java.lang.String getProcessingDisposition()

Description copied from interface: AvailableSituation

Returns the value of the 'Processing Disposition' attribute.

Specified by:

getProcessingDisposition in interface AvailableSituation

Returns:

the value of the 'Processing Disposition' attribute.

See Also:

AvailableSituation.setProcessingDisposition(String)

setProcessingDisposition

public void setProcessingDisposition(java.lang.String newProcessingDisposition)

Description copied from interface: AvailableSituation

Sets the value of the ' Processing Disposition' attribute.

This property specifies the processing disposition of a component operation that caused the situation to be reported.

The processingDisposition is a string with the following set of values:

• FUNCTION_PROCESS
• FUNCTION_BLOCK
• MGMTTASK_PROCESS
• MGMTTASK_BLOCKED

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:

setProcessingDisposition in interface AvailableSituation

Parameters:

newProcessingDisposition - the new value of the 'Processing Disposition' attribute.

See Also:

AvailableSituation.getProcessingDisposition()

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 AvailableSituation

Specified by:

init in interface SituationType

Overrides:

init in class SituationTypeImpl