OperationContext (Apache Chemistry OpenCMIS 0.9.0)

All Superinterfaces:

Serializable
```
public interface OperationContext
extends Serializable
```
An OperationContext object defines the filtering, paging and caching of an operation.

Method Summary

Methods
Modifier and Type	Method and Description
`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 batch.
`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.
`boolean`	`loadSecondaryTypeProperties()` Returns is secondary type properties should be loaded.
`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`	`setLoadSecondaryTypeProperties(boolean load)` Sets if secondary type properties should be loaded.
`void`	`setMaxItemsPerPage(int maxItemsPerPage)` Set the max number of items per batch 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
  - getFilter
```
Set<String> getFilter()
```
    Returns the current filter.
    
    Returns:
    a set of query names
  - setFilter
```
void setFilter(Set<String> propertyFilter)
```
    Sets the current filter.
    
    Parameters:
    propertyFilter - a set of query names
  - setFilterString
```
void setFilterString(String propertyFilter)
```
    Sets the current filter.
    
    Parameters:
    propertyFilter - a comma separated list of query names
  - getFilterString
```
String getFilterString()
```
    Returns the filter extended by cmis:objectId, cmis:objectTypeId and cmis:baseTypeId.
  - setLoadSecondaryTypeProperties
```
void setLoadSecondaryTypeProperties(boolean load)
```
    Sets if secondary type properties should be loaded.
    
    CMIS:
    
    1.1
  - loadSecondaryTypeProperties
```
boolean loadSecondaryTypeProperties()
```
    Returns is secondary type properties should be loaded.
    
    CMIS:
    
    1.1
  - isIncludeAllowableActions
```
boolean isIncludeAllowableActions()
```
    Returns if allowable actions should returned.
  - setIncludeAllowableActions
```
void setIncludeAllowableActions(boolean include)
```
    Sets if allowable actions should returned.
  - isIncludeAcls
```
boolean isIncludeAcls()
```
    Returns if ACLs should returned.
  - setIncludeAcls
```
void setIncludeAcls(boolean include)
```
    Sets if ACLs should returned.
  - getIncludeRelationships
```
IncludeRelationships getIncludeRelationships()
```
    Returns which relationships should be returned.
  - setIncludeRelationships
```
void setIncludeRelationships(IncludeRelationships include)
```
    Sets which relationships should be returned.
  - isIncludePolicies
```
boolean isIncludePolicies()
```
    Returns if policies should returned.
  - setIncludePolicies
```
void setIncludePolicies(boolean include)
```
    Sets if policies should returned.
  - getRenditionFilter
```
Set<String> getRenditionFilter()
```
    Returns the current rendition filter. (See CMIS spec "2.2.1.2.4.1 Rendition Filter Grammar")
    
    Returns:
    a set of rendition filter terms
  - setRenditionFilter
```
void setRenditionFilter(Set<String> renditionFilter)
```
    Sets the current rendition filter. (See CMIS spec "2.2.1.2.4.1 Rendition Filter Grammar")
    
    Parameters:
    renditionFilter - a set of rendition filter terms
  - setRenditionFilterString
```
void setRenditionFilterString(String renditionFilter)
```
    Sets the current rendition filter. (See CMIS spec "2.2.1.2.4.1 Rendition Filter Grammar")
    
    Parameters:
    renditionFilter - a comma separated list of rendition filter terms
  - getRenditionFilterString
```
String getRenditionFilterString()
```
    Returns the current rendition filter. (See CMIS spec "2.2.1.2.4.1 Rendition Filter Grammar")
    
    Returns:
    a comma separated list of rendition filter terms
  - isIncludePathSegments
```
boolean isIncludePathSegments()
```
    Returns if path segments should returned.
  - setIncludePathSegments
```
void setIncludePathSegments(boolean include)
```
    Sets if path segments should returned.
  - getOrderBy
```
String getOrderBy()
```
    Returns the order by rule for operations that return lists.
    
    Returns:
    a comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name
  - setOrderBy
```
void setOrderBy(String orderBy)
```
    Sets the order by rule for operations that return lists.
    
    Parameters:
    orderBy - a comma-separated list of query names and the ascending modifier "ASC" or the descending modifier "DESC" for each query name
  - isCacheEnabled
```
boolean isCacheEnabled()
```
    Return if caching is enabled.
  - setCacheEnabled
```
void setCacheEnabled(boolean cacheEnabled)
```
    Enables or disables the cache.
  - getCacheKey
```
String getCacheKey()
```
    Returns a key for this OperationContext object that is used for caching.
  - setMaxItemsPerPage
```
void setMaxItemsPerPage(int maxItemsPerPage)
```
    Set the max number of items per batch for operations that return lists. This option does not restrict the number of returned items. To retrieve an excerpt (page) of a list, see ItemIterable.getPage(int).
    
    Parameters:
    maxItemsPerPage - max number of items (must be >0)
  - getMaxItemsPerPage
```
int getMaxItemsPerPage()
```
    Returns the current max number of items per batch.

Interface OperationContext

Method Summary

Method Detail

getFilter

setFilter

setFilterString

getFilterString

setLoadSecondaryTypeProperties

loadSecondaryTypeProperties

isIncludeAllowableActions

setIncludeAllowableActions

isIncludeAcls

setIncludeAcls

getIncludeRelationships

setIncludeRelationships

isIncludePolicies

setIncludePolicies

getRenditionFilter

setRenditionFilter

setRenditionFilterString

getRenditionFilterString

isIncludePathSegments

setIncludePathSegments

getOrderBy

setOrderBy

isCacheEnabled

setCacheEnabled

getCacheKey

setMaxItemsPerPage

getMaxItemsPerPage