cern.laser.source.alarmsysteminterface.impl

Class FaultStateImpl

java.lang.Object

cern.laser.source.alarmsysteminterface.impl.FaultStateImpl

All Implemented Interfaces:

FaultState

Direct Known Subclasses:

ACSLaserFaultStateImpl

public class FaultStateImpl
extends java.lang.Object
implements FaultState

A fault state implementation.

Author:

fracalde

Field Summary

Fields inherited from interface cern.laser.source.alarmsysteminterface.FaultState

ACTIVE, ASI_PREFIX_PROPERTY, ASI_SUFFIX_PROPERTY, CHANGE, INSTANT, TERMINATE

Constructor Summary

Constructors

Constructor and Description
FaultStateImpl() constructor
FaultStateImpl(java.lang.String faultFamily, java.lang.String faultMember, int faultCode) constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Check for equality with respect to the fault state triplet ff,fm,fc.
boolean	getActivatedByBackup()
int	getCode() fault code accessor method
java.lang.String	getDescriptor() the fault descriptor accessor method
java.lang.String	getFamily() fault family accessor method
java.lang.String	getMember() fault member accessor method
boolean	getTerminatedByBackup()
java.util.Properties	getUserProperties() return the user properties attached to the fault state
java.sql.Timestamp	getUserTimestamp() the user timestamp accessor method
int	hashCode() Return the object hash code.
void	setActivatedByBackup(boolean newActivatedByBackup)
void	setCode(int faultCode) fault code accessor method
void	setDescriptor(java.lang.String descriptor) the fault descriptor accessor method
void	setFamily(java.lang.String faultFamily) fault family accessor method
void	setMember(java.lang.String faultMember) fault member accessor method
void	setTerminatedByBackup(boolean newTerminatedByBackup)
void	setUserProperties(java.util.Properties properties) set the user properties attached to the fault state
void	setUserTimestamp(java.sql.Timestamp timestamp) the user timestamp accessor method
java.lang.String	toString() Return a String representation of a FaultState.
void	validate() Validate the fault state instance.
protected java.lang.String	value() Return a String representation of the object identity.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FaultStateImpl

public FaultStateImpl()

constructor

FaultStateImpl

public FaultStateImpl(java.lang.String faultFamily,
                      java.lang.String faultMember,
                      int faultCode)

constructor

Parameters:

faultFamily - the fault family

faultMember - the fault member

faultCode - the fault code

Method Detail

setCode

public void setCode(int faultCode)

fault code accessor method

Specified by:

setCode in interface FaultState

Parameters:

faultCode - the fault code

getCode

public int getCode()

fault code accessor method

Specified by:

getCode in interface FaultState

Returns:

the fault code

setDescriptor

public void setDescriptor(java.lang.String descriptor)

the fault descriptor accessor method

Specified by:

setDescriptor in interface FaultState

Parameters:

descriptor - the fault descriptor

getDescriptor

public java.lang.String getDescriptor()

the fault descriptor accessor method

Specified by:

getDescriptor in interface FaultState

Returns:

String the fault descriptor

setFamily

public void setFamily(java.lang.String faultFamily)

fault family accessor method

Specified by:

setFamily in interface FaultState

Parameters:

faultFamily - the fault family

getFamily

public java.lang.String getFamily()

fault family accessor method

Specified by:

getFamily in interface FaultState

Returns:

the fault family

setMember

public void setMember(java.lang.String faultMember)

fault member accessor method

Specified by:

setMember in interface FaultState

Parameters:

faultMember - the fault member

getMember

public java.lang.String getMember()

fault member accessor method

Specified by:

getMember in interface FaultState

Returns:

the fault member

setUserProperties

public void setUserProperties(java.util.Properties properties)

set the user properties attached to the fault state

Specified by:

setUserProperties in interface FaultState

Parameters:

properties - the user properties

getUserProperties

public java.util.Properties getUserProperties()

return the user properties attached to the fault state

Specified by:

getUserProperties in interface FaultState

Returns:

Properties the user properties

setUserTimestamp

public void setUserTimestamp(java.sql.Timestamp timestamp)

the user timestamp accessor method

Specified by:

setUserTimestamp in interface FaultState

Parameters:

timestamp - the user timestamp

getUserTimestamp

public java.sql.Timestamp getUserTimestamp()

the user timestamp accessor method

Specified by:

getUserTimestamp in interface FaultState

Returns:

long the user timestamp

getActivatedByBackup

public boolean getActivatedByBackup()

Specified by:

getActivatedByBackup in interface FaultState

setActivatedByBackup

public void setActivatedByBackup(boolean newActivatedByBackup)

Specified by:

setActivatedByBackup in interface FaultState

getTerminatedByBackup

public boolean getTerminatedByBackup()

Specified by:

getTerminatedByBackup in interface FaultState

setTerminatedByBackup

public void setTerminatedByBackup(boolean newTerminatedByBackup)

Specified by:

setTerminatedByBackup in interface FaultState

equals

public boolean equals(java.lang.Object obj)

Check for equality with respect to the fault state triplet ff,fm,fc.

Overrides:

equals in class java.lang.Object

Parameters:

obj - the object to check against.

Returns:

true iff the two objects are equal.

hashCode

public int hashCode()

Return the object hash code.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code.

toString

public java.lang.String toString()

Return a String representation of a FaultState.

Overrides:

toString in class java.lang.Object

Returns:

the String representation

validate

public void validate()
              throws ASIException

Validate the fault state instance.

Throws:

ASIException - if the fault state atributes are null or not valid.

value

protected java.lang.String value()

Return a String representation of the object identity.

Returns:

the object identity String representation.