com.edustructures.sifworks.infra
Class SIF_LogEntry

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFDataObject
              com.edustructures.sifworks.infra.SIF_LogEntry

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SIF_LogEntry
extends SIFDataObject

Captures an error, warning, or informational log message for inclusion in a zone log.

Since:

1.5r1

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

SIF_LogEntry()
Constructor

SIF_LogEntry(LogSource source, LogLevel logLevel, SIF_LogEntryHeader sifLogEntryHeader, java.lang.String sifDesc)
Constructor that accepts values for all mandatory fields

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.String	getLogLevel() Gets the value of the LogLevel attribute.
java.lang.String	getSIF_ApplicationCode() Gets the value of the <SIF_ApplicationCode> element.
java.lang.String	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.
SIF_LogEntryHeader	getSIF_LogEntryHeader() Gets the value of the <SIF_LogEntryHeader> element.
SIF_LogObjects	getSIF_LogObjects() Gets the value of the <SIF_LogObjects> element.
SIF_LogEntryHeader	getSIF_OriginalHeader() Gets the value of the <SIF_OriginalHeader> element.
java.lang.String	getSource() Gets the value of the Source attribute.
void	removeSIF_LogEntryHeader() Removes the SIF_LogEntryHeader child element previously created by calling setSIF_LogEntryHeader
void	removeSIF_LogObjects() Removes the SIF_LogObjects child element previously created by calling setSIF_LogObjects
void	removeSIF_OriginalHeader() Removes the SIF_OriginalHeader child element previously created by calling setSIF_OriginalHeader
void	setLogLevel(LogLevel value) Sets the value of the LogLevel attribute.
void	setLogLevel(java.lang.String value) Sets the value of the LogLevel attribute as a String.
void	setSIF_ApplicationCode(java.lang.String value) Sets the value of the <SIF_ApplicationCode> element.
void	setSIF_Category(SIFLogCategory value) Sets the value of the <SIF_Category> element.
void	setSIF_Category(java.lang.String value) Sets the value of the <SIF_Category> element as a String.
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.
void	setSIF_LogEntryHeader(SIF_LogEntryHeader value) Sets the value of the <SIF_LogEntryHeader> element.
void	setSIF_LogObjects(SIF_LogObjects value) Sets the value of the <SIF_LogObjects> element.
void	setSIF_OriginalHeader(SIF_LogEntryHeader value) Sets the value of the <SIF_OriginalHeader> element.
void	setSource(LogSource value) Sets the value of the Source attribute.
void	setSource(java.lang.String value) Sets the value of the Source attribute as a String.

Methods inherited from class com.edustructures.sifworks.SIFDataObject

addSIFExtendedElement, clone, getElementOrAttribute, getObjectTag, getObjectType, getRefId, getSIFExtendedElement, getSIFExtendedElements, getSIFExtendedElementsContainer, getSIFMetadata, getSIFVersion, setElementOrAttribute, setElementOrAttribute, setElementOrAttribute, setSIFExtendedElements, setSIFExtendedElementsContainer, setSIFMetadata, setSIFVersion, toXML

Methods inherited from class com.edustructures.sifworks.SIFElement

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

Methods inherited from class com.edustructures.sifworks.Element

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SIF_LogEntry

public SIF_LogEntry()

Constructor

SIF_LogEntry

public SIF_LogEntry(LogSource source,
                    LogLevel logLevel,
                    SIF_LogEntryHeader sifLogEntryHeader,
                    java.lang.String sifDesc)

Constructor that accepts values for all mandatory fields

Parameters:

source - The SIF node that logged this entry.

logLevel - The level of the log entry herein described.

sifLogEntryHeader - This is a copy of the SIF_Event/SIF_Header in the message that added this SIF_LogEntry to the zone. This copy facilitates querying log entries with regard to source, time, destination, etc.

sifDesc - A textual description of the error.

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

getSource

public java.lang.String getSource()

Gets the value of the Source attribute.

The SIF specification defines the meaning of this attribute as: "The SIF node that logged this entry."

Returns:

The Source attribute of this object.

Since:

1.5r1

setSource

public void setSource(LogSource value)

Sets the value of the Source attribute.

The SIF specification defines the meaning of this attribute as: "The SIF node that logged this entry."

Parameters:

value - A constant defined by the LogSource class

Since:

1.5r1

setSource

public void setSource(java.lang.String value)

Sets the value of the Source attribute as a String.

The SIF specification defines the meaning of this attribute as: "The SIF node that logged this entry."

Parameters:

value - The value as a String

Since:

1.5r1

getLogLevel

public java.lang.String getLogLevel()

Gets the value of the LogLevel attribute.

The SIF specification defines the meaning of this attribute as: "The level of the log entry herein described."

Returns:

The LogLevel attribute of this object.

Since:

1.5r1

setLogLevel

public void setLogLevel(LogLevel value)

Sets the value of the LogLevel attribute.

The SIF specification defines the meaning of this attribute as: "The level of the log entry herein described."

Parameters:

value - A constant defined by the LogLevel class

Since:

1.5r1

setLogLevel

public void setLogLevel(java.lang.String value)

Sets the value of the LogLevel attribute as a String.

The SIF specification defines the meaning of this attribute as: "The level of the log entry herein described."

Parameters:

value - The value as a String

Since:

1.5r1

setSIF_LogEntryHeader

public void setSIF_LogEntryHeader(SIF_LogEntryHeader value)

Sets the value of the <SIF_LogEntryHeader> element.

The SIF specification defines the meaning of this element as: "This is a copy of the SIF_Event/SIF_Header in the message that added this SIF_LogEntry to the zone. This copy facilitates querying log entries with regard to source, time, destination, etc."

Parameters:

value - A SIF_LogEntryHeader object

Since:

1.5r1

getSIF_LogEntryHeader

public SIF_LogEntryHeader getSIF_LogEntryHeader()

Gets the value of the <SIF_LogEntryHeader> element.

The SIF specification defines the meaning of this element as: "This is a copy of the SIF_Event/SIF_Header in the message that added this SIF_LogEntry to the zone. This copy facilitates querying log entries with regard to source, time, destination, etc."

Returns:

A SIF_LogEntryHeader object

Since:

1.5r1

removeSIF_LogEntryHeader

public void removeSIF_LogEntryHeader()

Removes the SIF_LogEntryHeader child element previously created by calling setSIF_LogEntryHeader

Since:

1.5r1

setSIF_OriginalHeader

public void setSIF_OriginalHeader(SIF_LogEntryHeader value)

Sets the value of the <SIF_OriginalHeader> element.

The SIF specification defines the meaning of this element as: "If this log entry references a previous SIF_Message, this element contains a copy of the referenced message SIF_Header."

Parameters:

value - A SIF_LogEntryHeader object

Since:

1.5r1

getSIF_OriginalHeader

public SIF_LogEntryHeader getSIF_OriginalHeader()

Gets the value of the <SIF_OriginalHeader> element.

The SIF specification defines the meaning of this element as: "If this log entry references a previous SIF_Message, this element contains a copy of the referenced message SIF_Header."

Returns:

A SIF_LogEntryHeader object

Since:

1.5r1

removeSIF_OriginalHeader

public void removeSIF_OriginalHeader()

Removes the SIF_OriginalHeader child element previously created by calling setSIF_OriginalHeader

Since:

1.5r1

getSIF_Category

public java.lang.String getSIF_Category()

Gets the value of the <SIF_Category> element.

The SIF specification defines the meaning of this element as: "A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice."

Returns:

The SIF_Category element of this object.

Since:

1.5r1

setSIF_Category

public void setSIF_Category(SIFLogCategory value)

Sets the value of the <SIF_Category> element.

The SIF specification defines the meaning of this element as: "A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice."

Parameters:

value - A constant defined by the SIFLogCategory class

Since:

1.5r1

setSIF_Category

public void setSIF_Category(java.lang.String value)

Sets the value of the <SIF_Category> element as a String.

The SIF specification defines the meaning of this element as: "A SIF_LogEntry category. May be omitted for informational-type postings, where typically a textual description will suffice."

Parameters:

value - The value as a String

Since:

1.5r1

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: "A SIF_LogEntry code with regard to SIF_Category above. May be omitted for informational-type postings, where typically a textual description will suffice. If a SIF_Code is included, SIF_Category must be included as well."

Returns:

The SIF_Code element of this object.

Since:

1.5r1

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: "A SIF_LogEntry code with regard to SIF_Category above. May be omitted for informational-type postings, where typically a textual description will suffice. If a SIF_Code is included, SIF_Category must be included as well."

Parameters:

value - A Integer object

Since:

1.5r1

getSIF_ApplicationCode

public java.lang.String getSIF_ApplicationCode()

Gets the value of the <SIF_ApplicationCode> element.

The SIF specification defines the meaning of this element as: " An error code specific to the application posting the entry. Can be used by vendors to query log entries for errors specific to their applications. If a SIF_ApplicationCode is included, SIF_Category must be included as well; i.e., application-specific error codes should fall within one of the defined log entry categories. "

Returns:

The SIF_ApplicationCode element of this object.

Since:

1.5r1

setSIF_ApplicationCode

public void setSIF_ApplicationCode(java.lang.String value)

Sets the value of the <SIF_ApplicationCode> element.

The SIF specification defines the meaning of this element as: " An error code specific to the application posting the entry. Can be used by vendors to query log entries for errors specific to their applications. If a SIF_ApplicationCode is included, SIF_Category must be included as well; i.e., application-specific error codes should fall within one of the defined log entry categories. "

Parameters:

value - A String object

Since:

1.5r1

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 textual description of the error."

Returns:

The SIF_Desc element of this object.

Since:

1.5r1

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 textual description of the error."

Parameters:

value - A String object

Since:

1.5r1

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: "Any extended error description."

Returns:

The SIF_ExtendedDesc element of this object.

Since:

1.5r1

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: "Any extended error description."

Parameters:

value - A String object

Since:

1.5r1

setSIF_LogObjects

public void setSIF_LogObjects(SIF_LogObjects value)

Sets the value of the <SIF_LogObjects> element.

Parameters:

value - A SIF_LogObjects object

Since:

1.5r1

getSIF_LogObjects

public SIF_LogObjects getSIF_LogObjects()

Gets the value of the <SIF_LogObjects> element.

Returns:

A SIF_LogObjects object

Since:

1.5r1

removeSIF_LogObjects

public void removeSIF_LogObjects()

Removes the SIF_LogObjects child element previously created by calling setSIF_LogObjects

Since:

1.5r1