public class OwLoadContext extends Object implements OwLoadContextInfo
Used to filter out objects retrieved from the back-end.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
OwPageableObject
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT_PAGE_SIZE |
Constructor and Description |
---|
OwLoadContext() |
OwLoadContext(OwLoadContextInfo ctxInfo) |
Modifier and Type | Method and Description |
---|---|
OwSearchNode |
getFilter()
Get a definition of a filter, which can be used to restrict result.
|
long |
getMaxSize()
Maximum retrieved elements
|
int[] |
getObjectTypes()
Get an array of object types,
which should be retrieved.
|
int |
getPageSize()
Get the size for pages (=Items per page), which are retrieved.
|
Collection<String> |
getPropertyNames()
List of property names/Id's which should be retrieved.
|
long |
getSkipCount()
Skip count of results
|
OwSort |
getSorting()
Sorting definition
|
int |
getVersionSelection()
Definition of specific version restriction for data to retrieve.
|
boolean |
includeDocuments() |
boolean |
includeFolders() |
void |
setFilter(OwSearchNode filterCriteria) |
void |
setMaxSize(long maxSize) |
void |
setObjectTypes(int... objectTypes) |
void |
setPageSize(int pageSize) |
void |
setPropertyNames(Collection<String> propertyNames) |
void |
setSkipCount(long skipCount) |
void |
setSorting(OwSort sort) |
void |
setVersionSelection(int versionSelection) |
public static final int DEFAULT_PAGE_SIZE
public OwLoadContext()
public OwLoadContext(OwLoadContextInfo ctxInfo)
public int[] getObjectTypes()
OwLoadContextInfo
getObjectTypes
in interface OwLoadContextInfo
OwObjectReference
public void setObjectTypes(int... objectTypes)
objectTypes
- OwObjectReference
public Collection<String> getPropertyNames()
OwLoadContextInfo
getPropertyNames
in interface OwLoadContextInfo
public void setPropertyNames(Collection<String> propertyNames)
public OwSort getSorting()
OwLoadContextInfo
getSorting
in interface OwLoadContextInfo
public void setSorting(OwSort sort)
public long getMaxSize()
OwLoadContextInfo
getMaxSize
in interface OwLoadContextInfo
public void setMaxSize(long maxSize)
public int getVersionSelection()
OwLoadContextInfo
getVersionSelection
in interface OwLoadContextInfo
OwSearchTemplate
public void setVersionSelection(int versionSelection)
versionSelection
- OwSearchTemplate
public OwSearchNode getFilter()
OwLoadContextInfo
getFilter
in interface OwLoadContextInfo
public void setFilter(OwSearchNode filterCriteria)
public boolean includeFolders()
public boolean includeDocuments()
public long getSkipCount()
OwLoadContextInfo
getSkipCount
in interface OwLoadContextInfo
public void setSkipCount(long skipCount)
public int getPageSize()
OwLoadContextInfo
getPageSize
in interface OwLoadContextInfo
public void setPageSize(int pageSize)
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.