com.ibm.portal.wire
Interface WireCreationContext

All Superinterfaces:

CreationContext

public interface WireCreationContext
extends CreationContext

A node creation context for Wires.

Since:

6.1.0

Method Summary

Identifiable	getSourceEndpoint() Returns the communication source associated with this wire.
Identifiable	getSourceLayoutControl() Returns the source layout control associated with this wire.
Identifiable	getTargetEndpoint() Returns the communication target associated with this wire.
Identifiable	getTargetLayoutControl() Returns the target layout control associated with this wire.
Identifiable	getTargetPage() Returns the target page associated with this wire.
Identifiable	getUser() Returns the user this wire belongs to.

Method Detail

getTargetPage

Identifiable getTargetPage()

Returns the target page associated with this wire. If null is returned, this implies that an in page wire is to be created. The page represented by the LayoutModelController which provided the WireModelController intended for creating the wire will be used as target page for the wire to be created. For creating a cross page wire, the return value of this method mustnīt be null.

Returns:

The target page Identifiable, or null.

getSourceLayoutControl

Identifiable getSourceLayoutControl()

Returns the source layout control associated with this wire.

Returns:

The source layout control Identifiable, never null.

getTargetLayoutControl

Identifiable getTargetLayoutControl()

Returns the target layout control associated with this wire.

Returns:

The the target layout control Identifiable, never null.

getSourceEndpoint

Identifiable getSourceEndpoint()

Returns the communication source associated with this wire.

Returns:

The source communication end point Identifiable, never null.

getTargetEndpoint

Identifiable getTargetEndpoint()

Returns the communication target associated with this wire.

Returns:

The target communication end point Identifiable, never null.

getUser

Identifiable getUser()

Returns the user this wire belongs to.

Returns:

The user Identifiable, if null this wire is a public.