oracle.webcenter.portal.api.query

Interface PortalTemplateQuery

All Superinterfaces:

PortalObjectListQuery<PortalTemplate>, PortalObjectQuery<PortalTemplate>, PortalQuery<PortalTemplate>

public interface PortalTemplateQuery
extends PortalQuery<PortalTemplate>

Query interface for Portal.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFilter() Gets the search filter parameter for the query.
boolean	getIsAdmin() Gets the isAdmin parameter for the query.
java.lang.Boolean	getIsSeeded() Gets the isSeeded parameter for the query.
void	setFilter(java.lang.String filter) Sets the search filter parameter for the query.
void	setIsAdmin(boolean isAdmin) Sets the isAdmin parameter for the query.
void	setIsSeeded(java.lang.Boolean seeded) Sets the isSeeded parameter for the query.

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

getNameContains, setNameContains

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

setIsSeeded

void setIsSeeded(java.lang.Boolean seeded)

Sets the isSeeded parameter for the query. If this parameter is null, then return both seeded and non-seeded portal templates. If the value of this parameter is true, then return portal templates that are seeded. If the value of this parameter is false, then return portal templates that are not seeded.

Parameters:

seeded -

getIsSeeded

java.lang.Boolean getIsSeeded()

Gets the isSeeded parameter for the query. If this parameter is null, then return both seeded and non-seeded portal templates. If the value of this parameter is true, then return portal templates that are seeded. If the value of this parameter is false, then return portal templates that are not seeded.

Returns:

isSeeded

setIsAdmin

void setIsAdmin(boolean isAdmin)

Sets the isAdmin parameter for the query. If the query is made with isAdmin set as true all the templates are to be returned, otherwise only the joined and public templates should be returned for the user making the request

Parameters:

isAdmin - the isAdmin value to be set.

getIsAdmin

boolean getIsAdmin()

Gets the isAdmin parameter for the query. If the query is made with isAdmin set as true all the templates are to be returned, otherwise only the joined and public templates should be returned for the user making the request.

Returns:

if true the query is being made for an administrator, otherwise it is not.

setFilter

void setFilter(java.lang.String filter)

Sets the search filter parameter for the query.

Specified by:

setFilter in interface PortalQuery<PortalTemplate>

Parameters:

filter -

getFilter

java.lang.String getFilter()

Gets the search filter parameter for the query.

Specified by:

getFilter in interface PortalQuery<PortalTemplate>

Returns:

filter