com.wm.app.tn.profile
Class Contact

java.lang.Object
  extended by com.wm.app.tn.util.TNFixedData
      extended by com.wm.app.tn.profile.Contact
All Implemented Interfaces:
FieldGroup, com.wm.data.IData, java.lang.Cloneable

public class Contact
extends TNFixedData
implements FieldGroup

A Contact for a partner on the trading network. Trading Networks is distributed with two types of Contacts, Technical and Administrative. Additional contact types can be added using the wm.tn.dictionary:addContactType service. The set of available contact types may be obtained with the wm.tn.dictionary:getContactTypes service.

The Contact contains an Address, which may be obtained by calling getAddress.

See Also:
Address

Nested Class Summary
 
Nested classes/interfaces inherited from class com.wm.app.tn.util.TNFixedData
TNFixedData.TreeCursor
 
Constructor Summary
Contact()
          Creates a Contact.
 
Method Summary
static java.lang.Object[][] contactSchema()
           
static com.wm.data.IData create()
          Creates a Contact.
 Address getAddress()
           
 java.lang.String getContactID()
           
 java.lang.String getEmail()
           
 java.lang.String getErrorTemplate()
          for internal use only
 java.lang.String getFaxNo()
           
 java.lang.String getGivenName()
           
 int getID()
           
 java.lang.String getName()
           
 java.lang.String getPagerNo()
           
 java.lang.String getPartnerID()
           
 java.lang.String getRole()
           
 short getSeqNo()
           
 java.lang.String getSurname()
           
 java.lang.String getTelExt()
           
 java.lang.String getTelNo()
           
 short getType()
           
 java.lang.String getTypeName()
          For INTERNAL use only.
 void setAddress(Address addr)
          Sets the Contact's Address
 void setContactID(java.lang.String s)
          do not use - Contact ID is internally generated
 void setEmail(java.lang.String s)
          Sets the Contact's email address
 void setFaxNo(java.lang.String s)
          Sets the Contact's fax number
 void setGivenName(java.lang.String s)
          Sets the Contact's given name.
 void setIData(com.wm.data.IData data)
           
 void setPagerNo(java.lang.String s)
          Sets the Contact's pager number
 void setPartnerID(java.lang.String s)
          Use this to indicate which partner this Contact belongs to.
 void setRole(java.lang.String s)
          Sets the Contact's role within the partner organization.
 void setSeqNo(short s)
          Sets the Contact's sequence number.
 void setSurname(java.lang.String s)
          Sets the Contact's surname.
 void setTelExt(java.lang.String s)
          Sets the Contact's telephone extension
 void setTelNo(java.lang.String s)
          Sets the Contact's telephone number
 void setType(short s)
          Sets the type of Contact.
 void setTypeName(java.lang.String s)
          For INTERNAL use only.
 java.lang.String toString()
          Default toString implementation returns class name followed by contents.
 
Methods inherited from class com.wm.app.tn.util.TNFixedData
clone, dataSize, get, get, getCursor, getHashCursor, getIndexCursor, getKey, getSharedCursor, getTreeCursor, indexOf, merge, set, set
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Contact

public Contact()
Creates a Contact.

Method Detail

create

public static com.wm.data.IData create()
Creates a Contact. Used by the IDataCoders.


contactSchema

public static java.lang.Object[][] contactSchema()
Returns:
the internal FixedData structure.

getName

public final java.lang.String getName()
Returns:
the name of the Contact group.

getID

public final int getID()
Specified by:
getID in interface FieldGroup
Returns:
the ID of the Contact group.
See Also:
Constants

getPartnerID

public final java.lang.String getPartnerID()
Returns:
the internal webMethods ID for the partner

getContactID

public final java.lang.String getContactID()
Returns:
the internal webMethods ID for the Contact

getGivenName

public final java.lang.String getGivenName()
Returns:
the Contact's given name

getSurname

public final java.lang.String getSurname()
Returns:
the Contact's last name

getSeqNo

public final short getSeqNo()
Returns:
the sequence number for this Contact. The TN Console uses this to display Contacts in the correct order.

getType

public final short getType()
Returns:
the type of Contact. Possible values "out of the box" are Technical and Administrative.

getRole

public final java.lang.String getRole()
Returns:
the Contact's role withing the partner organization

getEmail

public final java.lang.String getEmail()
Returns:
the Contact's email address

getTelNo

public final java.lang.String getTelNo()
Returns:
the Contact's telephone number

getTelExt

public final java.lang.String getTelExt()
Returns:
the Contact's telephone extension

getPagerNo

public final java.lang.String getPagerNo()
Returns:
the Contact's pager extension

getFaxNo

public final java.lang.String getFaxNo()
Returns:
the Contact's fax extension

getAddress

public final Address getAddress()
Returns:
the Contact's Address
See Also:
Address

getTypeName

public final java.lang.String getTypeName()
For INTERNAL use only. May return null most of the times


setPartnerID

public final void setPartnerID(java.lang.String s)
Use this to indicate which partner this Contact belongs to.

Parameters:
s - the partner's internal webMethods ID

setContactID

public final void setContactID(java.lang.String s)
do not use - Contact ID is internally generated


setGivenName

public final void setGivenName(java.lang.String s)
Sets the Contact's given name.


setSurname

public final void setSurname(java.lang.String s)
Sets the Contact's surname.


setSeqNo

public final void setSeqNo(short s)
Sets the Contact's sequence number. Used by the TN Console to display the Contacts in the correct order.


setType

public final void setType(short s)
Sets the type of Contact. Possible values "out of the box" are Technical and Administrative


setRole

public final void setRole(java.lang.String s)
Sets the Contact's role within the partner organization.


setEmail

public final void setEmail(java.lang.String s)
Sets the Contact's email address


setTelNo

public final void setTelNo(java.lang.String s)
Sets the Contact's telephone number


setTelExt

public final void setTelExt(java.lang.String s)
Sets the Contact's telephone extension


setPagerNo

public final void setPagerNo(java.lang.String s)
Sets the Contact's pager number


setFaxNo

public final void setFaxNo(java.lang.String s)
Sets the Contact's fax number


setAddress

public final void setAddress(Address addr)
Sets the Contact's Address

See Also:
Address

setTypeName

public final void setTypeName(java.lang.String s)
For INTERNAL use only.


toString

public final java.lang.String toString()
Description copied from class: TNFixedData
Default toString implementation returns class name followed by contents.

Overrides:
toString in class TNFixedData
Returns:
a String representing a Contact

getErrorTemplate

public final java.lang.String getErrorTemplate()
Description copied from interface: FieldGroup
for internal use only

Specified by:
getErrorTemplate in interface FieldGroup
Returns:
a template for formatting error messages.

setIData

public void setIData(com.wm.data.IData data)