com.sapportals.wcm.service.indexmanagement.retrieval.classification

Interface ITaxonomyCollection

public interface ITaxonomyCollection

Offers additional functionality for a folder of a taxonomy manager.
Changes between major releases 7.0 and 7.X

• Added methods: buildQueryEntryList() buildQueryEntryListForPathOnly() getAllDocumentsBelowVirtualTaxNode() getChildrenWithAdditionalQuery(IQueryEntryList) getChildrenWithAdditionalQuery(IQueryEntryList, IRidList, Set) getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList) getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList, IRidList, Set) getDisplayNameSuffix() getIndexIds() getInternalNodeAlternatives(int, IQueryEntryList) getInternalNodeAlternatives(int, IQueryEntryList, IRidList, Set) getPropertyName() getQueryDisplayNameforQueryRid() getQueryEntryList() getRangeFrom() getRangeTo() getVirtualTaxDisplayNameDefinition() getVirtualTaxNodeType() isVirtualTaxRid() searchWithSession(IQueryEntryList, ISortPropertyName) setQueryEntryList(IQueryEntryList)
• Removed methods:

Method Summary

IQueryEntryList	buildQueryEntryList() Returns for a collection in a virtual taxonomy the query defined by the path to this collection.
IQueryEntryList	buildQueryEntryListForPathOnly() Returns for a collection in a virtual taxonomy the query defined by the path to this collection.
IResourceList	getAllDocumentsBelowVirtualTaxNode() Returns all documents below a category node in a virtual taxonomy.
IResourceList	getChildrenWithAdditionalQuery(IQueryEntryList qList) Returns the children of a node of a virtual taxonomy whereby the defined query further restricts the document set.
IResourceList	getChildrenWithAdditionalQuery(IQueryEntryList qList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, Set languages) Returns the children of a node of a virtual taxonomy whereby the defined query further restricts the document set.
IResourceList	getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList) Returns the children which are collections of a node of a virtual taxonomy whereby the defined query further restricts the document set.
IResourceList	getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, Set languages) Returns the children which are collections of a node of a virtual taxonomy whereby the defined query further restricts the document set.
ICollection	getDataCollection() Gets the collection object of the repository that holds the taxonomy hierarchies.
String	getDisplayNameSuffix() Returns the specified suffix for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_NAME and IWcmIndexConst.VIR_ATTR_VALUE.
String[]	getIndexIds() Returns an array of all indexes of the virtual taxonomy the collection belongs to.
IResourceList	getInternalNodeAlternatives(int position, IQueryEntryList qList) Computes the attribute value and query rid alternatives for the specified position of the rid of the collection, whereby all restrictions until that position without the restriction of the position itself, the restriction beyond the position and the restrictions of the additional query entry list are considered.
IResourceList	getInternalNodeAlternatives(int position, IQueryEntryList qList, com.sapportals.wcm.util.uri.IRidList searchFromHereList, Set languages) Computes the attribute value and query rid alternatives for the specified position of the rid of the collection, whereby all restrictions until that position without the restriction of the position itself, the restriction beyond the position and the restrictions of the additional query entry list are considered.
IPropertyName	getPropertyName() Returns the specified property name for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_NAME and IWcmIndexConst.VIR_ATTR_VALUE.
String	getQueryDisplayNameforQueryRid() Returns the display name of the associated VIR_QUERY section for a node in a virtual taxonomy of type IWcmIndexConst.VIR_QUERY_RID.
IQueryEntryList	getQueryEntryList() Return the additional query which is also considered during navigation.
IProperty	getRangeFrom() Returns the property which describes the lower range of a category in a virtual taxonomy.
IProperty	getRangeTo() Returns the property which describes the upper range of a category in a virtual taxonomy.
String	getVirtualTaxDisplayNameDefinition() Returns the display name definitions of the DTD of a virtual taxonomy.
String	getVirtualTaxNodeType() Returns the type of a folder in a virtual taxononmy.
boolean	isVirtualTaxRid() Returns true is the collection is part of a virtual taxonomy.
ISearchSession	searchWithSession(IQueryEntryList queryEntryList, ISortPropertyName sortProperty) Returns a search session with the restictions of the path to the collection and the query entry list.
void	sendEventForLink(int eventType, com.sapportals.wcm.util.uri.RID taxonomyClassRid, com.sapportals.wcm.util.uri.RID targetRid, IResourceContext context) Creates a link resource object and sends an event of the given event type
void	sendEventForLink(int eventType, com.sapportals.wcm.util.uri.RID taxonomyClassRid, com.sapportals.wcm.util.uri.RID targetRid, IResourceContext context, IResourceEvent originalEvent) Creates a link resource object and sends an event of the given event type
void	setQueryEntryList(IQueryEntryList list) Sets the additional query which is also considered during navigation.

Method Detail

sendEventForLink

void sendEventForLink(int eventType,
                      com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                      com.sapportals.wcm.util.uri.RID targetRid,
                      IResourceContext context)
                      throws com.sapportals.wcm.WcmException

Creates a link resource object and sends an event of the given event type

Parameters:

taxonomyClassRid - rid the taxonomy class where the document is a link in

targetRid - rid of the document in its original location

context - resource context

Throws:

com.sapportals.wcm.WcmException

sendEventForLink

void sendEventForLink(int eventType,
                      com.sapportals.wcm.util.uri.RID taxonomyClassRid,
                      com.sapportals.wcm.util.uri.RID targetRid,
                      IResourceContext context,
                      IResourceEvent originalEvent)
                      throws com.sapportals.wcm.WcmException

Creates a link resource object and sends an event of the given event type

Parameters:

taxonomyClassRid - rid the taxonomy class where the document is a link in

targetRid - rid of the document in its original location

context - resource context

originalEvent - event received from the framework for the original document

Throws:

com.sapportals.wcm.WcmException

getDataCollection

ICollection getDataCollection()

Gets the collection object of the repository that holds the taxonomy hierarchies.

Returns:

collection object of the data repository

getIndexIds

String[] getIndexIds()
                     throws ResourceException

Returns an array of all indexes of the virtual taxonomy the collection belongs to. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

buildQueryEntryList

IQueryEntryList buildQueryEntryList()
                                    throws ResourceException

Returns for a collection in a virtual taxonomy the query defined by the path to this collection. If available also the used additional query is added. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

buildQueryEntryListForPathOnly

IQueryEntryList buildQueryEntryListForPathOnly()
                                               throws ResourceException

Returns for a collection in a virtual taxonomy the query defined by the path to this collection. An additional query is not added. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

isVirtualTaxRid

boolean isVirtualTaxRid()
                        throws ResourceException

Returns true is the collection is part of a virtual taxonomy. Otherwise false.

Returns:

Throws:

ResourceException

getAllDocumentsBelowVirtualTaxNode

IResourceList getAllDocumentsBelowVirtualTaxNode()
                                                 throws ResourceException

Returns all documents below a category node in a virtual taxonomy. If separation folders are defined, these are presented if to many documents are below the node. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getVirtualTaxNodeType

String getVirtualTaxNodeType()
                             throws ResourceException

Returns the type of a folder in a virtual taxononmy. The return value is: - IWcmIndexConst.VIR_QUERY if the collection presents a folder for a query level - IWcmIndexConst.VIR_QUERY_RID if the collection presents a folder for one particular query - IWcmIndexConst.VIR_ATTR_NAME if the collection presents a folder for an attribute level - IWcmIndexConst.VIR_ATTR_VALUE if the collection presents a range or a particular value of an attribute. - IWcmIndexConst.VIR_DOC_SEPARATION_NUMBER if the collection presents a separation folder for documents. - IWcmIndexConst.VIR_ALL_VALUES_SEP_NUM if the collection presents a separation folder attribute values. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getRangeFrom

IProperty getRangeFrom()
                       throws ResourceException

Returns the property which describes the lower range of a category in a virtual taxonomy. Also if no range but only one particular value is defined for a category, that value is returned here. This method is only defined for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_VALUE. For all other nodes a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getRangeTo

IProperty getRangeTo()
                     throws ResourceException

Returns the property which describes the upper range of a category in a virtual taxonomy. Also if no range but only one particular value is defined for a category, that value is returned here. This method is only defined for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_VALUE. For all other nodes a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getVirtualTaxDisplayNameDefinition

String getVirtualTaxDisplayNameDefinition()
                                          throws ResourceException

Returns the display name definitions of the DTD of a virtual taxonomy. This is not the same as the display name of the nodes in the virtual taxonomy. Depending of the node type the following is returned: - IWcmIndexConst.VIR_QUERY: The value of the name entry of the associated VIR_QUERY section of the DTD is returned. - IWcmIndexConst.VIR_QUERY_RID: The value of the name entry of the associated VIR_QUERY_RID section of the DTD is returned. If navigation is done in a QBC (workInQBT="true"), the display name of the node of the QBC is returned. - IWcmIndexConst.VIR_ATTR_NAME: The value of the displayName entry of the associated VIR_ATTR section of the DTD is returned. - IWcmIndexConst.VIR_ATTR_VALUE: The value of the displayName entry of the associated VIR_ATTR section of the DTD is returned. - IWcmIndexConst.VIR_DOC_SEPARATION_NUMBER: The value of the separationFolderName entry of the VIR_DEFINITIONS section of the DTD is returned. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getChildrenWithAdditionalQuery

IResourceList getChildrenWithAdditionalQuery(IQueryEntryList qList)
                                             throws ResourceException

Returns the children of a node of a virtual taxonomy whereby the defined query further restricts the document set. The query remains set for the collection, i.e. calling getChildren without further restrictions also considers the query. The query is only set for this object and the returned collection objects. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Parameters:

qList -

Returns:

Throws:

ResourceException

getChildrenWithAdditionalQuery

IResourceList getChildrenWithAdditionalQuery(IQueryEntryList qList,
                                             com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                             Set languages)
                                             throws ResourceException

Returns the children of a node of a virtual taxonomy whereby the defined query further restricts the document set. Furthermore the restrictions for starting search are considered as well as the set of languages. If searchFromHereList is null all indexes of the virtual taxonomie aer considered. If languages is null no language restriction is made. The query, the start folder and the languages remains set for the collection, i.e. calling getChildren without further restrictions also considers the query. The settings are only set for this object and the returned collection objects. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Parameters:

qList -

searchFromHereList -

languages -

Returns:

Throws:

ResourceException

getChildrenWithAdditionalQueryOnlyCollections

IResourceList getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList)
                                                            throws ResourceException

Returns the children which are collections of a node of a virtual taxonomy whereby the defined query further restricts the document set. The query remains set for the collection, i.e. calling getChildren without further restrictions also considers the query. The query is only set for this object and the returned collection objects. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Parameters:

qList -

Returns:

Throws:

ResourceException

getChildrenWithAdditionalQueryOnlyCollections

IResourceList getChildrenWithAdditionalQueryOnlyCollections(IQueryEntryList qList,
                                                            com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                                            Set languages)
                                                            throws ResourceException

Returns the children which are collections of a node of a virtual taxonomy whereby the defined query further restricts the document set. Furthermore the restrictions for starting search are considered as well as the set of languages. If searchFromHereList is null all indexes of the virtual taxonomie aer considered. If languages is null no language restriction is made. The query, the start folder and the languages remains set for the collection, i.e. calling getChildren without further restrictions also considers the query. The settings are only set for this object and the returned collection objects. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Parameters:

qList -

searchFromHereList -

languages -

Returns:

Throws:

ResourceException

getDisplayNameSuffix

String getDisplayNameSuffix()
                            throws ResourceException

Returns the specified suffix for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_NAME and IWcmIndexConst.VIR_ATTR_VALUE. For other nodes a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getQueryDisplayNameforQueryRid

String getQueryDisplayNameforQueryRid()
                                      throws ResourceException

Returns the display name of the associated VIR_QUERY section for a node in a virtual taxonomy of type IWcmIndexConst.VIR_QUERY_RID. For other nodes a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getPropertyName

IPropertyName getPropertyName()
                              throws ResourceException

Returns the specified property name for nodes in virtual taxonomies of type IWcmIndexConst.VIR_ATTR_NAME and IWcmIndexConst.VIR_ATTR_VALUE. For other nodes a NotSupportedException is thrown.

Returns:

Throws:

ResourceException

getInternalNodeAlternatives

IResourceList getInternalNodeAlternatives(int position,
                                          IQueryEntryList qList)
                                          throws com.sapportals.wcm.WcmException

Computes the attribute value and query rid alternatives for the specified position of the rid of the collection, whereby all restrictions until that position without the restriction of the position itself, the restriction beyond the position and the restrictions of the additional query entry list are considered. The result is returned as virtual tax nodes with a rid until the specified position. The values and query rid can be deternimed using the appropriate methods of these nodes. The method throws an exception if the position does not define a attribute value or query rid node in a virtual taxonomy.

Parameters:

position -

qList -

Returns:

Throws:

com.sapportals.wcm.WcmException

getInternalNodeAlternatives

IResourceList getInternalNodeAlternatives(int position,
                                          IQueryEntryList qList,
                                          com.sapportals.wcm.util.uri.IRidList searchFromHereList,
                                          Set languages)
                                          throws com.sapportals.wcm.WcmException

Computes the attribute value and query rid alternatives for the specified position of the rid of the collection, whereby all restrictions until that position without the restriction of the position itself, the restriction beyond the position and the restrictions of the additional query entry list are considered. The result is returned as virtual tax nodes with a rid until the specified position. The values and query rid can be deternimed using the appropriate methods of these nodes. The method throws an exception if the position does not define a attribute value or query rid node in a virtual taxonomy.

Parameters:

position -

qList -

searchFromHereList -

languages -

Returns:

Throws:

com.sapportals.wcm.WcmException

getQueryEntryList

IQueryEntryList getQueryEntryList()

Return the additional query which is also considered during navigation. The query is only set for this object.

Returns:

setQueryEntryList

void setQueryEntryList(IQueryEntryList list)

Sets the additional query which is also considered during navigation. The query is only set for this object and for children collections is getChildren is called on this object.

Parameters:

list -

searchWithSession

ISearchSession searchWithSession(IQueryEntryList queryEntryList,
                                 ISortPropertyName sortProperty)
                                 throws com.sapportals.wcm.WcmException

Returns a search session with the restictions of the path to the collection and the query entry list. The paramameter queryEntryList remains set for the collection, i.e. calling getChildren without further restrictions also considers the queryEntryList. For collections which do not belong to a virtual taxonomy a NotSupportedException is thrown.

Parameters:

queryEntryList -

sortProperty -

Returns:

Throws:

com.sapportals.wcm.WcmException

Access Rights

This class can be accessed from:

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