com.ibm.portal.outbound.config
Interface AdministrableLocator<T extends java.lang.Object & Administrable>

Type Parameters:

T - The type of object for which this locator applies.

All Known Subinterfaces:

CookieRuleLocator, OutboundConnectionProfileLocator, PolicyMappingLocator, PolicyRuleLocator, PolicyVariableLocator

public interface AdministrableLocator<T extends java.lang.Object & Administrable>

A locator for Objects that implement the Administrable interface. The locator provides services to get outbound HTTP connection configuration elements.

Since:

8.5.0

Method Summary

void	collectAllMatching(PatternMatcher<T> matcher, java.util.List<T> collection) Create a sorted list of administrable objects that match with the given matching criteria.
T	findByName(java.lang.String name) locates and returns a config object via its name
IterableListModel<T>	listAll() Returns a list model for all configuration elements that are reachable by this locator object.

Method Detail

findByName

T findByName(java.lang.String name)

locates and returns a config object via its name

Parameters:

name - The name of the item that should be returned.

Returns:

T The Administrable object that has the specified name and that is reachable by this locator object. null if the object could not be found.

listAll

IterableListModel<T> listAll()

Returns a list model for all configuration elements that are reachable by this locator object.

Returns:

a List of Administrable objects that are accessible by this locator. never null.

collectAllMatching

void collectAllMatching(PatternMatcher<T> matcher,
                        java.util.List<T> collection)

Create a sorted list of administrable objects that match with the given matching criteria. The method invokes the method listAll() to get all possible items that. are in the scope of this locator instance. For each of the candidates and all elements that are already in the collection list, the presented PatternMatcher is invoked. The matcher returns an integer value that determines

• if the candidate should be included at all(a return value >0 means to include the candidate to the collection, a return value 0 means not to include the candidate
• in which list order order the candidate should appear (high value mens at the top of the list).

It is up to the implementation of the PatternMatcher to decide appropriate values for the matching gravity. Also note that the presented collection does not have to be empty, when the collectAllMatching() method is invoked. However, this method invokes the pattern matcher against all objects.

Parameters:

matcher - the pattern matcher.

A - list of objects. The presented PatternMatcher object is invoked against all best-matching object is on top of the list.