com.ibm.portal.wire
Interface WireLocator

All Superinterfaces:

Locator<Wire>

public interface WireLocator
extends Locator<Wire>

A locator for finding Wires in a wire model. This locator interface is optionally implemented by WireModel implementations

Since:

6.1.0.0

Method Summary

IterableListModel<Wire>	findEffectiveWiresBySourcePortletWindowID(ObjectID sourcePortletWindowID) Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal, use findWiresBySourcePortletWindowID(ObjectID) instead.
IterableListModel<Wire>	findPrivateWires() Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal
IterableListModel<Wire>	findPublicWires() Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal, use the WireModel this locator is received from instead.
IterableListModel<Wire>	findWiresBySourcePortletWindowID(ObjectID sourcePortletWindowID) Finds all wires that originate from the PortletWindow with the given ID.

Methods inherited from interface com.ibm.portal.Locator

findByID, findByUniqueName

Method Detail

findWiresBySourcePortletWindowID

IterableListModel<Wire> findWiresBySourcePortletWindowID(ObjectID sourcePortletWindowID)

Finds all wires that originate from the PortletWindow with the given ID.

Parameters:

sourcePortletWindowID - the object of the window the returned wires originate from. Must not be null.

Returns:

list model containing the Wires originating from the given portlet window ID or an empty list.

Since:

6.1.0.1

findEffectiveWiresBySourcePortletWindowID

IterableListModel<Wire> findEffectiveWiresBySourcePortletWindowID(ObjectID sourcePortletWindowID)

Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal, use findWiresBySourcePortletWindowID(ObjectID) instead.

Finds all wires for effective use that originate from the PortletWindow with the given ID. Private wires superpose public wires if they only differ in the Wire.getUserObjectID().

Parameters:

sourcePortletWindowID - the object of the window the returned wires originate from. Must not be null.

Returns:

list model containing the Wires originating from the given portlet window ID or an empty list.

findPublicWires

IterableListModel<Wire> findPublicWires()

Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal, use the WireModel this locator is received from instead.

Finds all wires that are available to anonymous portal users within this locator´s wire model.

Returns:

All public wires

findPrivateWires

IterableListModel<Wire> findPrivateWires()

Deprecated. since 6.1.0.1 Support for private wires will be removed in a future release of WebSphere Portal

Finds all wires that are available for the current user only.

Returns:

All private wires