com.ibm.portal.content
Interface LocalizedLocator<E extends Localized>

All Superinterfaces:

Locator<E>

All Known Subinterfaces:

PortletDefinitionLocator<T>

public interface LocalizedLocator<E extends Localized>
extends Locator<E>

Since:

8.0.0.1

Nested Class Summary

static class

LocalizedLocator.SearchPattern Enum for a search pattern

Method Summary

java.util.Map<E,java.lang.Iterable<java.util.Locale>>	findByDescription(LocalizedLocator.SearchPattern pattern, java.lang.String term, java.lang.Iterable<java.util.Locale> locales) Performs a search for all localized objects whose descriptions match the given term and pattern in any of the given locales
java.util.Map<E,java.lang.Iterable<java.util.Locale>>	findByTitle(LocalizedLocator.SearchPattern pattern, java.lang.String term, java.lang.Iterable<java.util.Locale> locales) Performs a search for all localized objects whose titles match the given term and pattern in any of the given locales

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

findByTitle

java.util.Map<E,java.lang.Iterable<java.util.Locale>> findByTitle(LocalizedLocator.SearchPattern pattern,
                                                                  java.lang.String term,
                                                                  java.lang.Iterable<java.util.Locale> locales)
                                                                                    throws ModelException

Performs a search for all localized objects whose titles match the given term and pattern in any of the given locales

Parameters:

pattern - The pattern, must not be null

term - The term to search, must not be null

locales - The locales, must not be null and must not be empty.

Returns:

An unmodifiable map holding all found nodes as keys. The associated value represents the set of locales in which the title was found. The implementation of this locator is free to choose if all given locales are processed or if the title matches in one locale the processing of further locales is skipped, e. g. due to performance reasons.

Throws:

ModelException

findByDescription

java.util.Map<E,java.lang.Iterable<java.util.Locale>> findByDescription(LocalizedLocator.SearchPattern pattern,
                                                                        java.lang.String term,
                                                                        java.lang.Iterable<java.util.Locale> locales)
                                                                                          throws ModelException

Performs a search for all localized objects whose descriptions match the given term and pattern in any of the given locales

Parameters:

pattern - The pattern, must not be null

term - The term to search, must not be null

locales - The locales, must not be null and must not be empty.

Returns:

An unmodifiable map holding all found nodes as keys. The associated value represents the set of locales in which the description was found. The implementation of this locator is free to choose if all given locales are processed or if the title matches in one locale the processing of further locales is skipped, e. g. due to performance reasons.

Throws:

ModelException