public class OperationContextImpl extends Object implements OperationContext, Serializable
OperationContext
implementation.Modifier and Type | Field and Description |
---|---|
static String |
PROPERTIES_STAR |
static String |
RENDITION_NONE |
Constructor and Description |
---|
OperationContextImpl()
Default constructor.
|
OperationContextImpl(OperationContext source)
Copy constructor.
|
OperationContextImpl(Set<String> propertyFilter,
boolean includeAcls,
boolean includeAllowableActions,
boolean includePolicies,
IncludeRelationships includeRelationships,
Set<String> renditionFilter,
boolean includePathSegments,
String orderBy,
boolean cacheEnabled,
int maxItemsPerPage)
Constructor with parameters.
|
Modifier and Type | Method and Description |
---|---|
protected void |
generateCacheKey()
Generates a new cache key from all parameters that are relevant for
caching.
|
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.
|
public static final String PROPERTIES_STAR
public static final String RENDITION_NONE
public OperationContextImpl()
public OperationContextImpl(OperationContext source)
public OperationContextImpl(Set<String> propertyFilter, boolean includeAcls, boolean includeAllowableActions, boolean includePolicies, IncludeRelationships includeRelationships, Set<String> renditionFilter, boolean includePathSegments, String orderBy, boolean cacheEnabled, int maxItemsPerPage)
public Set<String> getFilter()
OperationContext
getFilter
in interface OperationContext
public void setFilter(Set<String> propertyFilter)
OperationContext
setFilter
in interface OperationContext
propertyFilter
- a set of query namespublic void setFilterString(String propertyFilter)
OperationContext
setFilterString
in interface OperationContext
propertyFilter
- a comma separated list of query namespublic String getFilterString()
OperationContext
getFilterString
in interface OperationContext
public void setLoadSecondaryTypeProperties(boolean load)
OperationContext
setLoadSecondaryTypeProperties
in interface OperationContext
public boolean loadSecondaryTypeProperties()
OperationContext
loadSecondaryTypeProperties
in interface OperationContext
public boolean isIncludeAcls()
OperationContext
isIncludeAcls
in interface OperationContext
public void setIncludeAcls(boolean include)
OperationContext
setIncludeAcls
in interface OperationContext
public boolean isIncludeAllowableActions()
OperationContext
isIncludeAllowableActions
in interface OperationContext
public void setIncludeAllowableActions(boolean include)
OperationContext
setIncludeAllowableActions
in interface OperationContext
public boolean isIncludePolicies()
OperationContext
isIncludePolicies
in interface OperationContext
public void setIncludePolicies(boolean include)
OperationContext
setIncludePolicies
in interface OperationContext
public IncludeRelationships getIncludeRelationships()
OperationContext
getIncludeRelationships
in interface OperationContext
public void setIncludeRelationships(IncludeRelationships include)
OperationContext
setIncludeRelationships
in interface OperationContext
public Set<String> getRenditionFilter()
OperationContext
getRenditionFilter
in interface OperationContext
public void setRenditionFilter(Set<String> renditionFilter)
OperationContext
setRenditionFilter
in interface OperationContext
renditionFilter
- a set of rendition filter termspublic void setRenditionFilterString(String renditionFilter)
OperationContext
setRenditionFilterString
in interface OperationContext
renditionFilter
- a comma separated list of rendition filter termspublic String getRenditionFilterString()
OperationContext
getRenditionFilterString
in interface OperationContext
public boolean isIncludePathSegments()
OperationContext
isIncludePathSegments
in interface OperationContext
public void setIncludePathSegments(boolean include)
OperationContext
setIncludePathSegments
in interface OperationContext
public String getOrderBy()
OperationContext
getOrderBy
in interface OperationContext
public void setOrderBy(String orderBy)
OperationContext
setOrderBy
in interface OperationContext
orderBy
- a comma-separated list of query names and the
ascending modifier "ASC" or the descending modifier "DESC" for
each query namepublic boolean isCacheEnabled()
OperationContext
isCacheEnabled
in interface OperationContext
public void setCacheEnabled(boolean cacheEnabled)
OperationContext
setCacheEnabled
in interface OperationContext
public String getCacheKey()
OperationContext
getCacheKey
in interface OperationContext
protected void generateCacheKey()
public int getMaxItemsPerPage()
OperationContext
getMaxItemsPerPage
in interface OperationContext
public void setMaxItemsPerPage(int maxItemsPerPage)
OperationContext
ItemIterable.getPage(int)
.setMaxItemsPerPage
in interface OperationContext
maxItemsPerPage
- max number of items (must be >0)Copyright © 2009-2013 The Apache Software Foundation. All Rights Reserved.