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 Summary
Constructors Constructor Description InventoryFilter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description InventoryFilter
byChildAdditionId(GId childAdditionId)
Specifies thechildAdditionId
query parameterInventoryFilter
byChildAssetId(GId childAssetId)
Specifies thechildAssetId
query parameterInventoryFilter
byChildDeviceId(GId childDeviceId)
Specifies thechildDeviceId
query parameterInventoryFilter
byFragmentType(Class<?> fragmentClass)
Specifies thefragmentType
query parameterInventoryFilter
byFragmentType(String fragmentType)
Specifies thefragmentType
query parameterInventoryFilter
byIds(GId... ids)
Specifies theids
query parameterInventoryFilter
byIds(List<GId> ids)
Specifies theids
query parameterInventoryFilter
byOwner(String owner)
Specifies theowner
query parameterInventoryFilter
byText(String text)
Specifies thetext
query parameterInventoryFilter
byType(String type)
Specifies thetype
query parameterString
getChildAdditionId()
String
getChildAssetId()
String
getChildDeviceId()
String
getFragmentType()
String
getIds()
String
getOwner()
String
getText()
String
getType()
static InventoryFilter
searchInventory()
-
Methods inherited from class com.cumulocity.sdk.client.Filter
encode, getQueryParams
-
-
-
-
Method Detail
-
searchInventory
public static InventoryFilter searchInventory()
-
byFragmentType
public InventoryFilter byFragmentType(Class<?> fragmentClass)
Specifies thefragmentType
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 thefragmentType
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 thetype
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 theowner
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 thetext
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 theids
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 theids
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 thechildAssetId
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 thechildDeviceId
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 thechildAdditionId
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
-
-