All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.beans.dip.Dippable

public interface interface Dippable
extends MergeCustomizable
This interface describes a dippable bean. Dippable beans can have dips applied to them.


Method Index

 o addDip(Dip)
Adds a dip to this bean.
 o dippedIn(String)
Determines whether the dip is applied to this bean.
 o dips()
Gets an array of the type names of all the dips that were applied to this bean.
 o getDipInfo(String)
Gets information about a dip applied to the dippable class.
 o getMethodNames()
Returns the array of method names in this bean.
 o getOutputStream()
Returns the OutputStream property.
 o getThrowVetoException()
Returns the throwVetoException property.
 o removeDip(String)
Removes a dip from this bean.
 o setOutputStream(OutputStream)
Sets the OutputStream property.
 o setThrowVetoException(boolean)
Sets the throwVetoException property.

Methods

 o dips
 public abstract String[] dips()
Gets an array of the type names of all the dips that were applied to this bean.

Returns:
An array of dip type names.
 o addDip
 public abstract boolean addDip(Dip newDip)
Adds a dip to this bean.

Parameters:
newDip - The dip to be added to the bean.
Returns:
true if the dip was added; false otherwise.
 o removeDip
 public abstract boolean removeDip(String dipTypeName)
Removes a dip from this bean.

Parameters:
dipTypeName - The type name of the dip to be removed.
Returns:
true if the dip was removed; false otherwise.
 o dippedIn
 public abstract boolean dippedIn(String dipTypeName)
Determines whether the dip is applied to this bean.

Parameters:
dipTypeName - The type name of the dip.
Returns:
true if the dip is applied to this bean; false otherwise.
 o getDipInfo
 public abstract DipInfo getDipInfo(String dipTypeName)
Gets information about a dip applied to the dippable class.

Parameters:
dipTypeName - The type name of the dip.
Returns:
null if no dip corresponding to the dipTypeName has been applied to the dippable class; otherwise this method returns a DipInfo object describing the dip.
 o getMethodNames
 public abstract String[][] getMethodNames()
Returns the array of method names in this bean. The first dimension corresponds to the different types of methods: property, event, or general. The second dimension corresponds to the methods from the dippable bean.

Returns:
A two-dimensional array of method names.
 o setOutputStream
 public abstract void setOutputStream(OutputStream os)
Sets the OutputStream property. This property is used by the dippable class when a method is vetoed. If the OutputStream property is set, then the stack trace indicating who vetoed the method call is printed to this OutputStream property.

Parameters:
os - The new setting of the OutputStream property.
 o getOutputStream
 public abstract OutputStream getOutputStream()
Returns the OutputStream property. This property is used by the dippable class when a method is vetoed. If the OutputStream property is set, then the stack trace indicating who vetoed the method call is printed to this OutputStream property.

Returns:
The OutputStream property.
 o setThrowVetoException
 public abstract void setThrowVetoException(boolean tve)
Sets the throwVetoException property. This property is used by the dippable class when a method is vetoed. If the throwVetoException flag is set, then a com.ibm.beans.dip.VetoRuntimeException is thrown.

Parameters:
tve - true means exception should be thrown; false means exception should NOT be thrown.
 o getThrowVetoException
 public abstract boolean getThrowVetoException()
Returns the throwVetoException property. This property is used by the dippable class when a method is vetoed. If the throwVetoException flag is set, then a com.ibm.beans.dip.VetoRuntimeException is thrown.

Returns:
true if exception should be thrown; false otherwise.

All Packages  Class Hierarchy  This Package  Previous  Next  Index