com.edustructures.sifworks.common
Class SchoolContact

java.lang.Object
  com.edustructures.sifworks.Element
      com.edustructures.sifworks.SIFElement
          com.edustructures.sifworks.SIFKeyedElement
              com.edustructures.sifworks.common.SchoolContact

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SchoolContact
extends SIFKeyedElement

Information on contact persons for this school.

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

SchoolContact()
Constructor

SchoolContact(ContactInfo contactInfo)
Constructor that accepts values for all mandatory fields

Method Summary

ContactInfo	getContactInfo() Gets the value of the <ContactInfo> element.
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	getPublishInDirectory() Gets the value of the <PublishInDirectory> element.
void	removeContactInfo() Removes the ContactInfo child element previously created by calling setContactInfo
void	setContactInfo(ContactInfo value) Sets the value of the <ContactInfo> element.
void	setContactInfo(Name name) Sets the value of the <ContactInfo> child element.
void	setPublishInDirectory(java.lang.String value) Sets the value of the <PublishInDirectory> element as a String.
void	setPublishInDirectory(YesNo value) Sets the value of the <PublishInDirectory> element.

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

SchoolContact

public SchoolContact()

Constructor

SchoolContact

public SchoolContact(ContactInfo contactInfo)

Constructor that accepts values for all mandatory fields

Parameters:

contactInfo - For a description of this element, see 5.1.3 ContactInfo.

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

getPublishInDirectory

public java.lang.String getPublishInDirectory()

Gets the value of the <PublishInDirectory> element.

The SIF specification defines the meaning of this element as: "Indicates whether or not this school contact's information should be published in a directory of school information."

Returns:

The PublishInDirectory element of this object.

Since:

1.5r1

setPublishInDirectory

public void setPublishInDirectory(YesNo value)

Sets the value of the <PublishInDirectory> element.

The SIF specification defines the meaning of this element as: "Indicates whether or not this school contact's information should be published in a directory of school information."

Parameters:

value - A constant defined by the YesNo class

Since:

1.5r1

setPublishInDirectory

public void setPublishInDirectory(java.lang.String value)

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

The SIF specification defines the meaning of this element as: "Indicates whether or not this school contact's information should be published in a directory of school information."

Parameters:

value - The value as a String

Since:

1.5r1

setContactInfo

public void setContactInfo(ContactInfo value)

Sets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.3 ContactInfo."

Parameters:

value - A ContactInfo object

Since:

1.5r1

setContactInfo

public void setContactInfo(Name name)

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

Parameters:

name - The name of the contact person.

Since:

1.5r1

getContactInfo

public ContactInfo getContactInfo()

Gets the value of the <ContactInfo> element.

The SIF specification defines the meaning of this element as: "For a description of this element, see 5.1.3 ContactInfo."

Returns:

A ContactInfo object

Since:

1.5r1

removeContactInfo

public void removeContactInfo()

Removes the ContactInfo child element previously created by calling setContactInfo

Since:

1.5r1