Package dev.getelements.elements.sdk.service.inventory

Interface DistinctInventoryItemService

All Known Implementing Classes:
SuperUserDistinctInventoryItemService, UserDistinctInventoryItemService
public interface DistinctInventoryItemService
Manages distinct items in the

  • Method Details

    • createDistinctInventoryItem

      DistinctInventoryItem createDistinctInventoryItem(String userId, String profileId, String itemId, Map<String,Object> metadata)
      Creates a distinct inventory item, specifying the user, profile, and item id. Distinct inventory items may be owned at either the profile or the user level and may be transferred. When creating one, another, or both may be specified. However the profile, when specified, must match the user id.
      Parameters:
      userId - the user id owning the item, may be null if profile id is specified
      profileId - the profile of the profile owning the item, may be null if hte user id is specified
      itemId - the item id, must not be null
      metadata - the metadata, may be null
      Returns:
      the DistinctInventoryItem as it was written to the database.

    • getDistinctInventoryItem

      DistinctInventoryItem getDistinctInventoryItem(String itemNameOrId)
      Gets a specific distinct inventory item from the database.
      Parameters:
      itemNameOrId - the item name or id
      Returns:
      the distinct item

    • getDistinctInventoryItems

      Pagination<DistinctInventoryItem> getDistinctInventoryItems(int offset, int count, String userId, String profileId)
      Gets a listing of distinct inventory items from the database.
      Parameters:
      offset - the offset from the beginning of the dataset
      count - the count
      userId - the userid, may be null,
      Returns:
      a pagination of inventory items.

    • getDistinctInventoryItems

      Pagination<DistinctInventoryItem> getDistinctInventoryItems(int offset, int count, String userId, String profileId, String query)
      Gets a listing of distinct inventory items from the database.
      Parameters:
      offset - the offset from the beginning of the dataset
      count - the count
      userId - the userid, may be null,
      Returns:
      a pagination of inventory items.

    • updateDistinctInventoryItem

      DistinctInventoryItem updateDistinctInventoryItem(String distinctInventoryItemId, String userId, String profileId, Map<String,Object> metadata)
      Updates a distinct inventory item.
      Parameters:
      distinctInventoryItemId -
      userId -
      profileId -
      metadata -
      Returns:

    • deleteInventoryItem

      void deleteInventoryItem(String inventoryItemId)
      Deletes a specific distinct inventory item id.
      Parameters:
      inventoryItemId -