Package com.cumulocity.sdk.client.inventory

Class InventoryFilter

java.lang.Object
com.cumulocity.sdk.client.Filter
com.cumulocity.sdk.client.inventory.InventoryFilter
public class InventoryFilter extends Filter
A filter to be used in managed object queries. The setter (by*) methods return the filter itself to provide chaining: InventoryFilter filter = new InventoryFilter().byType(type).byFragmentType(fragmentType);

  • Constructor Details

    • InventoryFilter

      public InventoryFilter()

  • Method Details

    • searchInventory

      public static InventoryFilter searchInventory()

    • byFragmentType

      public InventoryFilter byFragmentType(Class<?> fragmentClass)
      Specifies the fragmentType query parameter
      Parameters:
      fragmentClass - the class representation of the type of the managed object(s)
      Returns:
      the managed object filter with fragmentType set

    • byFragmentType

      public InventoryFilter byFragmentType(String fragmentType)
      Specifies the fragmentType query parameter
      Parameters:
      fragmentType - the string representation of the type of the managed object(s)
      Returns:
      the managed object filter with fragmentType set

    • getFragmentType

      public String getFragmentType()
      Returns:
      the fragmentType parameter of the query

    • byType

      public InventoryFilter byType(String type)
      Specifies the type query parameter
      Parameters:
      type - the type of the managed object(s)
      Returns:
      the managed object filter with type set

    • getType

      public String getType()
      Returns:
      the type parameter of the query

    • byOwner

      public InventoryFilter byOwner(String owner)
      Specifies the owner query parameter
      Parameters:
      owner - the owner of the managed object(s)
      Returns:
      the managed object filter with owner set

    • getOwner

      public String getOwner()
      Returns:
      the owner parameter of the query

    • byText

      public InventoryFilter byText(String text)
      Specifies the text query parameter
      Parameters:
      text - the text of the managed object(s)
      Returns:
      the managed object filter with text set

    • getText

      public String getText()
      Returns:
      the text parameter of the query

    • byIds

      public InventoryFilter byIds(List<GId> ids)
      Specifies the ids query parameter
      Parameters:
      ids - the ids of the managed object(s)
      Returns:
      the managed object filter with ids set

    • byIds

      public InventoryFilter byIds(GId... ids)
      Specifies the ids query parameter
      Parameters:
      ids - the ids of the managed object(s)
      Returns:
      the managed object filter with ids set

    • byChildAssetId

      public InventoryFilter byChildAssetId(GId childAssetId)
      Specifies the childAssetId query parameter
      Parameters:
      childAssetId - the child asset of the managed object(s)
      Returns:
      the managed object filter with childAssetId set

    • getChildAssetId

      public String getChildAssetId()

    • byChildDeviceId

      public InventoryFilter byChildDeviceId(GId childDeviceId)
      Specifies the childDeviceId query parameter
      Parameters:
      childDeviceId - the child asset of the managed object(s)
      Returns:
      the managed object filter with childDeviceId set

    • getChildDeviceId

      public String getChildDeviceId()

    • byChildAdditionId

      public InventoryFilter byChildAdditionId(GId childAdditionId)
      Specifies the childAdditionId query parameter
      Parameters:
      childAdditionId - the child addition of the managed object(s)
      Returns:
      the managed object filter with childAdditionId set

    • getChildAdditionId

      public String getChildAdditionId()

    • getIds

      public String getIds()
      Returns:
      the ids parameter of the query