com.ibm.portal.wire
Interface WireModel<T extends java.lang.Object & Wire>
- All Superinterfaces:
- Invalidatable, InvalidatableListModel<T>, java.lang.Iterable<T>, IterableListModel<T>, ListModel<T>, LocatorProvider<T>, SearchableListModel<T>
- All Known Subinterfaces:
- WireModelController<T,M>
public interface WireModel<T extends java.lang.Object & Wire>
- extends InvalidatableListModel<T>, SearchableListModel<T>, IterableListModel<T>
Interface for a wire model. This list model provides
Wires relevant within a given
LayoutModel. This model includes
Wires for the page at hand as well as wires
pointing from the given page to any other page.
The wire model is searchable. This means it provides a
Locator. This allows to search elements of the wire
model by ObjectID. This model may provide other
locators as well such as the WireLocator.
The wire model's ListModel.iterator() method returns all wires regardless of
the wires' scope (a wire may be public, i. e. applicable for all users, or
private, i. e. applicable for a single user only). If this model contains two
wires visible to one user that only differ in the wire's user (Wire.getUserObjectID())
the portal runtime may choose to only execute the private wire at runtime. To
find out which wires will be executed, i. e. which are the effective
wires, method getEffectiveWires() is provided.
- Since:
- 6.1.0.0
- See Also:
Wire,
WireModelProvider
getEffectiveWires
IterableListModel<T> getEffectiveWires()
- Deprecated. since 6.1.0.1 Support for private wires will be removed in a future
release of WebSphere Portal, use this
WireModel itself instead.
- Finds all wires for effective use. Private wires superpose public wires
if they only differ in the
Wire.getUserObjectID().
- Returns:
- The effective wires.