oracle.webcenter.portal.api.query

Interface DiscoveredPortalQuery

All Superinterfaces:

PortalObjectListQuery<DiscoveredPortal>, PortalObjectQuery<DiscoveredPortal>

public interface DiscoveredPortalQuery
extends PortalObjectListQuery<DiscoveredPortal>

Query used to find portals

Method Summary

Modifier and Type	Method and Description
void	setAdmin(boolean admin) Sets whether the query is for an admin user.
void	setAll(boolean all) Sets whether the query should query all the portls or just a subset based on the values of the other flags
void	setClosed(java.lang.Boolean closed) Sets whether the query should include or exclude closed portals.
void	setDiscoverable(boolean discoverable) Sets whether the query the discoverable portals.
void	setJoined(boolean joined) Sets whether the query the portals joined by the current user.
void	setModerated(boolean moderated) Sets whether the query the portals moderated by the current user.
void	setNameContains(java.lang.String nameContains) Sets a name contains filter.
void	setPublic(boolean showPublic) Sets whether the public portals.
void	setSearchFilter(java.lang.String searchFilter) Sets a search filter.

Methods inherited from interface oracle.webcenter.portal.api.query.PortalObjectListQuery

execute, getResultList, setLimit, setOffset, setOrder

Methods inherited from interface oracle.webcenter.portal.api.query.PortalObjectQuery

getPortal, getQueryType, setPortal

Method Detail

setAll

void setAll(boolean all)

Sets whether the query should query all the portls or just a subset based on the values of the other flags

Parameters:

all - true to query all portals, otherwise false

setDiscoverable

void setDiscoverable(boolean discoverable)

Sets whether the query the discoverable portals. Note that if the all flag is set to true then this setting will be ignored.

Parameters:

discoverable - true to query the discoverable portals, otherwise false

setModerated

void setModerated(boolean moderated)

Sets whether the query the portals moderated by the current user. Note that if the all flag is set to true then this setting will be ignored.

Parameters:

moderated - true to query the moderated portals, otherwise false

setPublic

void setPublic(boolean showPublic)

Sets whether the public portals. Note that if the all flag is set to true then this setting will be ignored.

Parameters:

showPublic - true to query the public portals, otherwise false

setJoined

void setJoined(boolean joined)

Sets whether the query the portals joined by the current user. Note that if the all flag is set to true then this setting will be ignored.

Parameters:

joined - true to query the joined portals, otherwise false

setAdmin

void setAdmin(boolean admin)

Sets whether the query is for an admin user.

Parameters:

admin - true if the user is an admin user, otherwise false

setSearchFilter

void setSearchFilter(java.lang.String searchFilter)

Sets a search filter. If this is set to null or an empty string then it will be ignored, otherwise the results will be filtered to include only portals that match the filter.

Parameters:

searchFilter - the text to match

setNameContains

void setNameContains(java.lang.String nameContains)

Sets a name contains filter. If this is set to null or an empty string then it will be ignored, otherwise the results will be filtered to include only portals whose name match the filter.

Parameters:

nameContains - the name to match

setClosed

void setClosed(java.lang.Boolean closed)

Sets whether the query should include or exclude closed portals. If the property is set to null or not set then the query will include portal with the closed flag set to either true or false.

Parameters:

closed - true to query portals with the closed flag set to true, false to query portals with the closed flag set to false, otherwise null.