Skip navigation links

oracle.webcenter.spaces.query
Enum SpacesQueryParameters.ReturnShape

java.lang.Object
java.lang.Enum<SpacesQueryParameters.ReturnShape>
oracle.webcenter.spaces.query.SpacesQueryParameters.ReturnShape

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SpacesQueryParameters.ReturnShape>

Enclosing class:

SpacesQueryParameters

public static enum SpacesQueryParameters.ReturnShape

extends java.lang.Enum<SpacesQueryParameters.ReturnShape>

Defines the shape in which to return results of a spaces query.

Enum Constant Summary

RECURSIVE_FLATTENED
Specifies that the results should include spaces across all levels of the space hierarchy.

ROOT_LEVEL
Specifies that the results should include only spaces that are at the root level, that is, which have no parent.

Method Summary

static SpacesQueryParameters.ReturnShape	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SpacesQueryParameters.ReturnShape[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ROOT_LEVEL

public static final SpacesQueryParameters.ReturnShape ROOT_LEVEL

Specifies that the results should include only spaces that are at the root level, that is, which have no parent.

Example -1 : #{spaceContext.spacesQuery.unionOf['USER_JOINED'].shape['ROOT_LEVEL'].listSpaces} For those spaces which have children, only immediate children will be fetched
Example -2 : #{spaceContext.spacesQuery.parentSpaceName['gs2'].shape['ROOT_LEVEL'].listSpaces}

RECURSIVE_FLATTENED

public static final SpacesQueryParameters.ReturnShape RECURSIVE_FLATTENED

Specifies that the results should include spaces across all levels of the space hierarchy.

Example:#{spaceContext.spacesQuery.unionOf['USER_JOINED'].shape['RECURSIVE_FLATTENED'].listSpaces}

Method Detail

values

public static SpacesQueryParameters.ReturnShape[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SpacesQueryParameters.ReturnShape c : SpacesQueryParameters.ReturnShape.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SpacesQueryParameters.ReturnShape valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

Skip navigation links