Interface PartnerList
-
- All Superinterfaces:
java.lang.Cloneable,java.lang.Iterable<java.util.Map.Entry<java.lang.String,PartnerListEntry>>,java.io.Serializable
- All Known Implementing Classes:
PartnerListImpl
public interface PartnerList extends java.lang.Iterable<java.util.Map.Entry<java.lang.String,PartnerListEntry>>, java.lang.Cloneable, java.io.Serializable
Represents the backend's view of a PartnerList.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidclearList()clear the business partner listPartnerListclone()PartnerListEntrycreatePartnerListEntry()Creates an emptyPartnerListEntryDatafor the basket.PartnerListEntrycreatePartnerListEntry(TechKey partnerGUID, java.lang.String partnerId)Creates a initializedPartnerListEntryDatafor the basket.java.lang.StringgetAllToString()Get a string representation of this partnerList which is unique for these partnersPartnerListEntrygetContactData()Convenience method to Get the contact business partner, or null, if not availablejava.util.Map<java.lang.String,PartnerListEntry>getList()get the business partner listPartnerListEntrygetPartnerData(java.lang.String bpRole)Get the business partner for the given rolePartnerListEntrygetPayerData()Convenience method to Get the payer business partner, or null, if not availablePartnerListEntrygetResellerData()Convenience method to Get the reseller business partner, or null, if not availablePartnerListEntrygetSoldFromData()Convenience method to Get the contact business partner, or null, if not availablePartnerListEntrygetSoldToData()Convenience method to Get the soldto business partner, or null, if not availablevoidremovePartnerData(TechKey bpTechKey)remove the business partner with the given GUIDvoidremovePartnerData(java.lang.String bpRole)remove the business partner for the given rolevoidsetContactData(PartnerListEntry entry)Convenience method to set the contact business partnervoidsetPartnerData(java.lang.String bpRole, PartnerListEntry entry)Set the business partner for the given rolevoidsetPayerData(PartnerListEntry entry)Convenience method to set the payer business partnervoidsetSoldFromData(PartnerListEntry entry)Convenience method to set the soldfrom business partnervoidsetSoldToData(PartnerListEntry entry)Convenience method to set the soldto business partner
-
-
-
Method Detail
-
createPartnerListEntry
PartnerListEntry createPartnerListEntry()
Creates an emptyPartnerListEntryDatafor the basket.- Returns:
- PartnerListEntry which can added to the partnerList
-
createPartnerListEntry
PartnerListEntry createPartnerListEntry(TechKey partnerGUID, java.lang.String partnerId)
Creates a initializedPartnerListEntryDatafor the basket.- Parameters:
partnerGUID- techkey of the business partnerpartnerId- id of the business partner- Returns:
- PartnerListEntry which can added to the partnerList
-
getPartnerData
PartnerListEntry getPartnerData(java.lang.String bpRole)
Get the business partner for the given role- Parameters:
bpRole- String the role of the business partner- Returns:
- PartnerListEntryData of the business partner, with the given role or null if not found
-
getSoldToData
PartnerListEntry getSoldToData()
Convenience method to Get the soldto business partner, or null, if not available- Returns:
- PartnerListEntryData of the soldTo business partner, or null if not found
-
getContactData
PartnerListEntry getContactData()
Convenience method to Get the contact business partner, or null, if not available- Returns:
- PartnerListEntryData of the contact business partner, or null if not found
-
getSoldFromData
PartnerListEntry getSoldFromData()
Convenience method to Get the contact business partner, or null, if not available- Returns:
- PartnerListEntryData of the contac business partner, or null if not found
-
getResellerData
PartnerListEntry getResellerData()
Convenience method to Get the reseller business partner, or null, if not available- Returns:
- PartnerListEntryData of the reseller business partner, or null if not found
-
getPayerData
PartnerListEntry getPayerData()
Convenience method to Get the payer business partner, or null, if not available- Returns:
- PartnerListEntryData of the payer business partner, or null if not found
-
setPartnerData
void setPartnerData(java.lang.String bpRole, PartnerListEntry entry)Set the business partner for the given role- Parameters:
bpRole- String the role of the business partnerentry- the PartnerListEntry for the business partner
-
setSoldToData
void setSoldToData(PartnerListEntry entry)
Convenience method to set the soldto business partner- Parameters:
entry- of the soldTo business partner
-
setContactData
void setContactData(PartnerListEntry entry)
Convenience method to set the contact business partner- Parameters:
entry- of the contact business partner
-
setSoldFromData
void setSoldFromData(PartnerListEntry entry)
Convenience method to set the soldfrom business partner- Parameters:
entry- of the soldfrom business partner
-
setPayerData
void setPayerData(PartnerListEntry entry)
Convenience method to set the payer business partner- Parameters:
entry- of the payer business partner
-
removePartnerData
void removePartnerData(java.lang.String bpRole)
remove the business partner for the given role- Parameters:
bpRole- String the role of the business partner
-
removePartnerData
void removePartnerData(TechKey bpTechKey)
remove the business partner with the given GUID- Parameters:
bpTechKey- TechKey of the Partner, to dlete
-
clearList
void clearList()
clear the business partner list
-
clone
PartnerList clone()
- Returns:
- clone
- See Also:
Object.clone()
-
getList
java.util.Map<java.lang.String,PartnerListEntry> getList()
get the business partner list- Returns:
- MashMap list of the business partners
-
getAllToString
java.lang.String getAllToString()
Get a string representation of this partnerList which is unique for these partners- Returns:
- string
-
-