gov.nih.nci.mageom.domain.AuditAndSecurity.impl
Class ContactImpl

java.lang.Object
  extended by gov.nih.nci.mageom.domain.impl.MAGEOMObject
      extended by gov.nih.nci.mageom.domain.impl.ExtendableImpl
          extended by gov.nih.nci.mageom.domain.impl.DescribableImpl
              extended by gov.nih.nci.mageom.domain.impl.IdentifiableImpl
                  extended by gov.nih.nci.mageom.domain.AuditAndSecurity.impl.ContactImpl
All Implemented Interfaces:
Contact, Describable, Extendable, Identifiable, java.io.Serializable
Direct Known Subclasses:
OrganizationImpl, PersonImpl

public class ContactImpl
extends IdentifiableImpl
implements Contact

A contact is either a person or an organization.

Version:
%I%, %G%
See Also:
Serialized Form

Field Summary
protected  java.lang.String address
          DOCUMENT ME
protected static java.util.ArrayList allAssociationMethods
           
protected static java.util.Hashtable associationMethods
           
protected  java.lang.String email
          DOCUMENT ME
protected  java.lang.String fax
          DOCUMENT ME
protected  java.lang.String phone
          DOCUMENT ME
protected  OntologyEntry[] roles
          DOCUMENT ME
protected  int rolesCount
          The count of OntologyEntry objects.
protected  java.lang.String tollFreePhone
          DOCUMENT ME
protected  java.lang.String URI
          DOCUMENT ME
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.IdentifiableImpl
identifier, name
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
auditTrail, auditTrailCount, descriptions, descriptionsCount, security, securityId
 
Fields inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
propertySets, propertySetsCount, securedElementId
 
Constructor Summary
ContactImpl()
          Default constructor
 
Method Summary
 java.lang.String getAddress()
          Returns the value of this Contact object's address attribute.
 java.lang.String getEmail()
          Returns the value of this Contact object's email attribute.
 java.lang.String getFax()
          Returns the value of this Contact object's fax attribute.
 java.lang.String getPhone()
          Returns the value of this Contact object's phone attribute.
 OntologyEntry[] getRoles()
          Returns the value of this Contact object's roles attribute.
 int getRolesCount()
          Returns the count of all OntologyEntry associated with this Contact object.
 java.lang.String getTollFreePhone()
          Returns the value of this Contact object's tollFreePhone attribute.
 java.lang.String getURI()
          Returns the value of this Contact object's URI attribute.
 java.util.Hashtable getXMLMethodDescriptors()
          Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.
protected  void init()
           
 Contact[] searchContacts(ContactSearchCriteria criteria)
          Returns an array of Contact objects that satisfy the given ContactSearchCriteria.
 void setAddress(java.lang.String p_address)
          Sets the address attribute.
 void setEmail(java.lang.String p_email)
          Sets the email attribute.
 void setFax(java.lang.String p_fax)
          Sets the fax attribute.
 void setPhone(java.lang.String p_phone)
          Sets the phone attribute.
 void setRoles(OntologyEntry[] p_roles)
          Sets the roles attribute.
 void setTollFreePhone(java.lang.String p_tollFreePhone)
          Sets the tollFreePhone attribute.
 void setURI(java.lang.String p_URI)
          Sets the URI attribute.
 java.lang.String toString()
          Returns a String representation of this object suitable for console display.
 org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
           
 org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc, java.util.ArrayList fillOutValues)
          Returns an XML representation of the object.
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.IdentifiableImpl
getIdentifier, getName, searchIdentifiables, setIdentifier, setName
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.DescribableImpl
getAuditTrail, getAuditTrailCount, getDescriptions, getDescriptionsCount, getSecurity, searchDescribables, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.ExtendableImpl
getPropertySets, getPropertySetsCount, getSecuredElementId, searchExtendables, setPropertySets, setSecuredElementId
 
Methods inherited from class gov.nih.nci.mageom.domain.impl.MAGEOMObject
getId, getIsEditable, setId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface gov.nih.nci.mageom.domain.Identifiable
getIdentifier, getName, setIdentifier, setName
 
Methods inherited from interface gov.nih.nci.mageom.domain.Describable
getAuditTrail, getDescriptions, getSecurity, setAuditTrail, setDescriptions, setSecurity
 
Methods inherited from interface gov.nih.nci.mageom.domain.Extendable
getPropertySets, setPropertySets
 

Field Detail

allAssociationMethods

protected static java.util.ArrayList allAssociationMethods

associationMethods

protected static java.util.Hashtable associationMethods

URI

protected java.lang.String URI
DOCUMENT ME


address

protected java.lang.String address
DOCUMENT ME


phone

protected java.lang.String phone
DOCUMENT ME


tollFreePhone

protected java.lang.String tollFreePhone
DOCUMENT ME


email

protected java.lang.String email
DOCUMENT ME


fax

protected java.lang.String fax
DOCUMENT ME


rolesCount

protected int rolesCount
The count of OntologyEntry objects.


roles

protected OntologyEntry[] roles
DOCUMENT ME

Constructor Detail

ContactImpl

public ContactImpl()
Default constructor

Method Detail

init

protected void init()
Overrides:
init in class IdentifiableImpl

searchContacts

public Contact[] searchContacts(ContactSearchCriteria criteria)
                         throws gov.nih.nci.common.search.SearchException
Returns an array of Contact objects that satisfy the given ContactSearchCriteria.

Parameters:
criteria - The ContactSearchCriteria which represents a query for Contact objects.
Returns:
An array of Contact objects.
Throws:
A - gov.nih.nci.common.search.SearchException if there is a problem searching.
gov.nih.nci.common.search.SearchException

setURI

public void setURI(java.lang.String p_URI)
Sets the URI attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setURI in interface Contact
Parameters:
p_URI - The new value for URI.
See Also:
Contact.getURI()

getURI

public java.lang.String getURI()
Description copied from interface: Contact
Returns the value of this Contact object's URI attribute. Description of URI: DOCUMENT ME!

Specified by:
getURI in interface Contact
Returns:
String The value of URI.
See Also:
Contact.getURI()

setAddress

public void setAddress(java.lang.String p_address)
Sets the address attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setAddress in interface Contact
Parameters:
p_address - The new value for address.
See Also:
Contact.getAddress()

getAddress

public java.lang.String getAddress()
Description copied from interface: Contact
Returns the value of this Contact object's address attribute. Description of address: DOCUMENT ME!

Specified by:
getAddress in interface Contact
Returns:
String The value of address.
See Also:
Contact.getAddress()

setPhone

public void setPhone(java.lang.String p_phone)
Sets the phone attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setPhone in interface Contact
Parameters:
p_phone - The new value for phone.
See Also:
Contact.getPhone()

getPhone

public java.lang.String getPhone()
Description copied from interface: Contact
Returns the value of this Contact object's phone attribute. Description of phone: DOCUMENT ME!

Specified by:
getPhone in interface Contact
Returns:
String The value of phone.
See Also:
Contact.getPhone()

setTollFreePhone

public void setTollFreePhone(java.lang.String p_tollFreePhone)
Sets the tollFreePhone attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setTollFreePhone in interface Contact
Parameters:
p_tollFreePhone - The new value for tollFreePhone.
See Also:
Contact.getTollFreePhone()

getTollFreePhone

public java.lang.String getTollFreePhone()
Description copied from interface: Contact
Returns the value of this Contact object's tollFreePhone attribute. Description of tollFreePhone: DOCUMENT ME!

Specified by:
getTollFreePhone in interface Contact
Returns:
String The value of tollFreePhone.
See Also:
Contact.getTollFreePhone()

setEmail

public void setEmail(java.lang.String p_email)
Sets the email attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setEmail in interface Contact
Parameters:
p_email - The new value for email.
See Also:
Contact.getEmail()

getEmail

public java.lang.String getEmail()
Description copied from interface: Contact
Returns the value of this Contact object's email attribute. Description of email: DOCUMENT ME!

Specified by:
getEmail in interface Contact
Returns:
String The value of email.
See Also:
Contact.getEmail()

setFax

public void setFax(java.lang.String p_fax)
Sets the fax attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setFax in interface Contact
Parameters:
p_fax - The new value for fax.
See Also:
Contact.getFax()

getFax

public java.lang.String getFax()
Description copied from interface: Contact
Returns the value of this Contact object's fax attribute. Description of fax: DOCUMENT ME!

Specified by:
getFax in interface Contact
Returns:
String The value of fax.
See Also:
Contact.getFax()

setRoles

public void setRoles(OntologyEntry[] p_roles)
Sets the roles attribute. This API is currently read-only. So, calling this method does not affect the persistent state of a Contact object.

Specified by:
setRoles in interface Contact
Parameters:
p_roles - The new value for roles.
See Also:
Contact.getRoles()

getRoles

public OntologyEntry[] getRoles()
Description copied from interface: Contact
Returns the value of this Contact object's roles attribute.

Specified by:
getRoles in interface Contact
Returns:
gov.nih.nci.mageom.bean.Description.OntologyEntry[] The value of roles.
See Also:
Contact.getRoles()

getRolesCount

public int getRolesCount()
Returns the count of all OntologyEntry associated with this Contact object.

Returns:
the count
See Also:
Contact.getRoles()

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Overrides:
toXML in class IdentifiableImpl

toXMLDoc

public org.w3c.dom.Element toXMLDoc(org.w3c.dom.Document doc)
Overrides:
toXMLDoc in class IdentifiableImpl

toXMLProcessor

public org.w3c.dom.Element toXMLProcessor(org.w3c.dom.Document doc,
                                          java.util.ArrayList fillOutValues)
Returns an XML representation of the object. The document is not modified.

Overrides:
toXMLProcessor in class IdentifiableImpl
Parameters:
doc - the working document
fillOutValues - a list of attribute names that should have full XML for their values.
Returns:
org.w3c.dom.Element an XML representation

getXMLMethodDescriptors

public java.util.Hashtable getXMLMethodDescriptors()
Returns a Hashtable containing XMLMethodDescriptors descriptors of the association methods of this object.

Overrides:
getXMLMethodDescriptors in class IdentifiableImpl
Returns:
Hashtable The Hashtable of descriptors.

toString

public java.lang.String toString()
Returns a String representation of this object suitable for console display.

Overrides:
toString in class IdentifiableImpl
Returns:
the String representation.