|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CSOSearchManager
The CSOSearchManager provides the interface for searching the CSOM. It is central piece that manages CSOSearch objects
Method Summary | |
---|---|
CSOSearch |
createSearch()
Creates a search object that can be used for keyword and advanced searches. |
CSOSearchScope |
createSearchScope(java.util.Collection<CentraSiteRegistryObjectType> types)
Creates a CSOSearchScope object from a collection of CSOTypes. |
CSOSearchScope |
createSearchScope(java.lang.String scopeName)
Creates a search scope based on the given name |
CSOSortSpecifier |
createSortSpecifier(CentraSiteObjectAttribute centraSiteObjectAttribute)
Create an instance for CSOSortSpecifier using the given CentraSiteObjectAttribute. |
CSOSortSpecifier |
createSortSpecifier(CentraSiteObjectAttribute centraSiteObjectAttribute,
CSOSortSpecifier.Direction direction)
Create the instance for CSOSortSpecifier by given CentraSiteObjectAttribute and Direction. |
void |
deleteSavedSearch(CSOSearch search)
Deletes a given saved search. |
void |
deleteSavedSearches(java.util.Collection<CSOSearch> searches)
Deletes the given collection of saved searches. |
java.util.List<CentraSiteObjectAttribute> |
getCommonAttributes()
Returns the list of common attributes that are configured in System configuration. |
java.util.Collection<Category> |
getPhoneTypeCategories()
Returns the collection of phone type taxonomy categories. |
java.util.Collection<CSOSearch> |
getReportingSearches()
Fetches the collection of saved searches that are marked as report search |
java.util.Collection<CSOSearch> |
getSavedSearches(java.lang.String name)
Loads the collection of saved searches according to the given name. |
java.util.Collection<CSOSearch> |
getSavedSearches(User user)
Loads the collection of saved searches for a given user. |
CSOSearchConditionManager |
getSearchConditionManager()
Returns the search condition manager which will be used to create a search condition. |
java.util.Collection<CSOSearchScope> |
getSearchScopes()
Returns the collection of configured search scopes |
boolean |
isSearchKeyExists(java.lang.String name)
Checks whether a search with given name already exists. |
CSOSearch |
loadSearch(java.lang.String predefinedSearchName)
Creates a CSOSearch object from the given predefined search name.loadSearch() would pick up the saved search in a hierarchical fashion - starting with user-specific folder, then org-level and then the global (default org) |
void |
saveSearch(CSOSearch search)
Saves the given search with the specified name i.e CSOSearch.getName()
in case of search already exists with the given name then treat this operation as Update. |
void |
saveSearch(CSOSearch search,
boolean overwrite)
Saves the given search with the specified name i.e CSOSearch.getName()
in case of search already exists with the given name then treat this operation as Update
when overwrite flag is set otherwise reject the save |
Method Detail |
---|
CSOSearch createSearch() throws CLLException
CLLException
- if CLL fails to create a search objectCSOSearchConditionManager getSearchConditionManager() throws CLLException
CLLException
- if CLL fails to return the CSO search condition managerCSOSearchScope createSearchScope(java.lang.String scopeName) throws CLLException
scopeName
- Identifier for the CSOsearchScope
CLLException
- if CLL fails to construct CSOSearchScope from the given nameCSOSearchScope createSearchScope(java.util.Collection<CentraSiteRegistryObjectType> types) throws CLLException
types
- Collection of types on which the CSOSearchScope is based on
CLLException
- if CLL fails to construct a CSOSearchScope from the given CSOTypesjava.util.Collection<CSOSearchScope> getSearchScopes() throws CLLException
CLLException
- if CLL fails to return the collection of configured search scopesCSOSortSpecifier createSortSpecifier(CentraSiteObjectAttribute centraSiteObjectAttribute) throws CLLException
centraSiteObjectAttribute
- Attribute for sorting the search results
CLLException
- if CLL fails to construct the CSOSortSpecifier using the given attributeCSOSortSpecifier createSortSpecifier(CentraSiteObjectAttribute centraSiteObjectAttribute, CSOSortSpecifier.Direction direction) throws CLLException
centraSiteObjectAttribute
- Attribute for sorting the search resultsdirection
- CSOSortSpecifier.Direction
whether ascending or descending; if null, the default is ascending.
CLLException
- if CLL fails to construct the CSOSortSpecifier using the given attribute and directionjava.util.List<CentraSiteObjectAttribute> getCommonAttributes() throws CLLException
CLLException
- if CLL fails to return the list of common attributesjava.util.Collection<CSOSearch> getSavedSearches(User user) throws CLLException
user
- Collection of saved searches applicable for the given user
CLLException
java.util.Collection<CSOSearch> getSavedSearches(java.lang.String name) throws CLLException
name
- Collection of saved searches with the given name
CLLException
java.util.Collection<CSOSearch> getReportingSearches() throws CLLException
CLLException
- if CLL fails to fetch the collection of saved search marked as report searchvoid deleteSavedSearch(CSOSearch search) throws CLLException
search
- Saved search
CLLException
- if CLL fails to delete the saved searchvoid deleteSavedSearches(java.util.Collection<CSOSearch> searches) throws CLLException
searches
- Collection of saved searches
CLLException
- if CLL fails to delete the collection of saved searchesvoid saveSearch(CSOSearch search) throws CLLException
CSOSearch.getName()
in case of search already exists with the given name then treat this operation as Update.
search
- Search Object.
CLLException
void saveSearch(CSOSearch search, boolean overwrite) throws CLLException
CSOSearch.getName()
in case of search already exists with the given name then treat this operation as Update
when overwrite flag is set otherwise reject the save
search
- Search Object.
CLLException
boolean isSearchKeyExists(java.lang.String name) throws CLLException
name
- File name of the search without extension
CLLException
- if CLL fails to check if a search with the given name already exists.CSOSearch loadSearch(java.lang.String predefinedSearchName) throws CLLException
predefinedSearchName
-
CSOSearch
for the given name; returns null if there are no saved searches for the given name.
CLLException
- if CLL fails to return the CSOSearch for the given namejava.util.Collection<Category> getPhoneTypeCategories() throws CLLException
Category
(s)
CLLException
- if CLL fails to return the phone type categories
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |