com.wewebu.ow.server.collections

Class OwLoadContext

java.lang.Object

com.wewebu.ow.server.collections.OwLoadContext

All Implemented Interfaces:

OwLoadContextInfo

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

Since:

4.2.0.0

See Also:

OwPageableObject

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
OwLoadContext()
OwLoadContext(OwLoadContextInfo ctxInfo)

Method Summary

Methods

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

OwLoadContext

public OwLoadContext()

OwLoadContext

public OwLoadContext(OwLoadContextInfo ctxInfo)

Method Detail

getObjectTypes

public int[] getObjectTypes()

Description copied from interface: OwLoadContextInfo

Get an array of object types, which should be retrieved.

Specified by:

getObjectTypes in interface OwLoadContextInfo

Returns:

the types of objects to be selected by this filter.

See Also:

OwObjectReference

setObjectTypes

public void setObjectTypes(int... objectTypes)

Parameters:

objectTypes -

See Also:

OwObjectReference

getPropertyNames

public Collection<String> getPropertyNames()

Description copied from interface: OwLoadContextInfo

List of property names/Id's which should be retrieved.

Specified by:

getPropertyNames in interface OwLoadContextInfo

Returns:

List of property names/ids (String's)

setPropertyNames

public void setPropertyNames(Collection<String> propertyNames)

getSorting

public OwSort getSorting()

Description copied from interface: OwLoadContextInfo

Sorting definition

Specified by:

getSorting in interface OwLoadContextInfo

Returns:

OwSort or null;

setSorting

public void setSorting(OwSort sort)

getMaxSize

public long getMaxSize()

Description copied from interface: OwLoadContextInfo

Maximum retrieved elements

Specified by:

getMaxSize in interface OwLoadContextInfo

Returns:

long if known, -1 if unknown

setMaxSize

public void setMaxSize(long maxSize)

getVersionSelection

public int getVersionSelection()

Description copied from interface: OwLoadContextInfo

Definition of specific version restriction for data to retrieve.

Specified by:

getVersionSelection in interface OwLoadContextInfo

Returns:

the version of the objects that will be selected by this filter.

See Also:

OwSearchTemplate

setVersionSelection

public void setVersionSelection(int versionSelection)

Parameters:

versionSelection -

See Also:

OwSearchTemplate

getFilter

public OwSearchNode getFilter()

Description copied from interface: OwLoadContextInfo

Get a definition of a filter, which can be used to restrict result.

Specified by:

getFilter in interface OwLoadContextInfo

Returns:

OwSearchNode or null

setFilter

public void setFilter(OwSearchNode filterCriteria)

includeFolders

public boolean includeFolders()

includeDocuments

public boolean includeDocuments()

getSkipCount

public long getSkipCount()

Description copied from interface: OwLoadContextInfo

Skip count of results

Specified by:

getSkipCount in interface OwLoadContextInfo

Returns:

long

setSkipCount

public void setSkipCount(long skipCount)

getPageSize

public int getPageSize()

Description copied from interface: OwLoadContextInfo

Get the size for pages (=Items per page), which are retrieved.

Specified by:

getPageSize in interface OwLoadContextInfo

Returns:

integer size of page

setPageSize

public void setPageSize(int pageSize)