Skip navigation links

oracle.webcenter.spaces.metadata
Class SpacesQueryOptions

java.lang.Object
oracle.webcenter.spaces.metadata.SpacesQueryOptions

Deprecated. The usage of SpacesQueryOptions class and its enums/methods is discouraged. Use SpacesQueryParameters class instead.

@Deprecated
public class SpacesQueryOptions

extends java.lang.Object

This interface decides the space rows that will be returned. for example if showJoined and public is set to true then both joined and public spaces will be returned. set all to true to return all the possible spaces that a user can see.

EL : #{spaceContext.spacesQuery.unionOf['USER_JOINED'].listSpaces}

It will return all the spaces joined by the User.

Nested Class Summary

static class	SpacesQueryOptions.ShowClosed Deprecated. The usage of SpacesQueryOptions class and its enums/methods is discouraged. Use SpacesQueryParameters class instead.
static class	SpacesQueryOptions.SortOrder Deprecated. The usage of SpacesQueryOptions class and its enums/methods is discouraged. Use SpacesQueryParameters class instead.
static class	SpacesQueryOptions.SpacesQueryCondition Deprecated. The usage of SpacesQueryOptions class and its enums/methods is discouraged. Use SpacesQueryParameters class instead. SpacesQueryCondition specify the query condition based on the group membership of the user. For example, following EL will return All user joined spaces. EL: #{spaceContext.spacesQuery.unionOf['USER_JOINED']}
static class	SpacesQueryOptions.SpacesSortOptions Deprecated. The usage of SpacesQueryOptions class and its enums/methods is discouraged. Use SpacesQueryParameters class instead. This Enum sets the sort option to be used in SpacesQueryOptions. For example, following EL will return All user joined spaces sorted by creation date. EL: #{spaceContext.spacesQuery.unionOf['USER_JOINED'].sortCriteria['createDate']}

Constructor Summary

SpacesQueryOptions()
Deprecated.

Method Summary

SpacesQueryParameters	getAdvancedOptions() Deprecated.
int	getBatchSize() Deprecated.
SpacesQueryOptions.ShowClosed	getClosed() Deprecated.
java.util.List<java.lang.String>	getExcludeSpaces() Deprecated.
java.lang.String	getParentGuid() Deprecated.
SpacesQueryOptions.SpacesQueryCondition	getQueryOption() Deprecated.
java.util.List<java.lang.String>	getScopeGuid() Deprecated.
java.lang.String	getSearchDisplayName() Deprecated.
java.lang.String	getSearchPattern() Deprecated.
void	getShowActivityStreamData(boolean activityStreamData) Deprecated.
boolean	getShowAll() Deprecated.
boolean	getShowAllLevels() Deprecated.
java.lang.String	getShowChildren() Deprecated.
boolean	getShowDiscoverable() Deprecated.
boolean	getShowJoined() Deprecated.
boolean	getShowPublic() Deprecated.
boolean	getShowRSSEnabled() Deprecated.
boolean	getShowSpacesUser() Deprecated.
java.util.List<SpacesQueryOptions.SpacesSortOptions>	getSortOptions() Deprecated.
SpacesQueryOptions.SortOrder	getSortOrder() Deprecated.
int	getStartIndex() Deprecated.
java.lang.String	getUserName() Deprecated.
boolean	isAdmin() Deprecated.
boolean	isExcludeHierarchy() Deprecated.
boolean	isShowRecentSpaces() Deprecated.
void	setAdmin(boolean isAdmin) Deprecated.
void	setAdvancedOptions(SpacesQueryParameters advancedOptions) Deprecated.
void	setBatchSize(int batchSize) Deprecated.
void	setClosed(SpacesQueryOptions.ShowClosed closed) Deprecated.
void	setExcludeSpaces(java.util.List<java.lang.String> spaceGuids, boolean excludeHierarchy) Deprecated.
void	setParentGuid(java.lang.String parentGuid) Deprecated.
void	setQueryOption(SpacesQueryOptions.SpacesQueryCondition queryOption) Deprecated.
void	setScopeGuid(java.util.List<java.lang.String> scopeGuid) Deprecated.
void	setSearchDisplayName(java.lang.String searchDisplayName) Deprecated.
void	setSearchPattern(java.lang.String searchPattern) Deprecated.
boolean	setShowActivityStreamData() Deprecated.
void	setShowAll(boolean value) Deprecated.
void	setShowChildren(java.lang.String parentGUID) Deprecated.
void	setShowChildren(java.lang.String parentGUID, boolean showAllLevels) Deprecated.
void	setShowDiscoverable(boolean value) Deprecated.
void	setShowJoined(boolean value) Deprecated.
void	setShowPublic(boolean value) Deprecated.
void	setShowRecentSpaces(boolean showRecentSpaces) Deprecated.
void	setShowRSSEnabled(boolean rssEnabled) Deprecated.
void	setShowSpacesUser(boolean value) Deprecated.
void	setSortOptions(java.util.List<SpacesQueryOptions.SpacesSortOptions> sortOptions) Deprecated.
void	setSortOrder(SpacesQueryOptions.SortOrder sortOrder) Deprecated. This API sets the sorting order for search results.
void	setStartIndex(int startIndex) Deprecated.
void	setUserName(java.lang.String userName) Deprecated.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpacesQueryOptions

public SpacesQueryOptions()

Deprecated.

Method Detail

setShowDiscoverable

public void setShowDiscoverable(boolean value)

Deprecated.

setShowPublic

public void setShowPublic(boolean value)

Deprecated.

setShowSpacesUser

public void setShowSpacesUser(boolean value)

Deprecated.

setShowAll

public void setShowAll(boolean value)

Deprecated.

setShowJoined

public void setShowJoined(boolean value)

Deprecated.

getShowDiscoverable

public boolean getShowDiscoverable()

Deprecated.

getShowPublic

public boolean getShowPublic()

Deprecated.

getShowSpacesUser

public boolean getShowSpacesUser()

Deprecated.

getShowAll

public boolean getShowAll()

Deprecated.

getShowJoined

public boolean getShowJoined()

Deprecated.

setShowRSSEnabled

public void setShowRSSEnabled(boolean rssEnabled)

Deprecated.

getShowRSSEnabled

public boolean getShowRSSEnabled()

Deprecated.

setAdmin

public void setAdmin(boolean isAdmin)

Deprecated.

isAdmin

public boolean isAdmin()

Deprecated.

setShowRecentSpaces

public void setShowRecentSpaces(boolean showRecentSpaces)

Deprecated.

isShowRecentSpaces

public boolean isShowRecentSpaces()

Deprecated.

setScopeGuid

public void setScopeGuid(java.util.List<java.lang.String> scopeGuid)

Deprecated.

getScopeGuid

public java.util.List<java.lang.String> getScopeGuid()

Deprecated.

setUserName

public void setUserName(java.lang.String userName)

Deprecated.

getUserName

public java.lang.String getUserName()

Deprecated.

setSortOptions

public void setSortOptions(java.util.List<SpacesQueryOptions.SpacesSortOptions> sortOptions)

Deprecated.

getSortOptions

public java.util.List<SpacesQueryOptions.SpacesSortOptions> getSortOptions()

Deprecated.

setSortOrder

public void setSortOrder(SpacesQueryOptions.SortOrder sortOrder)

Deprecated.

This API sets the sorting order for search results. The order can be ascending or descending;

EL: #{spaceContext.spacesQuery.unionOf['ALL_QUERIABLE'].sortOrder['Ascending']}
will return the result in Ascending sort order.

Parameters:

sortOrder - SortOrder to be applied.

See Also:

oracle.webcenter.spaces.query.SortOrder

getSortOrder

public SpacesQueryOptions.SortOrder getSortOrder()

Deprecated.

setSearchDisplayName

public void setSearchDisplayName(java.lang.String searchDisplayName)

Deprecated.

This API sets the display name as the search criteria

getSearchDisplayName

public java.lang.String getSearchDisplayName()

Deprecated.

This API returns the displayName

getShowChildren

public java.lang.String getShowChildren()

Deprecated.

Returns the settings of this object for showing child spaces.

Returns:

- String representing the setting for child spaces.

getShowAllLevels

public boolean getShowAllLevels()

Deprecated.

Returns the settings for the child levels in a hierarchy. This flag is used only if setShowChildren is called with a specific space as the parent space.

Returns:

- returns true if the option is set to fetch all levels of child spcaes in the hierarchy, false otherwise that implies only immediate child spaces are to be fetched.

setShowChildren

public void setShowChildren(java.lang.String parentGUID)

Deprecated.

Sets whether child spaces are to be fetched or not. This parameters affects querying as follows:

• If left blank, only root spaces are to be fetched.
• If set to "*", fetches all spaces include child spaces.
• If set to a specific space GUID, only child spaces of the provided spaces are to be fetched. By default this API sets the option for only immediate children.

  Parameters:

  parentGUID - - whether querying should be restricted to a specific parent space.

  setShowChildren

  public void setShowChildren(java.lang.String parentGUID,
                              boolean showAllLevels)
  

  Deprecated.

  Sets whether child spaces are to be fetched or not. This parameters affects querying as follows:

  • If left blank, only root spaces are to be fetched.
  • If set to "*", fetches all spaces include child spaces.
  • If set to a specific space GUID, only child spaces of the provided spaces are to be fetched. By default this API sets the option for only immediate children.

    Parameters:

    parentGUID - - whether querying should be restricted to a specific parent space.

    showAllLevels - - whether to fetch only immediate child spaces or all levels of child spaces in the hierarchy of specified parent. This parameter is useful only if parentGUID specified a valid space ID, otherwise ignored.

    setExcludeSpaces

    public void setExcludeSpaces(java.util.List<java.lang.String> spaceGuids,
                                 boolean excludeHierarchy)
    

    Deprecated.

    getExcludeSpaces

    public java.util.List<java.lang.String> getExcludeSpaces()
    

    Deprecated.

    isExcludeHierarchy

    public boolean isExcludeHierarchy()
    

    Deprecated.

    setShowActivityStreamData

    public boolean setShowActivityStreamData()
    

    Deprecated.

    This API returns if the activity steam table needs to be joined with spaces table

    getShowActivityStreamData

    public void getShowActivityStreamData(boolean activityStreamData)
    

    Deprecated.

    This API sets if activity stream tables needs to be joined with spaces table

    setParentGuid

    public void setParentGuid(java.lang.String parentGuid)
    

    Deprecated.

    getParentGuid

    public java.lang.String getParentGuid()
    

    Deprecated.

    setStartIndex

    public void setStartIndex(int startIndex)
    

    Deprecated.

    getStartIndex

    public int getStartIndex()
    

    Deprecated.

    setBatchSize

    public void setBatchSize(int batchSize)
    

    Deprecated.

    getBatchSize

    public int getBatchSize()
    

    Deprecated.

    getAdvancedOptions

    public SpacesQueryParameters getAdvancedOptions()
    

    Deprecated.

    setAdvancedOptions

    public void setAdvancedOptions(SpacesQueryParameters advancedOptions)
    

    Deprecated.

    toString

    public java.lang.String toString()
    

    Deprecated.

    Overrides:

    toString in class java.lang.Object

    setSearchPattern

    public void setSearchPattern(java.lang.String searchPattern)
    

    Deprecated.

    getSearchPattern

    public java.lang.String getSearchPattern()
    

    Deprecated.

    setQueryOption

    public void setQueryOption(SpacesQueryOptions.SpacesQueryCondition queryOption)
    

    Deprecated.

    getQueryOption

    public SpacesQueryOptions.SpacesQueryCondition getQueryOption()
    

    Deprecated.

    setClosed

    public void setClosed(SpacesQueryOptions.ShowClosed closed)
    

    Deprecated.

    getClosed

    public SpacesQueryOptions.ShowClosed getClosed()
    

    Deprecated.