|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CSOSearchScope
The CSOSearchScope determines which objects are affected by the search. The default configuration defines the following pre-configured scopes:
Field Summary | |
---|---|
static java.lang.String |
Assets
|
static java.lang.String |
Everything
|
static java.lang.String |
Organizations
|
static java.lang.String |
Users
|
Method Summary | |
---|---|
java.util.Collection<CentraSiteObjectAttribute> |
getAttribute(java.lang.String schemaName)
Returns the CSOAttributes based on their (schema) name. |
java.util.Collection<CentraSiteObjectAttribute> |
getAttributes()
Returns the Collection of CSOAttributes for the current scope. |
java.lang.String |
getDisplayName()
Retrieves the dsiplay name of the scope according to the user locale. |
java.lang.String |
getDisplayName(java.util.Locale locale)
Retrieves the display name of the type according to the given locale. |
java.util.Collection<Category> |
getExcludedCategories()
Returns a collection of categories that are excluded from the search scope. |
java.util.Collection<Category> |
getIncludedCategories()
Returns a collection of categories that are included in the search scope. |
java.lang.String |
getName()
Retrieves the name of the scope. |
java.util.Collection<CentraSiteRegistryObjectType> |
getTypes()
Returns the asset types which is attached with the search scope Inbox/Everything search scopes will have more than one types |
boolean |
isExpandable()
Returns whether this scope is expandable or not. |
void |
setExcludedCategories(java.util.Collection<Category> categories)
Sets the collection of categories which need to be excluded the search scope. |
void |
setIncludedCategories(java.util.Collection<Category> categories)
Sets the collection of categories which need to be included in the search scope. |
Field Detail |
---|
static final java.lang.String Users
static final java.lang.String Organizations
static final java.lang.String Assets
static final java.lang.String Everything
Method Detail |
---|
java.lang.String getName()
java.lang.String getDisplayName() throws CLLException
CLLException
java.lang.String getDisplayName(java.util.Locale locale)
locale
- Locale for which the name has to be fetched
boolean isExpandable()
java.util.Collection<CentraSiteRegistryObjectType> getTypes()
java.util.Collection<CentraSiteObjectAttribute> getAttribute(java.lang.String schemaName)
schemaName
- name that identifies a attribute in the current search scope
java.util.Collection<Category> getIncludedCategories()
java.util.Collection<Category> getExcludedCategories()
void setExcludedCategories(java.util.Collection<Category> categories)
categories
- - Collection of categoriesvoid setIncludedCategories(java.util.Collection<Category> categories)
categories
- - Collection of categoriesjava.util.Collection<CentraSiteObjectAttribute> getAttributes()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |