com.wm.app.tn.profile
Class ProfileSummary

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

All Implemented Interfaces:

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

public class ProfileSummary
extends com.wm.app.tn.util.TNFixedData

A set of important fields from a partner's profile. Trading Networks caches a ProfileSummary object for each partner in the network. The ProfileSummaries are cached in memory, so can be retrieved very quickly. ProfileSummaries cannot be saved. If you wish to change information about a partner, you can retrieve, modify and save it's Profile.

See Also:

Profile

Nested Class Summary

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

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

Constructor Summary

ProfileSummary()
Creates an empty ProfileSummary.

ProfileSummary(Corporation corp)
Creates a ProfileSummary from the Corporation component of a Profile.

Method Summary

static com.wm.data.IData	create() Creates a ProfileSummary.
java.lang.String	getCorporationName()
int	getDeliveryRetries()
int	getDeliveryWait()
java.lang.String	getDisplayName()
java.lang.String	getOrgUnitName()
java.lang.String	getPollingProtocol()
java.lang.String	getPreferredProtocol()
java.lang.String[]	getProfileGroups()
java.lang.String	getProfileID()
java.lang.String	getRemoteStatus()
int	getRetryFactor()
java.lang.String	getStatus()
java.lang.String	getSubstatus()
java.lang.String	getTNVersion()
java.lang.String	getType()
boolean	isActive()
boolean	isDeleted()
boolean	isNew()
boolean	isPending()
boolean	isRoutingOff()
boolean	isSelf()
void	setCorporationName(java.lang.String name) for internal use only
void	setDeleted(boolean del) for internal use only
void	setDeliveryRetries(short limit) for internal use only
void	setDeliveryWait(int ttw) for internal use only
void	setOrgUnitName(java.lang.String name) for internal use only
void	setPollingProtocol(java.lang.String proto) for internal use only
void	setPreferredProtocol(java.lang.String proto) for internal use only
void	setProfileGroups(java.lang.String[] groups) for internal use only
void	setProfileID(java.lang.String id) for internal use only
void	setRemoteStatus(java.lang.String rstatus) for internal use only
void	setRetryFactor(int rf) for internal use only
void	setRoutingOffStatus(boolean routing) for internal use only
void	setSelf(boolean self) for internal use only
void	setStatus(java.lang.String status) for internal use only
void	setSubstatus(java.lang.String substatus) for internal use only
void	setTNVersion(java.lang.String ver) for internal use only
void	setType(java.lang.String type) 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

ProfileSummary

public ProfileSummary()

Creates an empty ProfileSummary.

ProfileSummary

public ProfileSummary(Corporation corp)

Creates a ProfileSummary from the Corporation component of a Profile.

Method Detail

create

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

Creates a ProfileSummary. Used by the IDataCoders.

getProfileID

public final java.lang.String getProfileID()

Returns:

the internal ID for a partner

getCorporationName

public final java.lang.String getCorporationName()

Returns:

a partner's corporation name

getOrgUnitName

public final java.lang.String getOrgUnitName()

Returns:

a partner's organizational unit name

getType

public final java.lang.String getType()

Returns:

the type of technology a partner is using to connect to the trading network

getStatus

public final java.lang.String getStatus()

Returns:

a partner's status on the network

getSubstatus

public final java.lang.String getSubstatus()

Returns:

a partner's substatus on the network

getRemoteStatus

public final java.lang.String getRemoteStatus()

Returns:

your status on a partner's network

getPreferredProtocol

public final java.lang.String getPreferredProtocol()

Returns:

the protocol a partner prefers you use to send documents to it

getPollingProtocol

public final java.lang.String getPollingProtocol()

Returns:

if a partner polls you server for documents, the protocol used to poll

getTNVersion

public final java.lang.String getTNVersion()

Returns:

the version of webMethods for Trading Networks the partner is using

getDeliveryWait

public final int getDeliveryWait()

Returns:

the maximum time to wait when delivering documents to this partner

getDeliveryRetries

public final int getDeliveryRetries()

Returns:

the maximum number of retries when delivering documents to this partner

getRetryFactor

public final int getRetryFactor()

Returns:

the retry factor when delivering documents to this partner

getProfileGroups

public final java.lang.String[] getProfileGroups()

Returns:

a list of profile groups that this partner is a member of

isSelf

public final boolean isSelf()

Returns:

is the partner the host of the network?

isDeleted

public final boolean isDeleted()

Returns:

has the partner been marked deleted?

isActive

public final boolean isActive()

Returns:

is this partner active?

isNew

public final boolean isNew()

Returns:

is this partner new?

isPending

public final boolean isPending()

Returns:

is this partner pending?

getDisplayName

public final java.lang.String getDisplayName()

Returns:

a displayable name for a partner; format is "CorporationName (OrgUnitName)"

isRoutingOff

public final boolean isRoutingOff()

Returns:

is routing for this partner is switched on?

setProfileID

public final void setProfileID(java.lang.String id)

for internal use only

setCorporationName

public final void setCorporationName(java.lang.String name)

for internal use only

setOrgUnitName

public final void setOrgUnitName(java.lang.String name)

for internal use only

setType

public final void setType(java.lang.String type)

for internal use only

setSelf

public final void setSelf(boolean self)

for internal use only

setStatus

public final void setStatus(java.lang.String status)

for internal use only

setSubstatus

public final void setSubstatus(java.lang.String substatus)

for internal use only

setRemoteStatus

public final void setRemoteStatus(java.lang.String rstatus)

for internal use only

setPreferredProtocol

public final void setPreferredProtocol(java.lang.String proto)

for internal use only

setPollingProtocol

public final void setPollingProtocol(java.lang.String proto)

for internal use only

setTNVersion

public final void setTNVersion(java.lang.String ver)

for internal use only

setDeliveryRetries

public final void setDeliveryRetries(short limit)

for internal use only

setDeliveryWait

public final void setDeliveryWait(int ttw)

for internal use only

setRetryFactor

public final void setRetryFactor(int rf)

for internal use only

setProfileGroups

public final void setProfileGroups(java.lang.String[] groups)

for internal use only

setDeleted

public final void setDeleted(boolean del)

for internal use only

setRoutingOffStatus

public final void setRoutingOffStatus(boolean routing)

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 respresenting of a ProfileSummary.