com.cyclonecommerce.cybervan.api
Class CompanyId

java.lang.Object
  |
  +--com.cyclonecommerce.cybervan.api.CompanyId

public class CompanyId

extends java.lang.Object

implements java.io.Serializable

Represents multiple means of uniquely identifying a Company or Partner

See Also:

Serialized Form

Constructor Summary

CompanyId()
Constructor CompanyId

CompanyId(java.lang.String _name, java.lang.String _id)
Constructor CompanyId

Method Summary

java.lang.String	getCertificateHash() getCertificateHash
java.lang.String	getEDIId() Deprecated. Use getId() or getIdWithoutQualifier()
java.lang.String	getEmailAddress() this method has been deprecated as of the 4.1 release
java.lang.String	getId() getId
java.lang.String	getIdWithoutQualifier() getId
java.lang.String	getName() getName
java.lang.String	getSecondaryId() Deprecated. Use getTrueId instead.
java.lang.String	getTrueId() getTrueId
void	setCertificateHash(java.lang.String _certificateHash) setCertificateHash - Sets the hash of the Company's signing certificate.
void	setEDIId(java.lang.String _id) setEIDId - Sets the EDI ID for a Company, where the EDI ID is the concatination of the EDI Qualifier and the EDI ID
void	setEmailAddress(java.lang.String _emailAddress) Deprecated.
void	setId(java.lang.String _id) setId - Sets a unique, generic ID for a Company
void	setName(java.lang.String _name) setName - Sets the name for a Company
void	setTrueId(java.lang.String _id) Sets the True ID of a Company.
java.lang.String	toString() toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CompanyId

public CompanyId()

Constructor CompanyId

CompanyId

public CompanyId(java.lang.String _name,
                 java.lang.String _id)

Constructor CompanyId

Parameters:

_name -

_id -

Method Detail

getCertificateHash

public java.lang.String getCertificateHash()

getCertificateHash

Returns:

Returns a hash of the Company's active signing certificate

getEDIId

public java.lang.String getEDIId()

Deprecated. Use getId() or getIdWithoutQualifier()

getEDIId

getId

public java.lang.String getId()

getId

Returns:

Returns the EDI ID for a Company, where the EDI ID is the concatination of the EDI Qualifier and EDI ID

getEmailAddress

public java.lang.String getEmailAddress()

this method has been deprecated as of the 4.1 release

Returns:

Null

getIdWithoutQualifier

public java.lang.String getIdWithoutQualifier()

getId

Returns:

Returns a unique ID for a Company. If the document is an EDI document, this value represents the EDI ID

getName

public java.lang.String getName()

getName

Returns:

Returns the name for a Company

getTrueId

public java.lang.String getTrueId()

getTrueId

Returns:

Returns the True ID of the Company that sent or received the document. In Interchange 3.0 IntegrationDocument().getSenderId().getTrueID() will return the same value as getEDIID. True ID functionality is not implemented in Interchange 3.0 for Sender IDs. True ID functionality is implemented for Receiver IDs.

getSecondaryId

public java.lang.String getSecondaryId()

Deprecated. Use getTrueId instead.

getSecondaryId

Returns:

Returns the Company's secondary ID

setCertificateHash

public void setCertificateHash(java.lang.String _certificateHash)

setCertificateHash - Sets the hash of the Company's signing certificate. Intended for Interchange Server use only!

Parameters:

certificateHash -

setEDIId

public void setEDIId(java.lang.String _id)

setEIDId - Sets the EDI ID for a Company, where the EDI ID is the concatination of the EDI Qualifier and the EDI ID

Parameters:

id - The EDI ID

setEmailAddress

public void setEmailAddress(java.lang.String _emailAddress)

Deprecated.

setEmailAddress - Sets the email address for a Company. Intended for Interchange Server use only!

Parameters:

emailAddress -

setId

public void setId(java.lang.String _id)

setId - Sets a unique, generic ID for a Company

Parameters:

id - The unique ID

setName

public void setName(java.lang.String _name)

setName - Sets the name for a Company

Parameters:

name - The Company name

setTrueId

public void setTrueId(java.lang.String _id)

Sets the True ID of a Company. If a null is passed in the trueId will then be set to the ediID value. Intended for Interchange Server use only!

Parameters:

id -

toString

public java.lang.String toString()

toString

Overrides:

toString in class java.lang.Object

Returns:

Returns a formatted version of all available information concerning a Company's ID