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 final Set<String> getFilter()
OperationContextgetFilter in interface OperationContextpublic final void setFilter(Set<String> propertyFilter)
OperationContextsetFilter in interface OperationContextpropertyFilter - a set of query namespublic final void setFilterString(String propertyFilter)
OperationContextsetFilterString in interface OperationContextpropertyFilter - a comma separated string of query names or "*" for
all properties or null to let the repository determine
a set of propertiespublic final String getFilterString()
OperationContextgetFilterString in interface OperationContextpublic final void setLoadSecondaryTypeProperties(boolean load)
OperationContextsetLoadSecondaryTypeProperties in interface OperationContextpublic final boolean loadSecondaryTypeProperties()
OperationContextloadSecondaryTypeProperties in interface OperationContextpublic final boolean isIncludeAcls()
OperationContextisIncludeAcls in interface OperationContextpublic final void setIncludeAcls(boolean include)
OperationContextsetIncludeAcls in interface OperationContextpublic final boolean isIncludeAllowableActions()
OperationContextisIncludeAllowableActions in interface OperationContextpublic final void setIncludeAllowableActions(boolean include)
OperationContextsetIncludeAllowableActions in interface OperationContextpublic final boolean isIncludePolicies()
OperationContextisIncludePolicies in interface OperationContextpublic final void setIncludePolicies(boolean include)
OperationContextsetIncludePolicies in interface OperationContextpublic final IncludeRelationships getIncludeRelationships()
OperationContextgetIncludeRelationships in interface OperationContextpublic final void setIncludeRelationships(IncludeRelationships include)
OperationContextsetIncludeRelationships in interface OperationContextpublic final Set<String> getRenditionFilter()
OperationContextgetRenditionFilter in interface OperationContextpublic final void setRenditionFilter(Set<String> renditionFilter)
OperationContextsetRenditionFilter in interface OperationContextrenditionFilter - a set of rendition filter termspublic final void setRenditionFilterString(String renditionFilter)
OperationContextsetRenditionFilterString in interface OperationContextrenditionFilter - a comma separated list of rendition filter termspublic final String getRenditionFilterString()
OperationContextgetRenditionFilterString in interface OperationContextpublic final boolean isIncludePathSegments()
OperationContextisIncludePathSegments in interface OperationContextpublic final void setIncludePathSegments(boolean include)
OperationContextsetIncludePathSegments in interface OperationContextpublic final String getOrderBy()
OperationContextgetOrderBy in interface OperationContextpublic final void setOrderBy(String orderBy)
OperationContextsetOrderBy in interface OperationContextorderBy - a comma-separated list of query names and the
ascending modifier "ASC" or the descending modifier "DESC" for
each query namepublic final boolean isCacheEnabled()
OperationContextisCacheEnabled in interface OperationContextpublic final void setCacheEnabled(boolean cacheEnabled)
OperationContextsetCacheEnabled in interface OperationContextpublic final String getCacheKey()
OperationContextgetCacheKey in interface OperationContextprotected final void generateCacheKey()
public final int getMaxItemsPerPage()
OperationContextgetMaxItemsPerPage in interface OperationContextpublic final void setMaxItemsPerPage(int maxItemsPerPage)
OperationContextItemIterable.getPage(int).setMaxItemsPerPage in interface OperationContextmaxItemsPerPage - max number of items (must be >0)Copyright © 2009-2014 The Apache Software Foundation. All Rights Reserved.