com.wm.app.tn.profile
Class ID

java.lang.Object
  com.wm.app.tn.util.TNFixedData
      com.wm.app.tn.profile.ID

All Implemented Interfaces:

FieldGroup, com.wm.data.IData, java.lang.Cloneable

public class ID
extends com.wm.app.tn.util.TNFixedData
implements FieldGroup

An external ID for a partner (e.g. DUNS, EULER, User defined 1).

Typically, a partner will use an external ID to identify itself in a business document.

Nested Class Summary

Nested classes/interfaces inherited from class com.wm.app.tn.util.TNFixedData

com.wm.app.tn.util.TNFixedData.TreeCursor

Constructor Summary

ID()
Creates an ID.

Method Summary

static com.wm.data.IData	create() Creates an ID.
java.lang.String	getErrorTemplate() for internal use only
java.lang.String	getExternalID()
int	getID()
java.lang.String	getIDKey()
int	getIDType()
java.lang.String	getIDTypeName() for internal use only
java.lang.String	getInternalID()
java.lang.String	getName()
short	getSeqNo() Used by the TN Console to display the external IDs for a partner in the correct order
static java.lang.Object[][]	idSchema()
void	setExternalID(java.lang.String s) Sets the value of this external ID.
void	setIDKey(java.lang.String s) for internal use only
void	setIDType(int i) Sets the type of external ID this ID object represents.
void	setIDTypeName(java.lang.String s) for internal use only
void	setInternalID(java.lang.String s) Assigns this external ID to a partner on the Trading Network.
void	setSeqNo(short s)
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

ID

public ID()

Creates an ID.

Method Detail

create

public static com.wm.data.IData create()

Creates an ID. Used by the IDataCoders.

idSchema

public static java.lang.Object[][] idSchema()

Returns:

the internal FixedData structure.

getName

public final java.lang.String getName()

Returns:

the name of the ID group.

getID

public final int getID()

Specified by:

getID in interface FieldGroup

Returns:

the ID of the ID group.

See Also:

Constants

getIDType

public final int getIDType()

Returns:

an integer representing the type of external ID (eg: DUNS, DUNS+4, EULER). You can use LookupStore.getExternalIDTypes to retrieve the interger value and description for all ID types known to Trading Networks.

See Also:

LookupStore.getExternalIDTypes()

getExternalID

public final java.lang.String getExternalID()

Returns:

the value of the external ID a for a partner

getInternalID

public final java.lang.String getInternalID()

Returns:

the webMethods internal ID for a partner

getSeqNo

public final short getSeqNo()

Used by the TN Console to display the external IDs for a partner in the correct order

getIDKey

public final java.lang.String getIDKey()

Returns:

the internally generated key for a this external ID

getIDTypeName

public final java.lang.String getIDTypeName()

for internal use only

setIDType

public final void setIDType(int i)

Sets the type of external ID this ID object represents.

Parameters:

an - integer representing the type of external ID (eg: DUNS, DUNS+4, EULER). You can use LookupStore.getExternalIDTypes to retrieve the interger value and description for all ID types known to Trading Networks.

See Also:

LookupStore.getExternalIDTypes()

setExternalID

public final void setExternalID(java.lang.String s)

Sets the value of this external ID.

Parameters:

the - value of the external ID. If this is a DUNS ID (for example), pass the DUNS number in this parameter.

setInternalID

public final void setInternalID(java.lang.String s)

Assigns this external ID to a partner on the Trading Network.

Parameters:

a - webMethods internal partner ID

setSeqNo

public final void setSeqNo(short s)

Parameters:

the - sequence number of this ID, relative to other eexternal IDs for this partner.

setIDKey

public final void setIDKey(java.lang.String s)

for internal use only

setIDTypeName

public final void setIDTypeName(java.lang.String s)

for internal use only

toString

public final java.lang.String toString()

Description copied from class: com.wm.app.tn.util.TNFixedData

Default toString implementation returns class name followed by contents.

Overrides:

toString in class com.wm.app.tn.util.TNFixedData

Returns:

a String representation of the external ID

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.