Skip navigation links

oracle.webcenter.spaces.query
Class SpacesQueryFilter

java.lang.Object
oracle.webcenter.spaces.query.SpacesQueryFilter

All Implemented Interfaces:

java.io.Serializable

public class SpacesQueryFilter

extends java.lang.Object

implements java.io.Serializable

Defines a filter to use as criteria for querying spaces.

Use the createXXX() methods to create instances of this class, and call SpacesQueryParameters.setFilter(oracle.webcenter.spaces.query.SpacesQueryFilter) to set this to be used on a SpacesQueryParameters instance.

Since:

release specific (what release of product did this appear in)

See Also:

Serialized Form

Nested Class Summary

static class

SpacesQueryFilter.FilterType This type definition is liable to change across product releases and is not intended for consumer use.

Method Summary

static SpacesQueryFilter	createSearchFilter(java.lang.String searchString) Creates a filter representing a text search on certail pre-designated space attributes.
static SpacesQueryFilter	createWhereClauseFilter(java.lang.String whereClause) Creates a filter defined by a JPQL condition expression.
java.lang.String	getFilterString() This method is liable to change across product releases and is not intended for consumer use.
SpacesQueryFilter.FilterType	getType() This method is liable to change across product releases and is not intended for consumer use.

Methods inherited from class java.lang.Object

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

Method Detail

createWhereClauseFilter

public static SpacesQueryFilter createWhereClauseFilter(java.lang.String whereClause)

Creates a filter defined by a JPQL condition expression.

The JPQL condition expression can reference space attributes using the idenitifier 'sp' representing the JPA entity for a space, WcSpaceHeader. For example, the following condition can be used to create a filter for all spaces created by user 'monty' that allow users to subscribe to them: "sp.createdBy = 'monty' and sp.selfSubEnabled = 'Y'". You can use any variable defined in WcSpaceHeader in the whereClause.

EL : #{spaceContext.spacesQuery.unionOf.ALL_QUERIABLE.whereClause['sp.createdBy = 'monty' and sp.selfSubEnabled = 'Y' ].listSpaces}


This EL returns a list of all spaces a user has access which are created by monty and those group spaces on which self subscription is enabled

Parameters:

whereClause - A JPQL (Java Persistence Query Language) condition expression defining the criteria to use for filtering spaces

Returns:

Filter defined by the specified JPQL condition expression

createSearchFilter

public static SpacesQueryFilter createSearchFilter(java.lang.String searchString)

Creates a filter representing a text search on certail pre-designated space attributes.

As of today the attributes that get searched on are display name, name, description, keywords, GUID, and creator user name.

EL- #{spaceContext.spacesQuery.unionOf.ALL_QUERIABLE.sortCriteria['sp.lastUpdateDate desc'].search['gs1'].listSpaces}

&nbsp This EL returns a list of all group spaces a user has access on and whose name or display name etc matches 'gs1'

Parameters:

searchString - Pattern to search for in the space attributes

Returns:

Filter representing a search on space attributes

getType

public SpacesQueryFilter.FilterType getType()

This method is liable to change across product releases and is not intended for consumer use.

getFilterString

public java.lang.String getFilterString()

This method is liable to change across product releases and is not intended for consumer use.

Skip navigation links