|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
com.bea.netuix.application.search.WebAppSearchCriteria
com.bea.netuix.application.search.PortalSearchCriteria
com.bea.netuix.application.manager.persistence.TemplateSearchCriteria
public class TemplateSearchCriteria
TemplateSearchCriteria - SearchCriteria
for templates. If more than one titles are specified as filter criteria they will be OR'ed in the resulting search. The same applies if multiple descriptions are specified. Title(s) and description(s) will be AND'ed if both are filter criteria unless a titleDescriptionLogicalOperator is specified - (TITLE = 'aT' OR TITLE = 'bT') AND (DESCRIPTION = 'aD' OR DESCRIPTION = 'bD'). Note: Titles and descriptions should be from locale(s) that are in the list of locales specified in the CustomizationContext
. Also, the value of CustomizationContext#isRetrieveResultsIfNoLocale might affect the returned results.
Nested Class Summary | |
---|---|
static class |
TemplateSearchCriteria.LOGICAL_OPERATOR |
static class |
TemplateSearchCriteria.TemplateSortCriteria |
Constructor Summary | |
---|---|
TemplateSearchCriteria(String webAppName) Ctor with webapp name as the base search criteria |
Method Summary | |
---|---|
void |
addDescription(String description) Appends to the list of description search criteria. |
void |
addDescriptions(List<String> descriptions) Appends to the list of description search criteria if description search criteria already exist. |
void |
addTitle(String title) Appends to the list of title search criteria. |
void |
addTitles(List<String> titles) Appends to the list of title search criteria if title search criteria already exist. |
FilterMethod |
getDescriptionFilterMethod() Returns the FilterMethod associated with the description search criteria. |
List<String> |
getDescriptions() Returns the description search criteria or null if it has not been set. |
TemplateSearchCriteria.TemplateSortCriteria |
getTemplateSortCriteria() Returns the template sort criteria |
SortOrder |
getTemplateSortOrder() Returns the SortOrder to be used for the template search. |
com.bea.netuix.application.identifier.TemplateTypeId |
getTemplateTypeId() Returns the TemplateTypeId that this TemplateSearchCriteria pertains to. |
TemplateSearchCriteria.LOGICAL_OPERATOR |
getTitleDescriptionLogicalOperator() Returns the LOGICAL_OPERATOR to be used between title(s) and description(s) when both are specified. |
FilterMethod |
getTitleFilterMethod() Returns the FilterMethod associated with the title search criteria. |
List<String> |
getTitles() Returns the title search criteria or null if it has not been set. |
protected void |
init(TemplateSearchCriteria templateSearchCriteria) Uses another TemplateSearchCriteria to initialize this one |
boolean |
isDescriptionSearchCriteria() Returns true if description is a search criteria |
boolean |
isGlobalTemplateCriteria() Returns true if global template is a search criteria. |
boolean |
isTemplateCriteria() Returns true if template is a search criteria |
boolean |
isTitleSearchCriteria() Returns true if title is a search criteria. |
void |
setDescription(String description) Sets the description search criteria. |
void |
setDescriptionFilterMethod(FilterMethod filterMethod) Sets the description search criteria FilterMethod to be used |
void |
setDescriptions(List<String> descriptions) Sets the description search criteria as a List . |
void |
setGlobalTemplate(boolean globalTemplate) Sets the global template search criteria. |
void |
setTemplate(boolean template) Sets the template search criteria. |
void |
setTemplateSortCriteria(TemplateSearchCriteria.TemplateSortCriteria templateSortCriteria) Sets the template sort criteria |
void |
setTemplateSortOrder(SortOrder sortOrder) Sets the SortOrder to be used for the template search. |
void |
setTemplateTypeId(com.bea.netuix.application.identifier.TemplateTypeId templateTypeId) Sets the templateTypeId that this TemplateSearchCriteria pertains to. |
void |
setTitle(String title) Sets the title search criteria. |
void |
setTitleDescriptionLogicalOperator(TemplateSearchCriteria.LOGICAL_OPERATOR logical_operator) Sets the LOGICAL_OPERATOR to be used between title(s) and description(s) when both are specified. |
void |
setTitleFilterMethod(FilterMethod filterMethod) Sets the title search criteria FilterMethod to be used |
void |
setTitles(List<String> titles) Sets the title search criteria as a List . |
Methods inherited from class com.bea.netuix.application.search.PortalSearchCriteria |
---|
getPortalPaths, init, isPortalPathSearchCriteria, setPortalPaths |
Methods inherited from class com.bea.netuix.application.search.WebAppSearchCriteria |
---|
getWebAppName, init, isWebAppNameCriteria |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TemplateSearchCriteria(String webAppName)
webAppName
-Method Detail |
---|
protected void init(TemplateSearchCriteria templateSearchCriteria)
TemplateSearchCriteria
to initialize this onetemplateSearchCriteria
- sourcepublic boolean isGlobalTemplateCriteria()
true
if global template is a search criteria.true
if global template is a search criteriapublic void setGlobalTemplate(boolean globalTemplate)
globalTemplate
- true
if global templates should be a search criteriapublic boolean isTemplateCriteria()
true
if template is a search criteriatrue
if template is a search criteriapublic void setTemplate(boolean template)
template
- true
if global templates should be a search criteriapublic boolean isTitleSearchCriteria()
true
if title is a search criteria.true
if title is a search criteriapublic List<String> getTitles()
isTitleSearchCriteria()
public FilterMethod getTitleFilterMethod()
FilterMethod
associated with the title search criteria. Returns null if title is not a search criteriaFilterMethod
isTitleSearchCriteria()
public void setTitle(String title)
FilterMethod
used will be FilterMethod.EQUALS
. Overwrites any existing titlestitle
- title search criteriapublic void setTitles(List<String> titles)
List
. The FilterMethod
used will be FilterMethod.EQUALS
. Overwrites any existing titlestitles
- title search criteria List
public void addTitle(String title)
title
-public void addTitles(List<String> titles)
titles
-public void setTitleFilterMethod(FilterMethod filterMethod)
FilterMethod
to be usedfilterMethod
- FilterMethod
to be usedpublic boolean isDescriptionSearchCriteria()
true
if description is a search criteriatrue
if description is a search criteriapublic List<String> getDescriptions()
isDescriptionSearchCriteria()
public FilterMethod getDescriptionFilterMethod()
FilterMethod
associated with the description search criteria. Returns null if title is not a search criteriaFilterMethod
isTitleSearchCriteria()
public void setDescription(String description)
FilterMethod
used will be FilterMethod.EQUALS
. Overwrites any existing descriptionsdescription
- description search criteriapublic void setDescriptions(List<String> descriptions)
List
. The FilterMethod
used will be FilterMethod.EQUALS
. Overwrites any existing descriptionsdescriptions
- description search criteria List
public void addDescription(String description)
description
-public void addDescriptions(List<String> descriptions)
descriptions
-public void setDescriptionFilterMethod(FilterMethod filterMethod)
FilterMethod
to be usedfilterMethod
- FilterMethod
to be usedpublic TemplateSearchCriteria.LOGICAL_OPERATOR getTitleDescriptionLogicalOperator()
LOGICAL_OPERATOR
to be used between title(s) and description(s) when both are specified. Defaults to AND
if not specified. Returns null if either title(s) or description(s) is not a search criteria.LOGICAL_OPERATOR
to be used between title(s) and description(s) when both are specifiedpublic void setTitleDescriptionLogicalOperator(TemplateSearchCriteria.LOGICAL_OPERATOR logical_operator)
LOGICAL_OPERATOR
to be used between title(s) and description(s) when both are specified. Ignored if either title(s) or description(s) is not a search criteria.logical_operator
-public TemplateSearchCriteria.TemplateSortCriteria getTemplateSortCriteria()
public void setTemplateSortCriteria(TemplateSearchCriteria.TemplateSortCriteria templateSortCriteria)
templateSortCriteria
-public SortOrder getTemplateSortOrder()
SortOrder
to be used for the template search.SortOrder
for this TemplateSearchCriteria
public void setTemplateSortOrder(SortOrder sortOrder)
SortOrder
to be used for the template search.sortOrder
-public com.bea.netuix.application.identifier.TemplateTypeId getTemplateTypeId()
TemplateTypeId
that this TemplateSearchCriteria
pertains to.public void setTemplateTypeId(com.bea.netuix.application.identifier.TemplateTypeId templateTypeId)
templateTypeId
that this TemplateSearchCriteria
pertains to.templateTypeId
-
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.2) E14255-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010, Oracle. All rights reserved.