public interface IQueryFolder
To get a query folder follow this example:
IIndexService indexService = (IIndexService)ResourceFactory.getInstance().getServiceFactory().getService(IServiceTypesConst.INDEX_SERVICE);
IQBClassificationIndex qbcIndex = (IQBClassificationIndex)indexService.getIndex("indexid");
IQueryFolder queryFolder = qbcIndex.getQueryFolder(RID.getRID("/taxonomies/indexid/taxonomyname/categoryname"));
| Modifier and Type | Method and Description |
|---|---|
IQueryFolder |
copy(RID destination,
IResourceContext context)
Reflects a copy of a folder in the taxonomy repository to perform the copy
also in the hierarchical query structure.
|
void |
delete(IResourceContext context)
Deletes the query folder in the QBC-engine and in the CM persistence.
|
String |
getIndexID()
Gets the ID of the index where the query is stored.
|
IQueryEntryList |
getQuery(IResourceContext context)
Gets the query of the query folder.
|
ISearchResultList |
getQueryDocuments(IResourceContext context)
Documents of the index that match the query of the folder.
|
RID |
getRID()
Gets the resource ID of the query folder.
|
boolean |
isDirty(IResourceContext context)
A flag for the query folder that indicates whether the documents of the
category match the current query or not.
|
boolean |
isQueryDefined(IResourceContext context)
Checks for existence of a query for the query folder.
|
IQueryFolder |
move(RID destination,
IResourceContext context)
Reflects a move of a folder in the taxonomy repository to perform the move
also in the hierarchical query structure.
|
void |
setDirty(boolean isDirty,
IResourceContext context)
Sets a flag for the query folder that indicates that the documents of the
category don't match the current query.
|
void |
setQuery(IQueryEntryList query,
IResourceContext context)
Sets a query for the query folder.
|
void |
setQueryFast(IQueryEntryList query,
IResourceContext context)
Sets a query for the query folder.
|
String getIndexID()
RID getRID()
IQueryEntryList getQuery(IResourceContext context) throws WcmException
context - user contextWcmException - WcmExceptionvoid setQuery(IQueryEntryList query, IResourceContext context) throws WcmException
IQBClassificationIndex#updateCategoryContents must be executed.query - query to set for this query foldercontext - user contextWcmException - WcmExceptionvoid setQueryFast(IQueryEntryList query, IResourceContext context) throws WcmException
IQBClassificationIndex#updateCategoryContents must be executed.
This is the faster version for Trex than setQuery.query - query to set for this query foldercontext - user contextWcmException - WcmExceptionIQueryFolder move(RID destination, IResourceContext context) throws WcmException
destination - resource ID of the query folder after the movecontext - user contextWcmException - WcmExceptionIQueryFolder copy(RID destination, IResourceContext context) throws WcmException
destination - resource ID of the query folder after the copycontext - the contextWcmException - WcmExceptionvoid delete(IResourceContext context) throws WcmException
context - user contextWcmException - WcmExceptionvoid setDirty(boolean isDirty,
IResourceContext context)
throws WcmException
IQBClassificationIndex#updateCategoryContents
must be executed.isDirty - true if the query of the folder has been updated but the
documents of the folder are still the old.context - user contextWcmException - WcmExceptionboolean isDirty(IResourceContext context) throws WcmException
context - user contextWcmException - WcmExceptionISearchResultList getQueryDocuments(IResourceContext context) throws WcmException
context - user contextWcmException - WcmExceptionboolean isQueryDefined(IResourceContext context) throws WcmException
context - user contextWcmException - WcmException| Access Rights |
|---|
| SC | DC | Public Part | ACH |
|---|---|---|---|
[sap.com] KMC-CM
|
[sap.com] tc/km/frwk
|
api
|
EP-KM-CM
|
[sap.com] KMC-WPC
|
[sap.com] tc/kmc/wpc/wpcfacade
|
api
|
EP-PIN-WPC-WCM
|
Copyright 2021 SAP SE Complete Copyright Notice