com.edustructures.sifworks.student
Class IncidentReporter

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.student.IncidentReporter

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class IncidentReporter
extends SIFKeyedElement

Since:

2.0

Version:

2.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.edustructures.sifworks.Element

CURRENT_SERIALIZE_VERSION

Constructor Summary

IncidentReporter()
Constructor

IncidentReporter(ReporterDescriptionType type)
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
Name	getName() Gets the value of the <Name> element.
SIF_RefId	getSIF_RefId() Gets the value of the <SIF_RefId> element.
java.lang.String	getType() Gets the value of the Type attribute.
void	removeName() Removes the Name child element previously created by calling setName
void	removeSIF_RefId() Removes the SIF_RefId child element previously created by calling setSIF_RefId
void	setName(Name value) Sets the value of the <Name> element.
void	setName(NameType type, java.lang.String lastName, java.lang.String firstName) Sets the value of the <Name> child element.
void	setSIF_RefId(SIF_RefId value) Sets the value of the <SIF_RefId> element.
void	setSIF_RefId(java.lang.String sifRefObject, java.lang.String value) Sets the value of the <SIF_RefId> child element.
void	setType(ReporterDescriptionType value) Sets the value of the Type attribute.
void	setType(java.lang.String value) Sets the value of the Type attribute as a String.

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IncidentReporter

public IncidentReporter()

Constructor

IncidentReporter

public IncidentReporter(ReporterDescriptionType type)

Constructor that accepts values for all mandatory fields

Parameters:

type -

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

getType

public java.lang.String getType()

Gets the value of the Type attribute.

Returns:

The Type attribute of this object.

Since:

2.0

setType

public void setType(ReporterDescriptionType value)

Sets the value of the Type attribute.

Parameters:

value - A constant defined by the ReporterDescriptionType class

Since:

2.0

setType

public void setType(java.lang.String value)

Sets the value of the Type attribute as a String.

Parameters:

value - The value as a String

Since:

2.0

setName

public void setName(Name value)

Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The name of the individual reporting the incident."

Parameters:

value - A Name object

Since:

2.0

setName

public void setName(NameType type,
                    java.lang.String lastName,
                    java.lang.String firstName)

Sets the value of the <Name> child element. This form of setName is provided as a convenience method that is functionally equivalent to the version of setName that accepts a single Name object.

Parameters:

type - Code that specifies what type of name this is. If unsure, use 04.

lastName - The last name.

firstName - The first name.

Since:

2.0

getName

public Name getName()

Gets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "The name of the individual reporting the incident."

Returns:

A Name object

Since:

2.0

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

2.0

setSIF_RefId

public void setSIF_RefId(SIF_RefId value)

Sets the value of the <SIF_RefId> element.

Parameters:

value - A SIF_RefId object

Since:

2.0

setSIF_RefId

public void setSIF_RefId(java.lang.String sifRefObject,
                         java.lang.String value)

Sets the value of the <SIF_RefId> child element. This form of setSIF_RefId is provided as a convenience method that is functionally equivalent to the version of setSIF_RefId that accepts a single SIF_RefId object.

Parameters:

sifRefObject -

value - Gets or sets the content value of the <SIF_RefId> element

Since:

2.0

getSIF_RefId

public SIF_RefId getSIF_RefId()

Gets the value of the <SIF_RefId> element.

Returns:

A SIF_RefId object

Since:

2.0

removeSIF_RefId

public void removeSIF_RefId()

Removes the SIF_RefId child element previously created by calling setSIF_RefId

Since:

2.0