|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface OperationContext
An OperationContext
object defines the filtering, paging and
caching of an operation.
Method Summary | |
---|---|
String |
getCacheKey()
Returns a key for this OperationContext object that is used for caching. |
Set<String> |
getFilter()
Returns the current filter. |
String |
getFilterString()
Returns the filter extended by cmis:objectId, cmis:objectTypeId and cmis:baseTypeId. |
IncludeRelationships |
getIncludeRelationships()
Returns which relationships should be returned. |
int |
getMaxItemsPerPage()
Returns the current max number of items per page. |
String |
getOrderBy()
Returns the order by rule for operations that return lists. |
Set<String> |
getRenditionFilter()
Returns the current rendition filter. |
String |
getRenditionFilterString()
Returns the current rendition filter. |
boolean |
isCacheEnabled()
Return if caching is enabled. |
boolean |
isIncludeAcls()
Returns if ACLs should returned. |
boolean |
isIncludeAllowableActions()
Returns if allowable actions should returned. |
boolean |
isIncludePathSegments()
Returns if path segments should returned. |
boolean |
isIncludePolicies()
Returns if policies should returned. |
void |
setCacheEnabled(boolean cacheEnabled)
Enables or disables the cache. |
void |
setFilter(Set<String> propertyFilter)
Sets the current filter. |
void |
setFilterString(String propertyFilter)
Sets the current filter. |
void |
setIncludeAcls(boolean include)
Sets if ACLs should returned. |
void |
setIncludeAllowableActions(boolean include)
Sets if allowable actions should returned. |
void |
setIncludePathSegments(boolean include)
Sets if path segments should returned. |
void |
setIncludePolicies(boolean include)
Sets if policies should returned. |
void |
setIncludeRelationships(IncludeRelationships include)
Sets which relationships should be returned. |
void |
setMaxItemsPerPage(int maxItemsPerPage)
Set the max number of items per page for operations that return lists. |
void |
setOrderBy(String orderBy)
Sets the order by rule for operations that return lists. |
void |
setRenditionFilter(Set<String> renditionFilter)
Sets the current rendition filter. |
void |
setRenditionFilterString(String renditionFilter)
Sets the current rendition filter. |
Method Detail |
---|
Set<String> getFilter()
void setFilter(Set<String> propertyFilter)
propertyFilter
- a set of query namesvoid setFilterString(String propertyFilter)
propertyFilter
- a comma separated list of query namesString getFilterString()
boolean isIncludeAllowableActions()
void setIncludeAllowableActions(boolean include)
boolean isIncludeAcls()
void setIncludeAcls(boolean include)
IncludeRelationships getIncludeRelationships()
void setIncludeRelationships(IncludeRelationships include)
boolean isIncludePolicies()
void setIncludePolicies(boolean include)
Set<String> getRenditionFilter()
void setRenditionFilter(Set<String> renditionFilter)
renditionFilter
- a set of rendition filter termsvoid setRenditionFilterString(String renditionFilter)
renditionFilter
- a comma separated list of rendition filter termsString getRenditionFilterString()
boolean isIncludePathSegments()
void setIncludePathSegments(boolean include)
String getOrderBy()
void setOrderBy(String orderBy)
orderBy
- a comma-separated list of query names and the
ascending modifier "ASC" or the descending modifier "DESC" for
each query nameboolean isCacheEnabled()
void setCacheEnabled(boolean cacheEnabled)
String getCacheKey()
void setMaxItemsPerPage(int maxItemsPerPage)
maxItemsPerPage
- max number of items (must be >0)int getMaxItemsPerPage()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |