All Superinterfaces:
Cloneable, Iterable<Map.Entry<String,PartnerListEntry>>, Serializable
All Known Implementing Classes:
PartnerListImpl

public interface PartnerList extends Iterable<Map.Entry<String,PartnerListEntry>>, Cloneable, Serializable
Represents the backend's view of a PartnerList.
  • Method Details

    • createPartnerListEntry

      PartnerListEntry createPartnerListEntry()
      Creates an empty PartnerListEntryData for the basket.
      Returns:
      PartnerListEntry which can added to the partnerList
    • createPartnerListEntry

      PartnerListEntry createPartnerListEntry(TechKey partnerGUID, String partnerId)
      Creates a initialized PartnerListEntryData for the basket.
      Parameters:
      partnerGUID - techkey of the business partner
      partnerId - id of the business partner
      Returns:
      PartnerListEntry which can added to the partnerList
    • getPartnerData

      PartnerListEntry getPartnerData(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(String bpRole, PartnerListEntry entry)
      Set the business partner for the given role
      Parameters:
      bpRole - String the role of the business partner
      entry - 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(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:
    • getList

      get the business partner list
      Returns:
      MashMap list of the business partners
    • getAllToString

      String getAllToString()
      Get a string representation of this partnerList which is unique for these partners
      Returns:
      string