public interface CSOSearchScope
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
Assets |
static java.lang.String |
Everything |
static java.lang.String |
Types |
Modifier and Type | Method and Description |
---|---|
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 display 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.lang.String |
getReferencedScopeId()
Returns the referenced Scope Id from CSOTypeScope.
|
java.util.Collection<CentraSiteRegistryObjectType> |
getTypes()
Returns the asset types attached with the search scope.
|
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.
|
void |
setReferencedScopeId(java.lang.String scopeId)
Sets the reference Scope Id on CSOTypeScope.
|
static final java.lang.String Assets
static final java.lang.String Everything
static final java.lang.String Types
java.lang.String getName()
java.lang.String getDisplayName() throws CLLException
CLLException
- If CLL fails to get the display namejava.lang.String getDisplayName(java.util.Locale locale)
locale
- Locale
for which the name has to be fetchedboolean isExpandable()
java.util.Collection<CentraSiteRegistryObjectType> getTypes()
Collection
of asset types as CentraSiteRegistryObjectType
s attached with the scopejava.util.Collection<CentraSiteObjectAttribute> getAttribute(java.lang.String schemaName)
schemaName
- name that identifies a attribute in the current search scopeCollection
of CentraSiteObjectAttribute
s for the given schemaNamejava.util.Collection<Category> getIncludedCategories()
Collection
of included Category
objects in the search scopejava.util.Collection<Category> getExcludedCategories()
Collection
of excluded Category
objects in the search scopevoid setExcludedCategories(java.util.Collection<Category> categories)
categories
- Collection
of Category
objects to excludevoid setIncludedCategories(java.util.Collection<Category> categories)
categories
- Collection
of Category
objects to includejava.util.Collection<CentraSiteObjectAttribute> getAttributes()
Collection
of CentraSiteObjectAttribute
s for the current search scopevoid setReferencedScopeId(java.lang.String scopeId)
scopeId
- The reference scope id to setjava.lang.String getReferencedScopeId()