|
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
com.bea.netuix.application.communities.CommunitySearchCriteria
public class CommunitySearchCriteria
CommunitySearchCriteria - search criteria for communities. If localize
is set to true
results will be sorted by title
else CommunityDefinitionId
will be used. If more than one properties are specified as filter criteria they will be OR'ed in the resulting search. When using the setTitle and setDescription methods, if a FilterCriteria for one of these is also used on the paginated request (most likely for a refilter), the FilterCriteria will override the former setter methods. <p/>The overview of community functionality contains a description of the community framework.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.bea.netuix.application.manager.persistence.TemplateSearchCriteria |
---|
TemplateSearchCriteria.LOGICAL_OPERATOR, TemplateSearchCriteria.TemplateSortCriteria |
Constructor Summary | |
---|---|
CommunitySearchCriteria(PortalSearchCriteria portalSearchCriteria) |
|
CommunitySearchCriteria(String webAppName) Ctor - localize defaults to false . |
|
CommunitySearchCriteria(TemplateSearchCriteria templateSearchCriteria) Creates a CommunitySearchCriteria from a TemplateSearchCriteria |
|
CommunitySearchCriteria(WebAppSearchCriteria webAppSearchCriteria) Creates a CommunitySearchCriteria from a WebAppSearchCriteria |
Method Summary | |
---|---|
boolean |
isFilterByAccessTrackingEnabled() Returns true if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false if both types of communities will be returned. |
boolean |
isFilterByActive() Returns true if search results will be filtered to include either only active or only inactive communities, false if both active and inactive communities will be returned. |
boolean |
isFilterByPersonalPagesEnabled() Returns true if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false if both types of communities will be returned. |
boolean |
isFilterByPublic() Returns true if search results will be filtered to include either only public or only non-public communities, false if both public and non-public communities will be returned. |
boolean |
isFilterByPublicRegistration() Returns true if search results will be filtered to include either only communities with publicRegistration enabled or only communities with publicRegistration disabled, false if both types of communities will be returned. |
boolean |
isIgnoreExpiredCommunities() Returns true if search results will ignore expired communities |
boolean |
isIncludeAccessTrackingEnabled() Returns true if search results will be filtered to include only communities with personalPages enabled, false if search results will be filtered to include only communities with personalPages disabled |
boolean |
isIncludeActive() Returns true if search results will be filtered to include only active communities, false if search results will be filtered to include only inactive communities |
boolean |
isIncludePersonalPagesEnabled() Returns true if search results will be filtered to include only communities with personalPages enabled, false if search results will be filtered to include only communities with personalPages disabled |
boolean |
isIncludePublic() Returns true if search results will be filtered to include only public communities, false if search results will be filtered to include only non-public communities |
boolean |
isIncludePublicRegistration() Returns true if search results will be filtered to include only communities with publicRegistration enabled, false if search results will be filtered to include only communities with publicRegistration disabled |
boolean |
isLocalizeCriteria() Returns true if CommunityDefinition s returned as a result if this search should have localized titles and descriptions |
void |
setFilterByAccessTrackingEnabled(boolean filterByAccessTrackingEnabled, boolean includeAccessTrackingEnabled) Sets filtering by communities accessTrackingEnabled flag. |
void |
setFilterByActive(boolean filterByActive, boolean includeActive) Sets filtering by communities active flag. |
void |
setFilterByPersonalPagesEnabled(boolean filterByPersonalPagesEnabled, boolean includePersonalPagesEnabled) Sets filtering by communities personalPagesEnabled flag. |
void |
setFilterByPublic(boolean filterByPublic, boolean includePublic) Sets filtering by communities public flag. |
void |
setFilterByPublicRegistration(boolean filterByPublicRegistration, boolean includePublicRegistration) Sets filtering by communities publicRegistration flag. |
void |
setIgnoreExpiredCommunities(boolean ignoreExpiredCommunities) Sets the ignoreExpiredCommunities flag |
void |
setLocalize(boolean localize) Set to true if CommunityDefinition s should be returned with titles and descriptions as opposed to LocalizationIntersectionId s |
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 CommunitySearchCriteria(String webAppName)
false
.
webAppName
- web app namepublic CommunitySearchCriteria(WebAppSearchCriteria webAppSearchCriteria)
CommunitySearchCriteria
from a WebAppSearchCriteria
webAppSearchCriteria
- source WebAppSearchCriteriapublic CommunitySearchCriteria(TemplateSearchCriteria templateSearchCriteria)
CommunitySearchCriteria
from a TemplateSearchCriteria
templateSearchCriteria
- source TemplateSearchCriteria
public CommunitySearchCriteria(PortalSearchCriteria portalSearchCriteria)
Method Detail |
---|
public boolean isLocalizeCriteria()
true
if CommunityDefinition
s returned as a result if this search should have localized titles and descriptionstrue
if search results should be localizedpublic void setLocalize(boolean localize)
true
if CommunityDefinition
s should be returned with titles and descriptions as opposed to LocalizationIntersectionId
slocalize
-public boolean isIgnoreExpiredCommunities()
true
if search results will ignore expired communitiestrue
if search results will ignore expired communitiespublic void setIgnoreExpiredCommunities(boolean ignoreExpiredCommunities)
ignoreExpiredCommunities
-public boolean isFilterByPublic()
true
if search results will be filtered to include either only public or only non-public communities, false
if both public and non-public communities will be returned.true
if search results will be filtered to include either only public or only non-public communities, false
if both public and non-public communities will be returnedpublic boolean isIncludePublic()
true
if search results will be filtered to include only public communities, false
if search results will be filtered to include only non-public communitiestrue
if search results will be filtered to include only public communities, false
if search results will be filtered to include only non-public communitiespublic void setFilterByPublic(boolean filterByPublic, boolean includePublic)
filterByPublic
- if true
then filtering by public flag will be performedincludePublic
- if true
then only public communities will be selected by this search criteria, if false
only non-public communities will be returned by this search criteriapublic boolean isFilterByActive()
true
if search results will be filtered to include either only active or only inactive communities, false
if both active and inactive communities will be returned.true
if search results will be filtered to include either only active or only inactive communities, false
if both active and inactive communities will be returnedpublic boolean isIncludeActive()
true
if search results will be filtered to include only active communities, false
if search results will be filtered to include only inactive communitiestrue
if search results will be filtered to include only active communities, false
if search results will be filtered to include only inactive communitiespublic void setFilterByActive(boolean filterByActive, boolean includeActive)
filterByActive
- if true
then filtering by active flag will be performedincludeActive
- if true
then only active communities will be selected by this search criteria, if false
only inactive communities will be returned by this search criteriapublic boolean isFilterByPublicRegistration()
true
if search results will be filtered to include either only communities with publicRegistration enabled or only communities with publicRegistration disabled, false
if both types of communities will be returned.true
if search results will be filtered to include either only communities with publicRegistration enabled or only communities with publicRegistration disabled, false
if both types of communities will be returnedpublic boolean isIncludePublicRegistration()
true
if search results will be filtered to include only communities with publicRegistration enabled, false
if search results will be filtered to include only communities with publicRegistration disabledtrue
if search results will be filtered to include only communities with publicRegistration enabled, false
if search results will be filtered to include only communities with publicRegistration disabledpublic void setFilterByPublicRegistration(boolean filterByPublicRegistration, boolean includePublicRegistration)
filterByPublicRegistration
- if true
then filtering by publicRegistration flag will be performedincludePublicRegistration
- if true
then only communities with publicRegistration enabled will be selected by this search criteria, if false
only communities with publicRegistration disabled will be returned by this search criteriapublic boolean isFilterByPersonalPagesEnabled()
true
if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false
if both types of communities will be returned.true
if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false
if both types of communities will be returnedpublic boolean isIncludePersonalPagesEnabled()
true
if search results will be filtered to include only communities with personalPages enabled, false
if search results will be filtered to include only communities with personalPages disabledtrue
if search results will be filtered to include only communities with personalPages enabled, false
if search results will be filtered to include only communities with personalPages disabledpublic void setFilterByPersonalPagesEnabled(boolean filterByPersonalPagesEnabled, boolean includePersonalPagesEnabled)
filterByPersonalPagesEnabled
- if true
then filtering by personalPagesEnabled flag will be performedincludePersonalPagesEnabled
- if true
then only communities with personalPages enabled will be selected by this search criteria, if false
only communities with personalPages disabled will be returned by this search criteriapublic boolean isFilterByAccessTrackingEnabled()
true
if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false
if both types of communities will be returned.true
if search results will be filtered to include either only communities with personalPages enabled or only communities with personalPages disabled, false
if both types of communities will be returnedpublic boolean isIncludeAccessTrackingEnabled()
true
if search results will be filtered to include only communities with personalPages enabled, false
if search results will be filtered to include only communities with personalPages disabledtrue
if search results will be filtered to include only communities with personalPages enabled, false
if search results will be filtered to include only communities with personalPages disabledpublic void setFilterByAccessTrackingEnabled(boolean filterByAccessTrackingEnabled, boolean includeAccessTrackingEnabled)
filterByAccessTrackingEnabled
- if true
then filtering by accessTrackingEnabled flag will be performedincludeAccessTrackingEnabled
- if true
then only communities with personalPages enabled will be selected by this search criteria, if false
only communities with personalPages disabled will be returned by this search criteria
|
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.