com.sap.aii.af.service.cpa

Interface PartyIdentifier

All Superinterfaces:
Comparable<CPAObject>, CPAObject

public interface PartyIdentifier
extends CPAObject

The CPA Cache service API allows adapter implementations to retrieve their adapter specific configuration (CPA objects) from the local persistent and in-memory cache. The adapter specific configuration data is maintained either using the Integration Directory, or the PCK configuration UI. Independent from the scenario (central/decental AdapterFramework or PCK), the configuration objects can be retrieved with the LookupManager singleton class. For detailed documentation read the JavaDoc of that class. A list of all known configuration objects is available through the typed CPAObjectType enumeration class, which can be used in combination with the LookupManager.

The PartyIdentifier represents an alternative identifier for an XI internal Party notation, as maintained in the Integration Directory (or the PCK configuration UI). If an adapter handles messages where the B2B Party identifiers or Service names (in the external messaging format/protocol) are different from the XI internal notation, the adapter must use the NormalizationManager singleton class to normalize and denormalize the external Party and Service formats (e.g. DUNS, DDID) to and from the XI internal notation. This step is required, since the Inbound/Outbound runtime lookup can only be performed using the XI internal notation of Partys and Services, as configured in the Integration Directory (or PCK UI).

See Also:
NormalizationManager, Party, Service, ServiceIdentifier

Method Summary
 String getParty()
           Returns the XI internal party name.
 String getPartyAgency()
          Returns the party agency value for the XI external alternative party identifier.
 String getPartyIdentifier()
          Returns the XI external alternative party identifier.
 String getPartySchema()
          Returns the party schema value for the XI external alternative party identifier.
 
Methods inherited from interface com.sap.aii.af.service.cpa.CPAObject
getObjectId, getObjectName, getObjectType, getStringRepresentation, getValue, getValueAsBinary, getValueAsBoolean, getValueAsDate, getValueAsInt, getValueAsIntObject, getValueAsLong, getValueAsLongObject, getValueAsString, getValueAsTable, getValueAsTimestamp, isPassword
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Method Detail

getParty

String getParty()

Returns the XI internal party name.
The PartyIdentifier contains four relevant fields: 1) The XI internal party name 2/3/4) the external party name and for which agency and schema the alternative XI external party identifier is expressed (e.g. XI Party: BMW, PartAgency: NamingAgencyX PartySchema: DUNS, PartyIdentifier: DUNS1234).
The PartyIdentifier object is to be retrieved using the NormalizationManager.

Returns:
The Party value.
See Also:
getPartyAgency(), getPartySchema(), getPartyIdentifier()

getPartyAgency

String getPartyAgency()
Returns the party agency value for the XI external alternative party identifier.

Returns:
The PartyAgency value.
See Also:
getParty()

getPartySchema

String getPartySchema()
Returns the party schema value for the XI external alternative party identifier.

Returns:
The PartySchema value.
See Also:
getParty()

getPartyIdentifier

String getPartyIdentifier()
Returns the XI external alternative party identifier.

Returns:
The PartyIdentifier value.
See Also:
getParty()
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] SAP_XIAF [sap.com] com.sap.aii.af.svc.facade api BC-XI


Copyright 2014 SAP AG Complete Copyright Notice