com.ibm.portal.wire
Interface ModifiableWire

All Superinterfaces:
Identifiable, Modifiable, ModifiableIdentifiable, TimeStamped, Wire

public interface ModifiableWire
extends Wire, ModifiableIdentifiable

An interface representing a modifiable wire instance.

Since:
6.1.0
See Also:
WireModelController

Method Summary
 boolean confirmImmediateSwitch(boolean immediateSwitch)
          Indicates if the immediate switch can be set to the specified value.
 boolean setImmediateSwitch(boolean immediateSwitch)
          Sets the immediate switch flag for this wire.
 
Methods inherited from interface com.ibm.portal.wire.Wire
getSourceEndpointID, getSourcePageID, getSourcePortletWindowID, getTargetEndpointID, getTargetPageID, getTargetPortletWindowID, getUserObjectID, isImmediateSwitch
 
Methods inherited from interface com.ibm.portal.Identifiable
getObjectID
 
Methods inherited from interface com.ibm.portal.TimeStamped
getCreated, getLastModified
 
Methods inherited from interface com.ibm.portal.ModifiableIdentifiable
getModifiableObjectID
 
Methods inherited from interface com.ibm.portal.Identifiable
getObjectID
 

Method Detail

setImmediateSwitch

boolean setImmediateSwitch(boolean immediateSwitch)
                           throws CannotModifyPropertyException
Sets the immediate switch flag for this wire.

Parameters:
immediateSwitch - specifiy if the wire should immediately switch to the target page after the wire has been invoked.
Returns:
the former value of the flag
Throws:
CannotModifyPropertyException - in case the flag cannot be modified

confirmImmediateSwitch

boolean confirmImmediateSwitch(boolean immediateSwitch)
Indicates if the immediate switch can be set to the specified value.

Parameters:
immediateSwitch - specifiy if the wire should immediately switch to the target page after the wire has been invoked.
Returns:
true if the specified value can be set, false otherwise