org.apache.chemistry.opencmis.client.api
Interface OperationContext

All Superinterfaces:
java.io.Serializable

public interface OperationContext
extends java.io.Serializable

An OperationContext object defines the filtering, paging and caching of an operation.


Method Summary
 java.lang.String getCacheKey()
          Returns a key for this OperationContext object that is used for caching.
 java.util.Set<java.lang.String> getFilter()
          Returns the current filter.
 java.lang.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.
 java.lang.String getOrderBy()
          Returns the order by rule for operations that return lists.
 java.util.Set<java.lang.String> getRenditionFilter()
          Returns the current rendition filter.
 java.lang.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(java.util.Set<java.lang.String> propertyFilter)
          Sets the current filter.
 void setFilterString(java.lang.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(java.lang.String orderBy)
          Sets the order by rule for operations that return lists.
 void setRenditionFilter(java.util.Set<java.lang.String> renditionFilter)
          Sets the current rendition filter.
 void setRenditionFilterString(java.lang.String renditionFilter)
          Sets the current rendition filter.
 

Method Detail

getFilter

java.util.Set<java.lang.String> getFilter()
Returns the current filter.

Returns:
a set of query names

setFilter

void setFilter(java.util.Set<java.lang.String> propertyFilter)
Sets the current filter.

Parameters:
propertyFilter - a set of query names

setFilterString

void setFilterString(java.lang.String propertyFilter)
Sets the current filter.

Parameters:
propertyFilter - a comma separated list of query names

getFilterString

java.lang.String getFilterString()
Returns the filter extended by cmis:objectId, cmis:objectTypeId and cmis:baseTypeId.


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

java.util.Set<java.lang.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(java.util.Set<java.lang.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(java.lang.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

java.lang.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

java.lang.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(java.lang.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

java.lang.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 page for operations that return lists.

Parameters:
maxItemsPerPage - max number of items (must be >0)

getMaxItemsPerPage

int getMaxItemsPerPage()
Returns the current max number of items per page.



Copyright © 2009-2011 The Apache Software Foundation. All Rights Reserved.