IInventoryService.Default (clover-android-sdk 293 API)

java.lang.Object
- com.clover.sdk.v3.inventory.IInventoryService.Default

All Implemented Interfaces:

IInterface, IInventoryService

Enclosing interface:

IInventoryService
```
public static class IInventoryService.Default
extends Object
implements IInventoryService
```
Default implementation for IInventoryService.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.clover.sdk.v3.inventory.IInventoryService
  IInventoryService.Default, IInventoryService.Stub

Constructor Summary

Constructors
Constructor and Description

Default()

Constructors
Constructor and Description
`Default()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addItemToCategory(String itemId, String categoryId, ResultStatus resultStatus)` Adds an item to a category.
`IBinder`	`asBinder()`
`void`	`assignCategoriesToItem(String itemId, List<String> categoryIds, ResultStatus resultStatus)` Associates categories with an item.
`void`	`assignItemsToTag(String tagId, List<String> items, ResultStatus resultStatus)` Assign a list of items (identified by their unique ID) to a tag.
`void`	`assignModifierGroupToItem(String modifierGroupId, String itemId, ResultStatus resultStatus)` Associates a modifier group with an item.
`void`	`assignOptionsToItem(String itemId, List<String> optionIds, ResultStatus resultStatus)` Associate the given options with an item.
`void`	`assignTagsToItem(String itemId, List<String> tags, ResultStatus resultStatus)` Assign a list of tags (identified by their unique ID) to an item.
`void`	`assignTagsToPrinter(String printerUid, List<String> tags, ResultStatus resultStatus)` Assign a list of tags (identified by their unique ID) to a printer.
`void`	`assignTaxRatesToItem(String itemId, List<String> taxRates, ResultStatus resultStatus)` Assign a list of tax rates (identified by their unique ID) to an item.
`void`	`bulkAssignColorToItems(List<String> itemIds, String colorHexCode, ResultStatus resultStatus)` Assign given color to list of items.
`Attribute`	`createAttribute(Attribute attribute, ResultStatus resultStatus)` Creates a new attribute.
`Category`	`createCategory(Category category, ResultStatus resultStatus)` Adds a new category.
`Discount`	`createDiscount(Discount discount, ResultStatus resultStatus)` Adds a new discount.
`Item`	`createItem(Item item, ResultStatus resultStatus)` Inserts a new item into the database.
`ItemGroup`	`createItemGroup(ItemGroup itemGroup, ResultStatus resultStatus)` Creates a new item group.
`Modifier`	`createModifier(String modifierGroupId, Modifier modifier, ResultStatus resultStatus)` Adds a new modifier.
`ModifierGroup`	`createModifierGroup(ModifierGroup group, ResultStatus resultStatus)` Adds a new modifier group.
`Option`	`createOption(Option option, ResultStatus resultStatus)` Creates a new option.
`Tag`	`createTag(Tag tag, ResultStatus resultStatus)` Creates a new tag.
`TaxRate`	`createTaxRate(TaxRate taxRate, ResultStatus resultStatus)` Creates a new tax rate.
`void`	`deleteAttribute(String attributeId, ResultStatus resultStatus)` Deletes an attribute, deletes all the options in that attribute and removes all the associations between those options and items.
`void`	`deleteCategories(List<String> categoryIds, ResultStatus resultStatus)` Bulk delete categories.
`void`	`deleteCategory(String categoryId, ResultStatus resultStatus)` Deletes an existing category.
`void`	`deleteDiscount(String discountId, ResultStatus resultStatus)` Deletes a discount.
`void`	`deleteItem(String itemId, ResultStatus resultStatus)` Deletes an existing item.
`void`	`deleteItemGroup(String itemGroupId, ResultStatus resultStatus)` Deletes an item group, but does not delete the items in a group, they become items without an item group.
`void`	`deleteItems(List<String> itemIds, ResultStatus resultStatus)` Bulk delete items.
`void`	`deleteModifier(String modifierId, ResultStatus resultStatus)` Deletes an existing modifier.
`void`	`deleteModifierGroup(String groupId, ResultStatus resultStatus)` Deletes an existing modifier group.
`void`	`deleteModifierGroups(List<String> groupIds, ResultStatus resultStatus)` Bulk delete modifier groups.
`void`	`deleteOption(String optionId, ResultStatus resultStatus)` Deletes an option and removes all the associations between that option and items.
`void`	`deleteTag(String tagId, ResultStatus resultStatus)` Deletes a tag.
`void`	`deleteTags(List<String> tagIds, ResultStatus resultStatus)` Bulk delete tags.
`void`	`deleteTaxRate(String taxRateId, ResultStatus resultStatus)` Deletes a tax rate.
`Attribute`	`getAttribute(String attributeId, ResultStatus resultStatus)` Gets a single attribute identified by its unique ID.
`List<Attribute>`	`getAttributes(ResultStatus resultStatus)` Gets all defined attributes for the merchant.
`List<Category>`	`getCategories(ResultStatus resultStatus)` Retrieve the list of categories.
`Discount`	`getDiscount(String discountId, ResultStatus resultStatus)` Gets a single discount identified by its unique ID.
`List<Discount>`	`getDiscounts(ResultStatus resultStatus)` Retrieve the list of discounts.
`Item`	`getItem(String itemId, ResultStatus resultStatus)` Retrieve an individual item using the item ID.
`ItemGroup`	`getItemGroup(String itemGroupId, ResultStatus resultStatus)` Gets a single item group identified by its unique ID.
`List<String>`	`getItemIds(ResultStatus resultStatus)` Deprecated. See note on {@link #getItems(ResultStatus).
`List<Item>`	`getItems(ResultStatus resultStatus)` Deprecated. Many merchants have a large inventory of items that cannot be retrieved in a single shot due to binder and memory limits. As a precaution always use the `InventoryContract` to retrieve the entire set of inventory items. This method will return a maximum of 500 items before returning a fault.
`List<Item>`	`getItemsForModifierGroup(String modifierGroupId, ResultStatus resultStatus)` Retrieve list of items that use the specified Modifier Group
`List<Item>`	`getItemsWithCategories(ResultStatus resultStatus)` Deprecated. See note on {@link #getItems(ResultStatus).
`Item`	`getItemWithCategories(String itemId, ResultStatus resultStatus)` Same as `getItem(String, ResultStatus)` but also includes the list of categories to which the item belongs.
`List<ModifierGroup>`	`getModifierGroups(ResultStatus resultStatus)` Retrieve the list of all modifier groups.
`List<ModifierGroup>`	`getModifierGroupsForItem(String itemId, ResultStatus resultStatus)` Retrieve the list of modifier groups for a particular item.
`List<Modifier>`	`getModifiers(String modifierGroupId, ResultStatus resultStatus)` Retrieve the list of modifiers belonging to a modifier group.
`Option`	`getOption(String optionId, ResultStatus resultStatus)` Gets a single option identified by its unique ID.
`List<Option>`	`getOptions(ResultStatus resultStatus)` Gets all defined options for the merchant.
`List<Option>`	`getOptionsForItem(String itemId, ResultStatus resultStatus)` Retrieve the list of options for an item.
`Tag`	`getTag(String tagId, ResultStatus resultStatus)` Gets a single tag identified by its unique ID.
`List<Tag>`	`getTags(ResultStatus resultStatus)` Gets all defined tags for the merchant.
`List<Tag>`	`getTagsForItem(String itemId, ResultStatus resultStatus)` Retrieve the list of tags for an item.
`List<Tag>`	`getTagsForPrinter(String printerMac, ResultStatus resultStatus)` Retrieve the list of tags for a printer.
`TaxRate`	`getTaxRate(String taxRateId, ResultStatus resultStatus)` Gets a single tax rate identified by its unique ID.
`List<TaxRate>`	`getTaxRates(ResultStatus resultStatus)` Gets all defined tax rates for the merchant.
`List<TaxRate>`	`getTaxRatesExcludedForItem(String orderTypeId, String itemId, ResultStatus resultStatus)` Retrieve the list of tax rates excluded for an item, given the order-type-id
`List<TaxRate>`	`getTaxRatesForItem(String itemId, ResultStatus resultStatus)` Retrieve the list of tax rates for an item.
`void`	`moveItemInCategoryLayout(String itemId, String categoryId, int direction, ResultStatus resultStatus)` Moves an item's position within an existing category.
`void`	`removeCategoriesFromItem(String itemId, List<String> categoryIds, ResultStatus resultStatus)` Removes categories association from an item.
`void`	`removeItemFromCategory(String itemId, String categoryId, ResultStatus resultStatus)` Removes an item from a category.
`void`	`removeItemsFromTag(String tagId, List<String> items, ResultStatus resultStatus)` Remove a list of items (identified by their unique ID) from a tag.
`void`	`removeItemStock(String itemId, ResultStatus resultStatus)` Remove stock count for an item.
`void`	`removeModifierGroupFromItem(String modifierGroupId, String itemId, ResultStatus resultStatus)` Removes a modifier group association from an item.
`void`	`removeOptionsFromItem(String itemId, List<String> optionIds, ResultStatus resultStatus)` Remove the association between the given options and an item.
`void`	`removeTagsFromItem(String itemId, List<String> tags, ResultStatus resultStatus)` Remove a list of tags (identified by their unique ID) from an item.
`void`	`removeTagsFromPrinter(String printerUid, List<String> tags, ResultStatus resultStatus)` Remove a list of tags (identified by their unique ID) from a printer.
`void`	`removeTaxRatesFromItem(String itemId, List<String> taxRates, ResultStatus resultStatus)` Remove a list of tax rates (identified by their unique ID) from an item.
`void`	`updateAttribute(Attribute attribute, ResultStatus resultStatus)` Updates an existing attribute.
`void`	`updateCategory(Category category, ResultStatus resultStatus)` Updates an existing category.
`void`	`updateCategoryItems(String categoryId, List<String> itemIds, ResultStatus resultStatus)` Updates all items of a category.
`void`	`updateCategorySortOrders(List<Category> categories, ResultStatus resultStatus)` Update category sort orders.
`void`	`updateDiscount(Discount discount, ResultStatus resultStatus)` Updates an existing discount.
`void`	`updateItem(Item item, ResultStatus resultStatus)` Updates an existing item.
`void`	`updateItemGroup(ItemGroup itemGroup, ResultStatus resultStatus)` Updates an existing item group.
`void`	`updateItemStock(String itemId, long stockCount, ResultStatus resultStatus)` Update stock count for an item.
`void`	`updateItemStockQuantity(String itemId, double quantity, ResultStatus resultStatus)` Update stock for an item.
`void`	`updateModifier(Modifier modifier, ResultStatus resultStatus)` Updates an existing modifier.
`void`	`updateModifierGroup(ModifierGroup group, ResultStatus resultStatus)` Updates an existing modifier group.
`void`	`updateModifierGroupSortOrders(List<ModifierGroup> groups, ResultStatus resultStatus)` Updates the sort orders for a list of modifier groups.
`void`	`updateModifierSortOrder(String modifierGroupId, List<String> modifierIds, ResultStatus resultStatus)` Update modifier sort order for a modifier group.
`void`	`updateOption(Option option, ResultStatus resultStatus)` Updates an existing option.
`void`	`updateTag(Tag tag, ResultStatus resultStatus)` Updates an existing tag.
`void`	`updateTaxRate(TaxRate taxRate, ResultStatus resultStatus)` Updates an existing tax rate.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- Default
```
public Default()
```

Method Detail

getItems
```
public List<Item> getItems(ResultStatus resultStatus)
                    throws RemoteException
```
Deprecated. Many merchants have a large inventory of items that cannot be retrieved in a single shot due to binder and memory limits. As a precaution always use the InventoryContract to retrieve the entire set of inventory items.
This method will return a maximum of 500 items before returning a fault.

Specified by:

getItems in interface IInventoryService

Throws:

RemoteException

getItemsWithCategories
```
public List<Item> getItemsWithCategories(ResultStatus resultStatus)
                                  throws RemoteException
```
Deprecated. See note on {@link #getItems(ResultStatus).

Specified by:

getItemsWithCategories in interface IInventoryService

Throws:

RemoteException

getItemIds
```
public List<String> getItemIds(ResultStatus resultStatus)
                        throws RemoteException
```
Deprecated. See note on {@link #getItems(ResultStatus).

Specified by:

getItemIds in interface IInventoryService

Throws:

RemoteException

getItem
```
public Item getItem(String itemId,
                    ResultStatus resultStatus)
             throws RemoteException
```
Retrieve an individual item using the item ID. If the item is not in the local database, an attempt will be made to fetch the item from the server.

Specified by:

getItem in interface IInventoryService

Throws:

RemoteException

getItemWithCategories
```
public Item getItemWithCategories(String itemId,
                                  ResultStatus resultStatus)
                           throws RemoteException
```
Same as getItem(String, ResultStatus) but also includes the list of categories to which the item belongs.

Specified by:

getItemWithCategories in interface IInventoryService

Throws:

RemoteException

createItem
```
public Item createItem(Item item,
                       ResultStatus resultStatus)
                throws RemoteException
```
Inserts a new item into the database. If the client is in offline mode, the item will be inserted into the local cache and a request to create the new item on the server will be queued until the client is online again. Returns the newly created item as it exists in the local content provider/cache.

Specified by:

createItem in interface IInventoryService

Throws:

RemoteException

updateItem
```
public void updateItem(Item item,
                       ResultStatus resultStatus)
                throws RemoteException
```
Updates an existing item. You may update the following fields: name (unless this item is in an item group), alternateName, price, priceWithoutVat, code, priceType, unitName, defaultTaxRates, cost, sku, hidden, isRevenue.

Specified by:

updateItem in interface IInventoryService

Throws:

RemoteException

deleteItem

public void deleteItem(String itemId,
                       ResultStatus resultStatus)
                throws RemoteException

Deletes an existing item.

Specified by:: deleteItem in interface IInventoryService
Throws:: RemoteException

getCategories
```
public List<Category> getCategories(ResultStatus resultStatus)
                             throws RemoteException
```
Retrieve the list of categories.
Prefer to use the InventoryContract over this method since this method will fail for large result sets that exceed binder limitations.

Specified by:

getCategories in interface IInventoryService

Throws:

RemoteException

createCategory

public Category createCategory(Category category,
                               ResultStatus resultStatus)
                        throws RemoteException

Adds a new category.

Specified by:: createCategory in interface IInventoryService
Throws:: RemoteException

updateCategory

public void updateCategory(Category category,
                           ResultStatus resultStatus)
                    throws RemoteException

Updates an existing category.

Specified by:: updateCategory in interface IInventoryService
Throws:: RemoteException

deleteCategory

public void deleteCategory(String categoryId,
                           ResultStatus resultStatus)
                    throws RemoteException

Deletes an existing category.

Specified by:: deleteCategory in interface IInventoryService
Throws:: RemoteException

addItemToCategory

public void addItemToCategory(String itemId,
                              String categoryId,
                              ResultStatus resultStatus)
                       throws RemoteException

Adds an item to a category.

Specified by:: addItemToCategory in interface IInventoryService
Throws:: RemoteException

removeItemFromCategory

public void removeItemFromCategory(String itemId,
                                   String categoryId,
                                   ResultStatus resultStatus)
                            throws RemoteException

Removes an item from a category.

Specified by:: removeItemFromCategory in interface IInventoryService
Throws:: RemoteException

moveItemInCategoryLayout

public void moveItemInCategoryLayout(String itemId,
                                     String categoryId,
                                     int direction,
                                     ResultStatus resultStatus)
                              throws RemoteException

Moves an item's position within an existing category. If 'direction' is negative, the item is moved to the left.

Specified by:: moveItemInCategoryLayout in interface IInventoryService
Throws:: RemoteException

getModifierGroups
```
public List<ModifierGroup> getModifierGroups(ResultStatus resultStatus)
                                      throws RemoteException
```
Retrieve the list of all modifier groups.
Prefer to use the InventoryContract over this method since this method will fail for very large result sets that exceed binder limitations.
Note that the returned ModifierGroup instances will not contain all the individual modifiers, invoke #getModifiers(String) to retrieve the individual modifiers for each particular ModifierGroup.

Specified by:

getModifierGroups in interface IInventoryService

Throws:

RemoteException

createModifierGroup

public ModifierGroup createModifierGroup(ModifierGroup group,
                                         ResultStatus resultStatus)
                                  throws RemoteException

Adds a new modifier group.

Specified by:: createModifierGroup in interface IInventoryService
Throws:: RemoteException

updateModifierGroup

public void updateModifierGroup(ModifierGroup group,
                                ResultStatus resultStatus)
                         throws RemoteException

Updates an existing modifier group.

Specified by:: updateModifierGroup in interface IInventoryService
Throws:: RemoteException

deleteModifierGroup

public void deleteModifierGroup(String groupId,
                                ResultStatus resultStatus)
                         throws RemoteException

Deletes an existing modifier group.

Specified by:: deleteModifierGroup in interface IInventoryService
Throws:: RemoteException

assignModifierGroupToItem

public void assignModifierGroupToItem(String modifierGroupId,
                                      String itemId,
                                      ResultStatus resultStatus)
                               throws RemoteException

Associates a modifier group with an item.

Specified by:: assignModifierGroupToItem in interface IInventoryService
Throws:: RemoteException

removeModifierGroupFromItem

public void removeModifierGroupFromItem(String modifierGroupId,
                                        String itemId,
                                        ResultStatus resultStatus)
                                 throws RemoteException

Removes a modifier group association from an item.

Specified by:: removeModifierGroupFromItem in interface IInventoryService
Throws:: RemoteException

getModifiers

public List<Modifier> getModifiers(String modifierGroupId,
                                   ResultStatus resultStatus)
                            throws RemoteException

Retrieve the list of modifiers belonging to a modifier group.

Specified by:: getModifiers in interface IInventoryService
Throws:: RemoteException

createModifier

public Modifier createModifier(String modifierGroupId,
                               Modifier modifier,
                               ResultStatus resultStatus)
                        throws RemoteException

Adds a new modifier.

Specified by:: createModifier in interface IInventoryService
Throws:: RemoteException

updateModifier

public void updateModifier(Modifier modifier,
                           ResultStatus resultStatus)
                    throws RemoteException

Updates an existing modifier.

Specified by:: updateModifier in interface IInventoryService
Throws:: RemoteException

deleteModifier

public void deleteModifier(String modifierId,
                           ResultStatus resultStatus)
                    throws RemoteException

Deletes an existing modifier.

Specified by:: deleteModifier in interface IInventoryService
Throws:: RemoteException

getTaxRatesForItem

public List<TaxRate> getTaxRatesForItem(String itemId,
                                        ResultStatus resultStatus)
                                 throws RemoteException

Retrieve the list of tax rates for an item.

Specified by:: getTaxRatesForItem in interface IInventoryService
Throws:: RemoteException

assignTaxRatesToItem

public void assignTaxRatesToItem(String itemId,
                                 List<String> taxRates,
                                 ResultStatus resultStatus)
                          throws RemoteException

Assign a list of tax rates (identified by their unique ID) to an item.

Specified by:: assignTaxRatesToItem in interface IInventoryService
Throws:: RemoteException

removeTaxRatesFromItem

public void removeTaxRatesFromItem(String itemId,
                                   List<String> taxRates,
                                   ResultStatus resultStatus)
                            throws RemoteException

Remove a list of tax rates (identified by their unique ID) from an item.

Specified by:: removeTaxRatesFromItem in interface IInventoryService
Throws:: RemoteException

getTaxRates
```
public List<TaxRate> getTaxRates(ResultStatus resultStatus)
                          throws RemoteException
```
Gets all defined tax rates for the merchant.

Specified by:

getTaxRates in interface IInventoryService

Throws:

RemoteException

getTaxRate

public TaxRate getTaxRate(String taxRateId,
                          ResultStatus resultStatus)
                   throws RemoteException

Gets a single tax rate identified by its unique ID.

Specified by:: getTaxRate in interface IInventoryService
Throws:: RemoteException

createTaxRate

public TaxRate createTaxRate(TaxRate taxRate,
                             ResultStatus resultStatus)
                      throws RemoteException

Creates a new tax rate.

Specified by:: createTaxRate in interface IInventoryService
Throws:: RemoteException

updateTaxRate

public void updateTaxRate(TaxRate taxRate,
                          ResultStatus resultStatus)
                   throws RemoteException

Updates an existing tax rate.

Specified by:: updateTaxRate in interface IInventoryService
Throws:: RemoteException

deleteTaxRate

public void deleteTaxRate(String taxRateId,
                          ResultStatus resultStatus)
                   throws RemoteException

Deletes a tax rate.

Specified by:: deleteTaxRate in interface IInventoryService
Throws:: RemoteException

getDiscounts

public List<Discount> getDiscounts(ResultStatus resultStatus)
                            throws RemoteException

Retrieve the list of discounts.

Specified by:: getDiscounts in interface IInventoryService
Throws:: RemoteException

getDiscount

public Discount getDiscount(String discountId,
                            ResultStatus resultStatus)
                     throws RemoteException

Gets a single discount identified by its unique ID.

Specified by:: getDiscount in interface IInventoryService
Throws:: RemoteException

createDiscount

public Discount createDiscount(Discount discount,
                               ResultStatus resultStatus)
                        throws RemoteException

Adds a new discount.

Specified by:: createDiscount in interface IInventoryService
Throws:: RemoteException

updateDiscount

public void updateDiscount(Discount discount,
                           ResultStatus resultStatus)
                    throws RemoteException

Updates an existing discount.

Specified by:: updateDiscount in interface IInventoryService
Throws:: RemoteException

deleteDiscount

public void deleteDiscount(String discountId,
                           ResultStatus resultStatus)
                    throws RemoteException

Deletes a discount.

Specified by:: deleteDiscount in interface IInventoryService
Throws:: RemoteException

getModifierGroupsForItem

public List<ModifierGroup> getModifierGroupsForItem(String itemId,
                                                    ResultStatus resultStatus)
                                             throws RemoteException

Retrieve the list of modifier groups for a particular item.

Specified by:: getModifierGroupsForItem in interface IInventoryService
Throws:: RemoteException

getTags
```
public List<Tag> getTags(ResultStatus resultStatus)
                  throws RemoteException
```
Gets all defined tags for the merchant.
This method will return a maximum of 500 values before returning a fault.

Specified by:

getTags in interface IInventoryService

Throws:

RemoteException

getTag

public Tag getTag(String tagId,
                  ResultStatus resultStatus)
           throws RemoteException

Gets a single tag identified by its unique ID.

Specified by:: getTag in interface IInventoryService
Throws:: RemoteException

createTag

public Tag createTag(Tag tag,
                     ResultStatus resultStatus)
              throws RemoteException

Creates a new tag.

Specified by:: createTag in interface IInventoryService
Throws:: RemoteException

updateTag

public void updateTag(Tag tag,
                      ResultStatus resultStatus)
               throws RemoteException

Updates an existing tag.

Specified by:: updateTag in interface IInventoryService
Throws:: RemoteException

deleteTag

public void deleteTag(String tagId,
                      ResultStatus resultStatus)
               throws RemoteException

Deletes a tag.

Specified by:: deleteTag in interface IInventoryService
Throws:: RemoteException

getTagsForItem

public List<Tag> getTagsForItem(String itemId,
                                ResultStatus resultStatus)
                         throws RemoteException

Retrieve the list of tags for an item.

Specified by:: getTagsForItem in interface IInventoryService
Throws:: RemoteException

assignTagsToItem

public void assignTagsToItem(String itemId,
                             List<String> tags,
                             ResultStatus resultStatus)
                      throws RemoteException

Assign a list of tags (identified by their unique ID) to an item.

Specified by:: assignTagsToItem in interface IInventoryService
Throws:: RemoteException

removeTagsFromItem

public void removeTagsFromItem(String itemId,
                               List<String> tags,
                               ResultStatus resultStatus)
                        throws RemoteException

Remove a list of tags (identified by their unique ID) from an item.

Specified by:: removeTagsFromItem in interface IInventoryService
Throws:: RemoteException

getTagsForPrinter

public List<Tag> getTagsForPrinter(String printerMac,
                                   ResultStatus resultStatus)
                            throws RemoteException

Retrieve the list of tags for a printer.

Specified by:: getTagsForPrinter in interface IInventoryService
Throws:: RemoteException

assignTagsToPrinter

public void assignTagsToPrinter(String printerUid,
                                List<String> tags,
                                ResultStatus resultStatus)
                         throws RemoteException

Assign a list of tags (identified by their unique ID) to a printer.

Specified by:: assignTagsToPrinter in interface IInventoryService
Throws:: RemoteException

removeTagsFromPrinter

public void removeTagsFromPrinter(String printerUid,
                                  List<String> tags,
                                  ResultStatus resultStatus)
                           throws RemoteException

Remove a list of tags (identified by their unique ID) from a printer.

Specified by:: removeTagsFromPrinter in interface IInventoryService
Throws:: RemoteException

assignItemsToTag

public void assignItemsToTag(String tagId,
                             List<String> items,
                             ResultStatus resultStatus)
                      throws RemoteException

Assign a list of items (identified by their unique ID) to a tag.

Specified by:: assignItemsToTag in interface IInventoryService
Throws:: RemoteException

removeItemsFromTag

public void removeItemsFromTag(String tagId,
                               List<String> items,
                               ResultStatus resultStatus)
                        throws RemoteException

Remove a list of items (identified by their unique ID) from a tag.

Specified by:: removeItemsFromTag in interface IInventoryService
Throws:: RemoteException

updateModifierSortOrder

public void updateModifierSortOrder(String modifierGroupId,
                                    List<String> modifierIds,
                                    ResultStatus resultStatus)
                             throws RemoteException

Update modifier sort order for a modifier group.

Specified by:: updateModifierSortOrder in interface IInventoryService
Throws:: RemoteException

updateItemStock
```
public void updateItemStock(String itemId,
                            long stockCount,
                            ResultStatus resultStatus)
                     throws RemoteException
```
Update stock count for an item. This is the old way of updating stock that takes a long, the new way is updateItemStockQuantity and takes a double.

Specified by:

updateItemStock in interface IInventoryService

Throws:

RemoteException

removeItemStock

public void removeItemStock(String itemId,
                            ResultStatus resultStatus)
                     throws RemoteException

Remove stock count for an item.

Specified by:: removeItemStock in interface IInventoryService
Throws:: RemoteException

getAttributes

public List<Attribute> getAttributes(ResultStatus resultStatus)
                              throws RemoteException

Gets all defined attributes for the merchant.

Prefer to use the InventoryContract over this method.

This method will return a maximum of 500 values before returning a fault.

Note that the returned Attribute instances will not contain all the individual options. To obtain the options for a particular attribute use the contract, for example:


 try (Cursor c = getContentResolver()
       .query(InventoryContract.Option.contentForItemsUriWithAccount(acct),
              null, InventoryContract.Option.ATTRIBUTE_UUID + " = ?",
              new String[] { attribute.getId() }, null)) {
     // each row in the cursor is an option for the given attribute
 }

Specified by:: getAttributes in interface IInventoryService
Throws:: RemoteException

getAttribute

public Attribute getAttribute(String attributeId,
                              ResultStatus resultStatus)
                       throws RemoteException

Gets a single attribute identified by its unique ID.

Specified by:: getAttribute in interface IInventoryService
Throws:: RemoteException

createAttribute

public Attribute createAttribute(Attribute attribute,
                                 ResultStatus resultStatus)
                          throws RemoteException

Creates a new attribute.

Specified by:: createAttribute in interface IInventoryService
Throws:: RemoteException

updateAttribute

public void updateAttribute(Attribute attribute,
                            ResultStatus resultStatus)
                     throws RemoteException

Updates an existing attribute.

Specified by:: updateAttribute in interface IInventoryService
Throws:: RemoteException

deleteAttribute
```
public void deleteAttribute(String attributeId,
                            ResultStatus resultStatus)
                     throws RemoteException
```
Deletes an attribute, deletes all the options in that attribute and removes all the associations between those options and items.

Specified by:

deleteAttribute in interface IInventoryService

Throws:

RemoteException

getOptions
```
public List<Option> getOptions(ResultStatus resultStatus)
                        throws RemoteException
```
Gets all defined options for the merchant.
Prefer to use the InventoryContract over this method.
This method will return a maximum of 500 values before returning a fault.

Specified by:

getOptions in interface IInventoryService

Throws:

RemoteException

getOption

public Option getOption(String optionId,
                        ResultStatus resultStatus)
                 throws RemoteException

Gets a single option identified by its unique ID.

Specified by:: getOption in interface IInventoryService
Throws:: RemoteException

createOption

public Option createOption(Option option,
                           ResultStatus resultStatus)
                    throws RemoteException

Creates a new option.

Specified by:: createOption in interface IInventoryService
Throws:: RemoteException

updateOption

public void updateOption(Option option,
                         ResultStatus resultStatus)
                  throws RemoteException

Updates an existing option.

Specified by:: updateOption in interface IInventoryService
Throws:: RemoteException

deleteOption

public void deleteOption(String optionId,
                         ResultStatus resultStatus)
                  throws RemoteException

Deletes an option and removes all the associations between that option and items.

Specified by:: deleteOption in interface IInventoryService
Throws:: RemoteException

getOptionsForItem

public List<Option> getOptionsForItem(String itemId,
                                      ResultStatus resultStatus)
                               throws RemoteException

Retrieve the list of options for an item.

Specified by:: getOptionsForItem in interface IInventoryService
Throws:: RemoteException

assignOptionsToItem

public void assignOptionsToItem(String itemId,
                                List<String> optionIds,
                                ResultStatus resultStatus)
                         throws RemoteException

Associate the given options with an item.

Specified by:: assignOptionsToItem in interface IInventoryService
Throws:: RemoteException

removeOptionsFromItem

public void removeOptionsFromItem(String itemId,
                                  List<String> optionIds,
                                  ResultStatus resultStatus)
                           throws RemoteException

Remove the association between the given options and an item.

Specified by:: removeOptionsFromItem in interface IInventoryService
Throws:: RemoteException

getItemGroup

public ItemGroup getItemGroup(String itemGroupId,
                              ResultStatus resultStatus)
                       throws RemoteException

Gets a single item group identified by its unique ID.

Specified by:: getItemGroup in interface IInventoryService
Throws:: RemoteException

createItemGroup

public ItemGroup createItemGroup(ItemGroup itemGroup,
                                 ResultStatus resultStatus)
                          throws RemoteException

Creates a new item group.

Specified by:: createItemGroup in interface IInventoryService
Throws:: RemoteException

updateItemGroup

public void updateItemGroup(ItemGroup itemGroup,
                            ResultStatus resultStatus)
                     throws RemoteException

Updates an existing item group.

Specified by:: updateItemGroup in interface IInventoryService
Throws:: RemoteException

deleteItemGroup
```
public void deleteItemGroup(String itemGroupId,
                            ResultStatus resultStatus)
                     throws RemoteException
```
Deletes an item group, but does not delete the items in a group, they become items without an item group.

Specified by:

deleteItemGroup in interface IInventoryService

Throws:

RemoteException

updateItemStockQuantity

public void updateItemStockQuantity(String itemId,
                                    double quantity,
                                    ResultStatus resultStatus)
                             throws RemoteException

Update stock for an item.

Specified by:: updateItemStockQuantity in interface IInventoryService
Throws:: RemoteException

updateModifierGroupSortOrders

public void updateModifierGroupSortOrders(List<ModifierGroup> groups,
                                          ResultStatus resultStatus)
                                   throws RemoteException

Updates the sort orders for a list of modifier groups.

Specified by:: updateModifierGroupSortOrders in interface IInventoryService
Throws:: RemoteException

getTaxRatesExcludedForItem

public List<TaxRate> getTaxRatesExcludedForItem(String orderTypeId,
                                                String itemId,
                                                ResultStatus resultStatus)
                                         throws RemoteException

Retrieve the list of tax rates excluded for an item, given the order-type-id

Specified by:: getTaxRatesExcludedForItem in interface IInventoryService
Throws:: RemoteException

bulkAssignColorToItems

public void bulkAssignColorToItems(List<String> itemIds,
                                   String colorHexCode,
                                   ResultStatus resultStatus)
                            throws RemoteException

Assign given color to list of items.

Specified by:: bulkAssignColorToItems in interface IInventoryService
Throws:: RemoteException

updateCategorySortOrders

public void updateCategorySortOrders(List<Category> categories,
                                     ResultStatus resultStatus)
                              throws RemoteException

Update category sort orders.

Specified by:: updateCategorySortOrders in interface IInventoryService
Throws:: RemoteException

updateCategoryItems

public void updateCategoryItems(String categoryId,
                                List<String> itemIds,
                                ResultStatus resultStatus)
                         throws RemoteException

Updates all items of a category.

Specified by:: updateCategoryItems in interface IInventoryService
Throws:: RemoteException

deleteItems

public void deleteItems(List<String> itemIds,
                        ResultStatus resultStatus)
                 throws RemoteException

Bulk delete items.

Specified by:: deleteItems in interface IInventoryService
Throws:: RemoteException

deleteCategories

public void deleteCategories(List<String> categoryIds,
                             ResultStatus resultStatus)
                      throws RemoteException

Bulk delete categories.

Specified by:: deleteCategories in interface IInventoryService
Throws:: RemoteException

deleteModifierGroups

public void deleteModifierGroups(List<String> groupIds,
                                 ResultStatus resultStatus)
                          throws RemoteException

Bulk delete modifier groups.

Specified by:: deleteModifierGroups in interface IInventoryService
Throws:: RemoteException

deleteTags

public void deleteTags(List<String> tagIds,
                       ResultStatus resultStatus)
                throws RemoteException

Bulk delete tags.

Specified by:: deleteTags in interface IInventoryService
Throws:: RemoteException

getItemsForModifierGroup

public List<Item> getItemsForModifierGroup(String modifierGroupId,
                                           ResultStatus resultStatus)
                                    throws RemoteException

Retrieve list of items that use the specified Modifier Group

Specified by:: getItemsForModifierGroup in interface IInventoryService
Throws:: RemoteException

assignCategoriesToItem

public void assignCategoriesToItem(String itemId,
                                   List<String> categoryIds,
                                   ResultStatus resultStatus)
                            throws RemoteException

Associates categories with an item.

Specified by:: assignCategoriesToItem in interface IInventoryService
Throws:: RemoteException

removeCategoriesFromItem

public void removeCategoriesFromItem(String itemId,
                                     List<String> categoryIds,
                                     ResultStatus resultStatus)
                              throws RemoteException

Removes categories association from an item.

Specified by:: removeCategoriesFromItem in interface IInventoryService
Throws:: RemoteException

asBinder
```
public IBinder asBinder()
```
Specified by:

asBinder in interface IInterface

Class IInventoryService.Default

Nested Class Summary

Nested classes/interfaces inherited from interface com.clover.sdk.v3.inventory.IInventoryService

Constructor Summary