com.edustructures.sifworks.infra
Class SIF_Error

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.infra.SIF_Error

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_Error
extends SIFElement

Since:

1.1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_Error()
Constructor

SIF_Error(java.lang.Integer sifCategory, java.lang.Integer sifCode, java.lang.String sifDesc)
Constructor that accepts values for all mandatory fields

SIF_Error(java.lang.Integer sifCategory, java.lang.Integer sifCode, java.lang.String sifDesc, java.lang.String sifExtDesc)
Create an instance of SIF_Error

SIF_Error(SIFErrorCategory sifCategory, java.lang.Integer sifCode, java.lang.String sifDesc, java.lang.String sifExtDesc)
Create an instance of SIF_Error

Method Summary

java.lang.String	getKey() Gets the key of this object
ElementDef[]	getKeyFields() Gets the metadata fields that make up the key of this object
java.lang.Integer	getSIF_Category() Gets the value of the <SIF_Category> element.
java.lang.Integer	getSIF_Code() Gets the value of the <SIF_Code> element.
java.lang.String	getSIF_Desc() Gets the value of the <SIF_Desc> element.
java.lang.String	getSIF_ExtendedDesc() Gets the value of the <SIF_ExtendedDesc> element.
void	setSIF_Category(java.lang.Integer value) Sets the value of the <SIF_Category> element.
void	setSIF_Category(SIFErrorCategory errorCategory) Sets the Category associated with this error
void	setSIF_Code(java.lang.Integer value) Sets the value of the <SIF_Code> element.
void	setSIF_Desc(java.lang.String value) Sets the value of the <SIF_Desc> element.
void	setSIF_ExtendedDesc(java.lang.String value) Sets the value of the <SIF_ExtendedDesc> element.
java.lang.String	toString() Returns the value of getTextValue

Methods inherited from class com.edustructures.sifworks.SIFElement

addChild, addChild, clone, compareGraphTo, create, effectiveSIFVersion, getChild, getChild, getChild, getChild, getChild, getChildCount, getChildList, getChildList, getChildList, getChildren, getChildren, getContent, getContent, getField, getField, getFieldCount, getFields, getFieldValue, getSIFValue, getSIFVersion, getTextValue, getXmlId, hasTextValue, removeChild, removeChild, removeChild, removeChild, restoreImplementationDef, setChanged, setChildren, setEmpty, setField, setField, setField, setField, setSIFValue, setSIFVersion, setTextValue, setXmlId, tag

Methods inherited from class com.edustructures.sifworks.Element

compareTo, getElementDef, getParent, getRoot, isChanged, isDoNotEncode, isEmpty, setChanged, setDoNotEncode, setElementDef, setEmpty, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

SIF_Error

public SIF_Error()

Constructor

SIF_Error

public SIF_Error(java.lang.Integer sifCategory,
                 java.lang.Integer sifCode,
                 java.lang.String sifDesc)

Constructor that accepts values for all mandatory fields

Parameters:

sifCategory -

sifCode - See Error Codes.

sifDesc - A simple, easy to understand, description of the error. The primary consumer of this message is the application user. Example: "Unable to open database."

SIF_Error

public SIF_Error(java.lang.Integer sifCategory,
                 java.lang.Integer sifCode,
                 java.lang.String sifDesc,
                 java.lang.String sifExtDesc)

Create an instance of SIF_Error

Parameters:

sifCategory - The SIF category to set

sifCode - The SIF error code to set

sifDesc - A description of the error

sifExtDesc - An extended description

SIF_Error

public SIF_Error(SIFErrorCategory sifCategory,
                 java.lang.Integer sifCode,
                 java.lang.String sifDesc,
                 java.lang.String sifExtDesc)

Create an instance of SIF_Error

Parameters:

sifCategory - The SIF category to set

sifCode - The SIF error code to set

sifDesc - A description of the error

sifExtDesc - An extended description

Method Detail

getKey

public java.lang.String getKey()

Gets the key of this object

Overrides:

getKey in class SIFElement

Returns:

The value of the object's Mandatory or Required attribute. If an object has more than one such attribute, the key is a period- delimited concatenation of the attribute values in sequential order

getKeyFields

public ElementDef[] getKeyFields()

Gets the metadata fields that make up the key of this object

Returns:

an array of metadata fields that make up the object's key

getSIF_Category

public java.lang.Integer getSIF_Category()

Gets the value of the <SIF_Category> element.

Returns:

The SIF_Category element of this object.

Since:

1.1

setSIF_Category

public void setSIF_Category(java.lang.Integer value)

Sets the value of the <SIF_Category> element.

Parameters:

value - A Integer object

Since:

1.1

getSIF_Code

public java.lang.Integer getSIF_Code()

Gets the value of the <SIF_Code> element.

The SIF specification defines the meaning of this element as: "See Error Codes."

Returns:

The SIF_Code element of this object.

Since:

1.1

setSIF_Code

public void setSIF_Code(java.lang.Integer value)

Sets the value of the <SIF_Code> element.

The SIF specification defines the meaning of this element as: "See Error Codes."

Parameters:

value - A Integer object

Since:

1.1

getSIF_Desc

public java.lang.String getSIF_Desc()

Gets the value of the <SIF_Desc> element.

The SIF specification defines the meaning of this element as: "A simple, easy to understand, description of the error. The primary consumer of this message is the application user. Example: "Unable to open database.""

Returns:

The SIF_Desc element of this object.

Since:

1.1

setSIF_Desc

public void setSIF_Desc(java.lang.String value)

Sets the value of the <SIF_Desc> element.

The SIF specification defines the meaning of this element as: "A simple, easy to understand, description of the error. The primary consumer of this message is the application user. Example: "Unable to open database.""

Parameters:

value - A String object

Since:

1.1

getSIF_ExtendedDesc

public java.lang.String getSIF_ExtendedDesc()

Gets the value of the <SIF_ExtendedDesc> element.

The SIF specification defines the meaning of this element as: "An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300).""

Returns:

The SIF_ExtendedDesc element of this object.

Since:

1.1

setSIF_ExtendedDesc

public void setSIF_ExtendedDesc(java.lang.String value)

Sets the value of the <SIF_ExtendedDesc> element.

The SIF specification defines the meaning of this element as: "An optional error description that is more complete and technical in nature. It is to be used as a diagnostic message in trouble-shooting procedures. Example: "The 'Students' table is opened in exclusive mode by user 'ADM1' (dbm.cpp, line 300).""

Parameters:

value - A String object

Since:

1.1

setSIF_Category

public void setSIF_Category(SIFErrorCategory errorCategory)

Sets the Category associated with this error

Parameters:

errorCategory - The category to use

toString

public java.lang.String toString()

Description copied from class: Element

Returns the value of getTextValue

Overrides:

toString in class Element

Returns:

The text value of this element if applicable