edu.nrao.sss.model.user
Class Institution

java.lang.Object
  edu.nrao.sss.model.user.ObjectId
      edu.nrao.sss.model.user.Institution

All Implemented Interfaces:

XMLable, Serializable

public class Institution
extends ObjectId
implements XMLable

See Also:

Serialized Form

Constructor Summary

Institution()

Method Summary

void	addToAffiliatedUsers(User user)
void	addToContactCollection(Contact contact)
void	addToTypes(InstitutionType institutionType)
protected String	contactInfoXML(boolean showAll)
void	copy(edu.nrao.sss.model.user.ContactCollection contactCollection)
void	copy(edu.nrao.sss.model.user.UpdateDetails updateDetails)
boolean	equals(Object obj)
List<Contact>	getAddresses()
Set<User>	getAffiliatedUsers()
Collection<Contact>	getContactCollection()
String	getContactPerson1()
String	getContactPerson2()
List<Contact>	getContactsOfType(Contact.ContactType contactType)
AddressCountry	getCountry()
Address	getDefaultAddress()
Email	getDefaultEmail()
Fax	getDefaultFax()
Phone	getDefaultPhone()
URL	getDefaultURL()
String	getDepartmentName()
List<Contact>	getEmails()
String	getEncodedId()
EntryStatus	getEntryStatus()
List<Contact>	getFaxes()
String	getFormalName()
String	getMailingName()
String	getNameAndAcronym()
int	getParentId()
List<Contact>	getPhones()
String	getShortName()
Set<InstitutionType>	getTypes()
int	getUpdatedBy()
Date	getUpdatedOn()
List<Contact>	getURLs()
boolean	isDomestic()
void	setAffiliatedUsers(Set<User> affiliatedUsers)
void	setContactCollection(Collection<Contact> contactCollection)
void	setContactPerson1(String contactPerson1)
void	setContactPerson2(String contactPerson2)
void	setDepartmentName(String departmentName)
void	setEntryStatus(EntryStatus entryStatus)
void	setFormalName(String formalName)
void	setMailingName(String mailingName)
void	setParentId(int parentId)
void	setShortName(String shortName)
void	setTypes(Set<InstitutionType> types)
void	setUpdatedBy(int updatedBy)
void	setUpdatedOn(Date updatedOn)
String	toShortXML(boolean isDefault)
String	toXML() Provide an XML description of the object.
String	toXML(boolean showAll, boolean forUser, boolean isDefault)

Methods inherited from class edu.nrao.sss.model.user.ObjectId

getId, hashCode, isNew, setId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Institution

public Institution()

Method Detail

addToAffiliatedUsers

public void addToAffiliatedUsers(User user)

addToTypes

public void addToTypes(InstitutionType institutionType)

equals

public boolean equals(Object obj)

Specified by:

equals in class ObjectId

getAffiliatedUsers

public Set<User> getAffiliatedUsers()

getContactPerson1

public String getContactPerson1()

getContactPerson2

public String getContactPerson2()

getDepartmentName

public String getDepartmentName()

getEntryStatus

public EntryStatus getEntryStatus()

getFormalName

public String getFormalName()

getMailingName

public String getMailingName()

getNameAndAcronym

public String getNameAndAcronym()

getParentId

public int getParentId()

getShortName

public String getShortName()

getTypes

public Set<InstitutionType> getTypes()

isDomestic

public boolean isDomestic()

setAffiliatedUsers

public void setAffiliatedUsers(Set<User> affiliatedUsers)

setContactPerson1

public void setContactPerson1(String contactPerson1)

setContactPerson2

public void setContactPerson2(String contactPerson2)

setDepartmentName

public void setDepartmentName(String departmentName)

setEntryStatus

public void setEntryStatus(EntryStatus entryStatus)

setFormalName

public void setFormalName(String formalName)

setMailingName

public void setMailingName(String mailingName)

setParentId

public void setParentId(int parentId)

setShortName

public void setShortName(String shortName)

setTypes

public void setTypes(Set<InstitutionType> types)

toShortXML

public String toShortXML(boolean isDefault)

toXML

public final String toXML()

Description copied from interface: XMLable

Provide an XML description of the object.

Specified by:

toXML in interface XMLable

Returns:

a String representing the XML of the object.

toXML

public String toXML(boolean showAll,
                    boolean forUser,
                    boolean isDefault)

addToContactCollection

public void addToContactCollection(Contact contact)

copy

public void copy(edu.nrao.sss.model.user.ContactCollection contactCollection)

contactInfoXML

protected String contactInfoXML(boolean showAll)

getAddresses

public List<Contact> getAddresses()

getContactCollection

public Collection<Contact> getContactCollection()

getContactsOfType

public List<Contact> getContactsOfType(Contact.ContactType contactType)

getCountry

public AddressCountry getCountry()

getDefaultAddress

public Address getDefaultAddress()

getDefaultEmail

public Email getDefaultEmail()

getDefaultFax

public Fax getDefaultFax()

getDefaultPhone

public Phone getDefaultPhone()

getDefaultURL

public URL getDefaultURL()

getEmails

public List<Contact> getEmails()

getFaxes

public List<Contact> getFaxes()

getPhones

public List<Contact> getPhones()

getURLs

public List<Contact> getURLs()

setContactCollection

public void setContactCollection(Collection<Contact> contactCollection)

getEncodedId

public String getEncodedId()

getUpdatedBy

public int getUpdatedBy()

getUpdatedOn

public Date getUpdatedOn()

copy

public void copy(edu.nrao.sss.model.user.UpdateDetails updateDetails)

setUpdatedBy

public void setUpdatedBy(int updatedBy)
                  throws IllegalArgumentException

Throws:

IllegalArgumentException

setUpdatedOn

public void setUpdatedOn(Date updatedOn)
                  throws NullPointerException

Throws:

NullPointerException