public class ItemFilter extends Object
| Constructor and Description |
|---|
ItemFilter() |
| Modifier and Type | Method and Description |
|---|---|
void |
addOrderBy(FilterOrder fo)
Add an item property to order results by.
|
AttributeFilter |
getAttributeFilter(QName qname)
Return an AttributeFilter that matches a specific QName
|
List<AttributeFilter> |
getAttributeFilters()
List of AttributeFilters.
|
FilterCriteria |
getDisplayName() |
String |
getFilterProperty(String key)
Get a filter property
|
Integer |
getMaxResults() |
List<FilterOrder> |
getOrders() |
CollectionItem |
getParent() |
StampFilter |
getStampFilter(Class<?> clazz)
Return a specific StampFilter instance
|
List<StampFilter> |
getStampFilters()
List of StampFilters.
|
FilterCriteria |
getUid() |
void |
setDisplayName(FilterCriteria displayName)
Match items by item displayName
|
void |
setFilterProperty(String key,
String value)
Set a filter property.
|
void |
setMaxResults(Integer maxResults)
Limit the number of results returned
|
void |
setParent(CollectionItem parent)
Match items by parent
|
void |
setUid(FilterCriteria uid)
Match item by uid
|
public List<AttributeFilter> getAttributeFilters()
public AttributeFilter getAttributeFilter(QName qname)
qname - qualified namepublic StampFilter getStampFilter(Class<?> clazz)
clazz - StampFilter classpublic List<StampFilter> getStampFilters()
public FilterCriteria getDisplayName()
public void setDisplayName(FilterCriteria displayName)
displayName - displayName to matchpublic CollectionItem getParent()
public void setParent(CollectionItem parent)
parent - parent to matchpublic FilterCriteria getUid()
public void setUid(FilterCriteria uid)
uid - uid to matchpublic void setFilterProperty(String key, String value)
key - keyvalue - valuepublic String getFilterProperty(String key)
key - keypublic void addOrderBy(FilterOrder fo)
Add an item property to order results by. For now, this is only really useful when used with setMaxResults(), where you only want to return the top X items, where the items are in a certain order before the top X are chosen.
fo - public List<FilterOrder> getOrders()
public Integer getMaxResults()
public void setMaxResults(Integer maxResults)
maxResults - Copyright © 2012–2018 1&1. All rights reserved.