com.edustructures.sifworks.instr
Class SourceAuthor

java.lang.Object
  extended by com.edustructures.sifworks.Element
      extended by com.edustructures.sifworks.SIFElement
          extended by com.edustructures.sifworks.instr.SourceAuthor
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable

public class SourceAuthor
extends SIFElement

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
SourceAuthor()
          Constructor
 
Method Summary
 Address getAddress()
          Gets the value of the <Address> element.
 Email getEmail()
          Gets the value of the <Email> element.
 Name getName()
          Gets the value of the <Name> element.
 java.lang.String getOrganization()
          Gets the value of the <Organization> element.
 void removeAddress()
          Removes the Address child element previously created by calling setAddress
 void removeEmail()
          Removes the Email child element previously created by calling setEmail
 void removeName()
          Removes the Name child element previously created by calling setName
 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 setEmail(Email value)
          Sets the value of the <Email> element.
 void setEmail(EmailType type, java.lang.String value)
          Sets the value of the <Email> child 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 setOrganization(java.lang.String value)
          Sets the value of the <Organization> 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, getKey, 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

SourceAuthor

public SourceAuthor()
Constructor

Method Detail

setName

public void setName(Name value)
Sets the value of the <Name> element.

The SIF specification defines the meaning of this element as: "Name of the author."

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: "Name of the author."

Returns:
A Name object
Since:
1.5r1

removeName

public void removeName()
Removes the Name child element previously created by calling setName

Since:
1.5r1

getOrganization

public java.lang.String getOrganization()
Gets the value of the <Organization> element.

The SIF specification defines the meaning of this element as: "Organization name."

Returns:
The Organization element of this object.
Since:
1.5r1

setOrganization

public void setOrganization(java.lang.String value)
Sets the value of the <Organization> element.

The SIF specification defines the meaning of this element as: "Organization name."

Parameters:
value - A String object
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 author."

Parameters:
value - A Address object
Since:
1.5r1

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:
1.5r1

getAddress

public Address getAddress()
Gets the value of the <Address> element.

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

Returns:
An Address object
Since:
1.5r1

removeAddress

public void removeAddress()
Removes the Address child element previously created by calling setAddress

Since:
1.5r1

setEmail

public void setEmail(Email value)
Sets the value of the <Email> element.

The SIF specification defines the meaning of this element as: "Email address of the author."

Parameters:
value - A Email object
Since:
1.5r1

setEmail

public void setEmail(EmailType type,
                     java.lang.String value)
Sets the value of the <Email> child element. This form of setEmail is provided as a convenience method that is functionally equivalent to the version of setEmail that accepts a single Email object.

Parameters:
type - This attribute specifies the type of e-mail address.
value - Gets or sets the content value of the <Email> element
Since:
1.5r1

getEmail

public Email getEmail()
Gets the value of the <Email> element.

The SIF specification defines the meaning of this element as: "Email address of the author."

Returns:
An Email object
Since:
1.5r1

removeEmail

public void removeEmail()
Removes the Email child element previously created by calling setEmail

Since:
1.5r1


Copyright © 2001-2007 Edustructures LLC. All Rights Reserved. SIFWorks® and ADK® are registered trademarks of Edustructures LLC. SIF™ and Schools Interoperability Framework are trademarks of the Schools Interoperability Framework Association.