com.cyclonecommerce.cybervan.api
Class CompanyId

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

All Implemented Interfaces:

java.io.Serializable

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() Get a hash of the Company's or Partner's active signature cerificate.
java.lang.String	getEDIId() Deprecated. Use getId() or getIdWithoutQualifier()
java.lang.String	getEmailAddress() Deprecated.
java.lang.String	getId() Return the unique id for the Company or Partner.
java.lang.String	getIdWithoutQualifier() Get the unique id for the Company or Partner.
java.lang.String	getName() Get the Company or Partner name.
java.lang.String	getSecondaryId() Deprecated. Use getTrueId instead.
java.lang.String	getTrueId() Get the Company or Partner True Id.
void	setCertificateHash(java.lang.String _certificateHash) Sets the hash of the Company's or Partner's signing certificate.
void	setEDIId(java.lang.String _id) 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) Sets a unique, generic ID for a Company or Partner.
void	setName(java.lang.String _name) Sets the name for a Company or Partner.
void	setTrueId(java.lang.String _id) Sets the True ID of a Company.
java.lang.String	toString() Get a formatted representation of the CompanyId instance.

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 - Name of the Company or Partner.

_id - Unique Id of the partner. Should be the concatenation of EDI Qualifier and EDI Id if EDI.

Method Detail

getCertificateHash

public java.lang.String getCertificateHash()

Get a hash of the Company's or Partner's active signature cerificate.

Returns:

Returns a hash of the Company's active signing certificate

getEDIId

public java.lang.String getEDIId()

Deprecated. Use getId() or getIdWithoutQualifier()

Return the id only portion of the Company or Partner unique id. The qualifier has been stripped off.

getId

public java.lang.String getId()

Return the unique id for the Company or Partner.

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()

Deprecated.

This method has been deprecated as of the 4.1 release.

Returns:

Allways returns null.

getIdWithoutQualifier

public java.lang.String getIdWithoutQualifier()

Get the unique id for the Company or Partner. This method strips off the EDI qualifier.

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()

Get the Company or Partner name.

Returns:

Returns the name for a Company

getTrueId

public java.lang.String getTrueId()

Get the Company or Partner True Id. Usefull in rerouting scenarios where a document has been routed through a hub. The TrueId is meant to tell the id of the originating endpoint, and the final destination endpoint.

Returns:

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

getSecondaryId

public java.lang.String getSecondaryId()

Deprecated. Use getTrueId instead.

See getTrueId

Returns:

Returns the Company's secondary ID

setCertificateHash

public void setCertificateHash(java.lang.String _certificateHash)

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

Parameters:

_certificateHash -

setEDIId

public void setEDIId(java.lang.String _id)

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)

Sets a unique, generic ID for a Company or Partner. Used to set the ID independently of the EDI qualifier.

Parameters:

_id - The unique Company or Partner ID

setName

public void setName(java.lang.String _name)

Sets the name for a Company or Partner.

Parameters:

_name - The Company or Partner 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()

Get a formatted representation of the CompanyId instance.

Overrides:

toString in class java.lang.Object

Returns:

Returns a formatted version of all available information concerning a Company or Partner ID