Package de.hybris.platform.b2ctelcofacades.address

Interface TmaAddressFacade

All Known Implementing Classes:
DefaultTmaAddressFacade
public interface TmaAddressFacade
Address facade handling address related operations in TMU.
Since:
2007

  • Method Details

    • getAddress

      AddressData getAddress(String id, String relatedPartyId)
      Retrieves given address from id for the provided user id.
      Parameters:
      id - the id
      relatedPartyId - the related party ID
      Returns:
      the specific address for user if it belongs to user otherwise null

    • getAddress

      AddressData getAddress(String id)
      Retrieves given address from id.
      Parameters:
      id - the id of the address.
      Returns:
      the specific address for the given id.

    • getAddressValidation

      AddressData getAddressValidation(String id)
      Retrieves given address validation from id.
      Parameters:
      id - the id of the address validation
      Returns:
      the specific address validation for the given id.

    • getAddressValidation

      AddressData getAddressValidation(String id, String relatedPartyID)
      Retrieves given address validation from id and relatedPartyId.
      Parameters:
      id - the id of the address validation
      relatedPartyID - the related party ID
      Returns:
      the specific address validation for the given id.

    • getAddressesValidationsByOffsetAndLimit

      List<AddressData> getAddressesValidationsByOffsetAndLimit(Integer offset, Integer limit)
      Retrieves a list of address validations filtered by offset and limit.
      Parameters:
      offset - the offset
      limit - the limit
      Returns:
      the list of address validations filtered by offset and limit.

    • updateAddress

      AddressData updateAddress(AddressData addressData, String addressId, String userId)
      Updates a AddressData for the provided user.
      Parameters:
      addressData - The address data
      addressId - The identifier of the address
      userId - The identifier of the address
      Returns:
      AddressData which was updated

    • removeAddress

      boolean removeAddress(String userId, String addressId)
      Delete given address for the provided user id.
      Parameters:
      userId - The identifier of the user
      addressId - The addressId
      Returns:
      True if record is deleted and False in case. no record deletion

    • getAddressesByOffsetAndLimit

      List<AddressData> getAddressesByOffsetAndLimit(Integer offset, Integer limit)
      Retrieves a list of addresses filtered by offset and limit.
      Parameters:
      offset - the offset
      limit - the limit
      Returns:
      the list of addresses filtered by offset and limit.

    • getSubAddress

      AddressData getSubAddress(String id, String geographicAddressId, String relatedPartyId)
      Retrieves given sub address from id for the provided geographic address id.
      Parameters:
      id - the id of Sub Address
      geographicAddressId - the Geographic Address ID
      relatedPartyId - the related party ID
      Returns:
      the specific address for user if it belongs to user otherwise null

    • getSubAddress

      AddressData getSubAddress(String id, String geographicAddressId)
      Retrieves given sub address from id for the provided geographic address id.
      Parameters:
      id - the id of Sub Address
      geographicAddressId - the Geographic Address ID
      Returns:
      the specific sub address for the given geographic address and sub address id.

    • getSubAddresses

      List<AddressData> getSubAddresses(String geographicAddressId)
      Retrieves a list of sub addresses for the provided geographic address id.
      Parameters:
      geographicAddressId - the Geographic Address ID
      Returns:
      the list of sub addresses

    • getSubAddresses

      List<AddressData> getSubAddresses(String geographicAddressId, String relatedPartyId)
      Retrieves a list of sub addresses for the provided geographic address id and user id.
      Parameters:
      geographicAddressId - the Geographic Address ID
      relatedPartyId - the related party ID
      Returns:
      the list of specific sub addresses if belongs to user otherwise null