com.ibm.portal.cp.tagging
Interface TagModelLocator<T extends Tag,S extends TagSpace>

All Superinterfaces:

Constants, Locator<T>, ResourceLocator<T>, TagLocator<T>, TagSpaceLocator<S>

public interface TagModelLocator<T extends Tag,S extends TagSpace>
extends TagLocator<T>, TagSpaceLocator<S>

Combines some locators for the TagModel

Since:

7.0.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.cp.Constants

Constants.Order, Constants.OrderMetric, Constants.SearchPattern

Field Summary

Fields inherited from interface com.ibm.portal.cp.Constants

ALL, BEGIN, COLON, DEFAULT_ORDER, DEFAULT_ORDERMETRIC

Method Summary

CountableIterablePagedListModel<java.lang.String>

findTypeAheadTagNames(Constants.SearchPattern searchPattern, java.lang.String searchTerm, Constants.OrderMetric orderMetric, Constants.Order order, java.util.Collection<java.util.Locale> locales) Returns a list of Strings representing tag names.

Methods inherited from interface com.ibm.portal.cp.tagging.TagLocator

findByOwner, findByResourceID, findByResourceIDAndOwner, findByResourceIDs, findByResourceIDsAndOwner, findByResourceURI, findByResourceURIAndOwner, findByResourceURIs, findByResourceURIsAndOwner, findByTagName, findByTagNameAndOwner, findByTagNameAndResourceID, findByTagNameAndResourceIDAndOwner, findByTagNameAndResourceIDs, findByTagNameAndResourceURI, findByTagNameAndResourceURIAndOwner, findByTagNameAndResourceURIs, findTags

Methods inherited from interface com.ibm.portal.cp.ResourceLocator

findByResourceID, findByResourceIDs

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Methods inherited from interface com.ibm.portal.cp.tagging.TagSpaceLocator

findTagSpaces, findTagSpacesByCategories, findTagSpacesByCategoriesAndOwner, findTagSpacesByCategory, findTagSpacesByCategoryAndOwner, findTagSpacesByOwner, findTagSpacesByResourceID, findTagSpacesByResourceIDAndOwner, findTagSpacesByResourceIDs, findTagSpacesByResourceIDsAndOwner, findTagSpacesByResourceURI, findTagSpacesByResourceURIAndOwner, findTagSpacesByResourceURIs, findTagSpacesByResourceURIsAndOwner, findTagSpacesByTypeSchema, findTagSpacesByTypeSchemaAndOwner, findTagSpacesByTypeSchemas, findTagSpacesByTypeSchemasAndOwner

Method Detail

findTypeAheadTagNames

CountableIterablePagedListModel<java.lang.String> findTypeAheadTagNames(Constants.SearchPattern searchPattern,
                                                                        java.lang.String searchTerm,
                                                                        Constants.OrderMetric orderMetric,
                                                                        Constants.Order order,
                                                                        java.util.Collection<java.util.Locale> locales)
                                                                        throws ModelException

Returns a list of Strings representing tag names. This method is e. g. suitable to implement a typeahead feature.

Parameters:

searchPattern - The search pattern for the tags to be searched for, must not be null

searchTerm - The search term

orderMetric - (see Constants.OrderMetric) The order metric in which the results are to be returned. May be null.

order - (see Constants.ORDER) The order in which the results are to be returned. May be null.

locales - A collection of locales in which the tag names to find should be searched. May be null - in this case the returned tag names are locale independent.

Returns:

A list of Strings, containing a distinct tag names matching the giving search term and search pattern.

Throws:

ModelException