|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.webcenter.spaces.query.SpacesQueryPopulation
public class SpacesQueryPopulation
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.
Nested Class Summary | |
---|---|
static class |
SpacesQueryPopulation.PopulationStripe Represents a class of spaces that can be used while defining a population to query spaces from. |
static class |
SpacesQueryPopulation.PopulationType This type definition is liable to change across product releases and is not intended for consumer use. |
Method Summary | |
---|---|
static SpacesQueryPopulation |
createAdminPopulation() Creates a population definition denoting the entire set of all spaces. |
static SpacesQueryPopulation |
createChildrenPopulation(java.lang.String spaceGuid, java.lang.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. |
static SpacesQueryPopulation |
createPopulationBySpaceGuids(java.util.Collection<java.lang.String> guids) Creates a population definition by explicitly spelling out the names of spaces to be included in it. |
static SpacesQueryPopulation |
createPopulationBySpaceNames(java.util.Collection<java.lang.String> names) Creates a population definition by explicitly spelling out the names of spaces to be included in it. |
static SpacesQueryPopulation |
createUnionPopulation(java.util.Collection<SpacesQueryPopulation.PopulationStripe> unionStripes) Creates a population definition as a union of one or more specified classes of spaces. |
java.util.Collection<java.lang.String> |
getListedSpaceGuids() This method is liable to change across product releases and is not intended for consumer use. |
java.util.Collection<java.lang.String> |
getListedSpaceNames() This method is liable to change across product releases and is not intended for consumer use. |
java.lang.String |
getRootSpaceGuid() This method is liable to change across product releases and is not intended for consumer use. |
java.lang.String |
getRootSpaceName() This method is liable to change across product releases and is not intended for consumer use. |
SpacesQueryPopulation.PopulationType |
getType() This method is liable to change across product releases and is not intended for consumer use. |
java.util.Set<SpacesQueryPopulation.PopulationStripe> |
getUnionStripes() 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 |
---|
public static SpacesQueryPopulation createAdminPopulation()
This population can be used in a query only if the current user has permission to manage/administer WebCenter.
EL : #{spaceContext.spacesQuery.all}
public static SpacesQueryPopulation createChildrenPopulation(java.lang.String spaceGuid, java.lang.String spaceName)
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}
  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}
  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}
  This EL returns a list of all children and their children whose space name is 'gs2'
spaceGuid
- GUID of the parent spacespaceName
- Name of the parent spacepublic static SpacesQueryPopulation createPopulationBySpaceNames(java.util.Collection<java.lang.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}
names
- Names of the spaces to be included in the population.createPopulationBySpaceGuids(java.util.Collection<java.lang.String>)
public static SpacesQueryPopulation createPopulationBySpaceGuids(java.util.Collection<java.lang.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}
GUID
- GUID of the spaces to be included in the population.createPopulationBySpaceNames(java.util.Collection<java.lang.String>)
public static SpacesQueryPopulation createUnionPopulation(java.util.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}
  This EL returns a list of all spaces which are public and which the current user is member of
unionStripes
- The classes of spaces to be included in the union.public SpacesQueryPopulation.PopulationType getType()
public java.lang.String getRootSpaceGuid()
public java.lang.String getRootSpaceName()
public java.util.Collection<java.lang.String> getListedSpaceGuids()
public java.util.Collection<java.lang.String> getListedSpaceNames()
public java.util.Set<SpacesQueryPopulation.PopulationStripe> getUnionStripes()
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter Portal 11g Release 1 (11.1.1.7.0) E15995-06 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |