jain.protocol.ss7.oam
Class OamErrorEvent
java.lang.Object
|
+--java.util.EventObject
|
+--jain.protocol.ss7.oam.OamErrorEvent
- Direct Known Subclasses:
- Mtp2ErrorEvent, Mtp3ErrorEvent, SccpErrorEvent, TcapErrorEvent
- public abstract class OamErrorEvent
- extends java.util.EventObject
- implements java.io.Serializable, java.lang.Cloneable
This Event may be emitted by any
OAM Managed Objectobject if an error
is encountered. This Event may then be passed to all concerned
OamErrorListeners.
If the error is not directly related to OAM/SS7, eg. it is a Java, etc. error
then an error message string can be set.
- See Also:
- Serialized Form
Fields inherited from class java.util.EventObject |
source |
Constructor Summary |
protected |
OamErrorEvent(java.lang.Object source,
int errorType)
Constructs a new OamErrorEvent of the specified Error Type. |
Method Summary |
int |
getErrorType()
Returns the Type of this Error |
java.lang.String |
getNonOamErrorMsg()
Returns a non-OAM related error message. |
abstract void |
setErrorType(int errorType)
Sets the Type of this Error |
void |
setNonOamErrorMsg(java.lang.String errorMsg)
Sets a non-OAM related error message. |
Methods inherited from class java.util.EventObject |
getSource,
toString |
Methods inherited from class java.lang.Object |
clone,
equals,
finalize,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
NON_OAM_RELATED_ERROR
public static final int NON_OAM_RELATED_ERROR
- Eror Type constant: Indicates that a non-OAM related (eg. Java, JNI, etc.) error.
Emitted By: Any OamManagedObject
errorType
protected int errorType
errorMsg
protected java.lang.String errorMsg
OamErrorEvent
protected OamErrorEvent(java.lang.Object source,
int errorType)
- Constructs a new OamErrorEvent of the specified Error Type.
- Parameters:
source
- the source of the errorerrorType
- one of the defined Error Types.- Throws:
- java.lang.NullPointerException - if any of the Objects supplied as parameters are null
setErrorType
public abstract void setErrorType(int errorType)
throws java.lang.IllegalArgumentException
- Sets the Type of this Error
- Parameters:
errorType
- one of the defined Error Types.- Throws:
- java.lang.IllegalArgumentException - - if the supplied error type is not one of the types defined in the API
getErrorType
public int getErrorType()
- Returns the Type of this Error
- Returns:
- one of the defined Error Types.
setNonOamErrorMsg
public void setNonOamErrorMsg(java.lang.String errorMsg)
throws java.lang.NullPointerException
- Sets a non-OAM related error message.
This String is set when a non-OAM related (eg. Java, JNI, etc.) error is encountered and
should contain the details of the error.
NB: This message should only be set whenever IF ErrorType ==
NON_OAM_RELATED_ERROR
- Parameters:
errorMsg
- the error message, eg. 'Lost connection to
underlying management system'.- Throws:
- java.lang.NullPointerException - if any of the Objects supplied as parameters are null
getNonOamErrorMsg
public java.lang.String getNonOamErrorMsg()
- Returns a non-OAM related error message.
This String is set when a non-OAM related (eg. Java, JNI, etc.) error is encountered and
should contain the details of the error.
NB: This message should only be read whenever IF ErrorType ==
NON_OAM_RELATED_ERROR
- Returns:
- the error message, eg. 'Lost connection to
underlying management system'.
06 January 2000
If you have any comments or queries, please mail them to Colm Hayden [JAIN SS7 OAM Edit Lead]Copyright - 2000 Sun Microsystems