Package oracle.webcenter.spaces.query

Class SpacesQueryPopulation

java.lang.Object
oracle.webcenter.spaces.query.SpacesQueryPopulation
All Implemented Interfaces:
Serializable
@Exported public class SpacesQueryPopulation extends Object implements Serializable
Defines a population of spaces to query from.

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

Since:
release specific (what release of product did this appear in)
See Also:

  • Method Details

    • createAdminPopulation

      public static SpacesQueryPopulation createAdminPopulation()
      Creates a population definition denoting the entire set of all spaces.

      This population can be used in a query only if the current user has permission to manage/administer WebCenter.


      EL : #{spaceContext.spacesQuery.all}

      Returns:
      Population definition denoting the entire set of all spaces.

    • createChildrenPopulation

      public static SpacesQueryPopulation createChildrenPopulation(String spaceGuid, String spaceName)
      Creates a population definition denoting the set of descendant spaces of a specified space, or in other words, the set of spaces that are rooted at the specified space.

      To specify the root space, either one out of spaceGuid and spaceName needs to be specified, and the other one can be left null.


      Example -1 : #{spaceContext.spacesQuery.parentSpaceName['gs1'].listSpaces}

      &nbsp This EL returns a list of all children whose space name is 'gs1'

      Example -2 : #{spaceContext.spacesQuery.parentSpaceGuid['s8f265f22_9403_402e_a871_7eddf5f82e85'].shape['ROOT_LEVEL'].listSpaces}
      &nbsp This EL returns a list of all children whose space guid is 's8f265f22_9403_402e_a871_7eddf5f82e85'
      Example -3 : #{spaceContext.spacesQuery.parentSpaceName['gs2'].shape['RECURSIVE_FLATTENED'].listSpaces}
      &nbsp This EL returns a list of all children and their children whose space name is 'gs2'

      Here default shape is ROOT_LEVEL.
      Parameters:
      spaceGuid - GUID of the parent space
      spaceName - Name of the parent space
      Returns:
      Population definition denoting the set of child spaces of the specified space.

    • createPopulationBySpaceNames

      public static SpacesQueryPopulation createPopulationBySpaceNames(Collection<String> names)

      Creates a population definition by explicitly spelling out the names of spaces to be included in it.
      EL - #{spaceContext.spacesQuery.containingNames['anj1 anj2 xyz1 hello'].listSpaces}

      Parameters:
      names - Names of the spaces to be included in the population.
      Returns:
      Population definition comprising the specified spaces.
      See Also:

    • createPopulationBySpaceGuids

      public static SpacesQueryPopulation createPopulationBySpaceGuids(Collection<String> guids)

      Creates a population definition by explicitly spelling out the names of spaces to be included in it.
      EL: #{spaceContext.spacesQuery.containingGuids['s8f265f22_9403_402e_a871_7eddf5f82e85,sd3038962_aae5_4b3d_92ae_ed73c9d9d1f0'].listSpaces}

      Parameters:
      GUID - GUID of the spaces to be included in the population.
      Returns:
      Population definition comprising the specified spaces.
      See Also:

    • createUnionPopulation

      public static SpacesQueryPopulation createUnionPopulation(Collection<SpacesQueryPopulation.PopulationStripe> unionStripes)

      Creates a population definition as a union of one or more specified classes of spaces.
      Example 1 : #{spaceContext.spacesQuery.unionOf['PUBLIC_ACCESSIBLE USER_JOINED'].listSpaces}

      &nbsp This EL returns a list of all spaces which are public and which the current user is member of

      Parameters:
      unionStripes - The classes of spaces to be included in the union.
      Returns:
      Population definition comprising the union of specified classes of spaces.

    • getType

      public SpacesQueryPopulation.PopulationType getType()
      This method is liable to change across product releases and is not intended for consumer use.

    • getRootSpaceGuid

      public String getRootSpaceGuid()
      This method is liable to change across product releases and is not intended for consumer use.

    • getRootSpaceName

      public String getRootSpaceName()
      This method is liable to change across product releases and is not intended for consumer use.

    • getListedSpaceGuids

      public Collection<String> getListedSpaceGuids()
      This method is liable to change across product releases and is not intended for consumer use.

    • getListedSpaceNames

      public Collection<String> getListedSpaceNames()
      This method is liable to change across product releases and is not intended for consumer use.

    • getUnionStripes

      public Set<SpacesQueryPopulation.PopulationStripe> getUnionStripes()
      This method is liable to change across product releases and is not intended for consumer use.