com.ibm.portal.wire
Interface Wire

All Superinterfaces:

Identifiable, TimeStamped

All Known Subinterfaces:

ModifiableWire

public interface Wire
extends Identifiable, TimeStamped

Describes a connection between a communication source and a communication target that is used to transfer information.

Since:

6.1.0

See Also:

WireModel, com.ibm.portal.wire.WireType

Method Summary

ObjectID	getSourceEndpointID() Returns the ObjectID of the communication source associated with this wire.
ObjectID	getSourcePageID() Returns the source page ObjectID associated with this wire.
ObjectID	getSourcePortletWindowID() Returns the runtime portlet window ID of the root PortletWindow associated with this wire´s source
ObjectID	getTargetEndpointID() Returns the ObjectID of the communication target associated with this wire.
ObjectID	getTargetPageID() Returns the target page ObjectID associated with this wire.
ObjectID	getTargetPortletWindowID() Returns the runtime portlet window ID of the root PortletWindow associated with this wire´s target
ObjectID	getUserObjectID() Returns the object id of the user this wire belongs to.
boolean	isImmediateSwitch() Returns true for crosspage wires that should immediately switch to the target page after the wire has been invoked.

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Method Detail

getUserObjectID

ObjectID getUserObjectID()

Returns the object id of the user this wire belongs to.

Returns:

If this wire is a private one this method will return the ObjectID of this user, null will be returned if this wire is a public wire.

getTargetPageID

ObjectID getTargetPageID()

Returns the target page ObjectID associated with this wire.

Returns:

The ObjectID of the target page.

getSourcePageID

ObjectID getSourcePageID()

Returns the source page ObjectID associated with this wire.

Returns:

The ObjectID of the source page.

getTargetPortletWindowID

ObjectID getTargetPortletWindowID()

Returns the runtime portlet window ID of the root PortletWindow associated with this wire´s target

Returns:

The ObjectID of the target portlet window, never null.

getSourcePortletWindowID

ObjectID getSourcePortletWindowID()

Returns the runtime portlet window ID of the root PortletWindow associated with this wire´s source

Returns:

The ObjectID of the source portlet window, never null.

isImmediateSwitch

boolean isImmediateSwitch()

Returns true for crosspage wires that should immediately switch to the target page after the wire has been invoked. Returns false if the no redirect may take place for this wire invocation.

Returns:

true, if this should switch to the target page immediately.

getTargetEndpointID

ObjectID getTargetEndpointID()

Returns the ObjectID of the communication target associated with this wire.

Returns:

The ObjectID of the CommunicationTarget.

getSourceEndpointID

ObjectID getSourceEndpointID()

Returns the ObjectID of the communication source associated with this wire.

Returns:

The ObjectID of the CommunicationSource.