com.edustructures.sifworks.common
Class ContactInfo

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ContactInfo
extends SIFKeyedElement

Common element used to supply information for a contact person at a school, LEA, or other institution.

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

ContactInfo()
Constructor

ContactInfo(Name name)
Constructor that accepts values for all mandatory fields

Method Summary

Address	getAddress() Gets the value of the <Address> element.
EmailList	getEmailList() Gets the value of the <EmailList> 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
Name	getName() Gets the value of the <Name> element.
PhoneNumberList	getPhoneNumberList() Gets the value of the <PhoneNumberList> element.
java.lang.String	getPositionTitle() Gets the value of the <PositionTitle> element.
java.lang.String	getRole() Gets the value of the <Role> element.
void	removeAddress() Removes the Address child element previously created by calling setAddress
void	removeEmailList() Removes the EmailList child element previously created by calling setEmailList
void	removeName() Removes the Name child element previously created by calling setName
void	removePhoneNumberList() Removes the PhoneNumberList child element previously created by calling setPhoneNumberList
void	setAddress(Address value) Sets the value of the <Address> element.
void	setAddress(AddressType type, Street street, java.lang.String city, StatePrCode stateProvince, CountryCode country, java.lang.String postalCode) Sets the value of the <Address> child element.
void	setEmailList(EmailList value) Sets the value of the <EmailList> element.
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	setPhoneNumberList(PhoneNumberList value) Sets the value of the <PhoneNumberList> element.
void	setPositionTitle(java.lang.String value) Sets the value of the <PositionTitle> element.
void	setRole(java.lang.String value) Sets the value of the <Role> 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

ContactInfo

public ContactInfo()

Constructor

ContactInfo

public ContactInfo(Name name)

Constructor that accepts values for all mandatory fields

Parameters:

name - The name of the contact person.

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

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 contact person."

Parameters:

value - A Name object

Since:

1.5r1

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:

1.5r1

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 contact person."

Returns:

A Name object

Since:

1.5r1

removeName

public void removeName()

Removes the Name child element previously created by calling setName

Since:

1.5r1

getPositionTitle

public java.lang.String getPositionTitle()

Gets the value of the <PositionTitle> element.

The SIF specification defines the meaning of this element as: "The contact person's position title."

Returns:

The PositionTitle element of this object.

Since:

1.5r1

setPositionTitle

public void setPositionTitle(java.lang.String value)

Sets the value of the <PositionTitle> element.

The SIF specification defines the meaning of this element as: "The contact person's position title."

Parameters:

value - A String object

Since:

1.5r1

getRole

public java.lang.String getRole()

Gets the value of the <Role> element.

The SIF specification defines the meaning of this element as: "Role played by this contact in this instance."

Returns:

The Role element of this object.

Since:

2.0

setRole

public void setRole(java.lang.String value)

Sets the value of the <Role> element.

The SIF specification defines the meaning of this element as: "Role played by this contact in this instance."

Parameters:

value - A String object

Since:

2.0

setEmailList

public void setEmailList(EmailList value)

Sets the value of the <EmailList> element.

The SIF specification defines the meaning of this element as: "List of Email elements."

Parameters:

value - A EmailList object

Since:

1.5r1

getEmailList

public EmailList getEmailList()

Gets the value of the <EmailList> element.

The SIF specification defines the meaning of this element as: "List of Email elements."

Returns:

An EmailList object

Since:

1.5r1

removeEmailList

public void removeEmailList()

Removes the EmailList child element previously created by calling setEmailList

Since:

1.5r1

setPhoneNumberList

public void setPhoneNumberList(PhoneNumberList value)

Sets the value of the <PhoneNumberList> element.

The SIF specification defines the meaning of this element as: "List of PhoneNumber elements."

Parameters:

value - A PhoneNumberList object

Since:

1.5r1

getPhoneNumberList

public PhoneNumberList getPhoneNumberList()

Gets the value of the <PhoneNumberList> element.

The SIF specification defines the meaning of this element as: "List of PhoneNumber elements."

Returns:

A PhoneNumberList object

Since:

1.5r1

removePhoneNumberList

public void removePhoneNumberList()

Removes the PhoneNumberList child element previously created by calling setPhoneNumberList

Since:

1.5r1

setAddress

public void setAddress(Address value)

Sets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "Address of the contact."

Parameters:

value - A Address object

Since:

2.0

setAddress

public void setAddress(AddressType type,
                       Street street,
                       java.lang.String city,
                       StatePrCode stateProvince,
                       CountryCode country,
                       java.lang.String postalCode)

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

Parameters:

type - Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object.

street - The street part of the address

city - The city part of the address.

stateProvince - The state or province code.

country - The country code.

postalCode - The ZIP/postal code.

Since:

2.0

getAddress

public Address getAddress()

Gets the value of the <Address> element.

The SIF specification defines the meaning of this element as: "Address of the contact."

Returns:

An Address object

Since:

2.0

removeAddress

public void removeAddress()

Removes the Address child element previously created by calling setAddress

Since:

2.0