OpenCOM
Interface IReceptacle

All Known Implementing Classes:

OCM_MultiReceptacle, OCM_MultiReceptacleContext, OCM_MultiReceptacleParallel, OCM_SingleReceptacle

public interface IReceptacle

Interface implemented only by receptacles. Provides operations to manipulate the receptacles themselves. That is, connect and disconnect them, add meta-data to them and so on...

Method Summary

boolean	connectToRecp(IUnknown pIUnkSink, java.lang.String riid, long provConID) This method connects the recpetacle to given component on the given interface type.
boolean	disconnectFromRecp(long connID) This method disconnects a given receptacle
TypedAttribute	getValue(java.lang.String Name) This method retrieves the value of a name attribute from the receptacle.
java.util.Hashtable	getValues() This method retrieves all the meta-data stored on the receptacle.
boolean	putData(java.lang.String Name, java.lang.String Type, java.lang.Object Value) This method attaches a name-value pair element of meta-data to the receptacle

Method Detail

connectToRecp

boolean connectToRecp(IUnknown pIUnkSink,
                      java.lang.String riid,
                      long provConID)

This method connects the recpetacle to given component on the given interface type.

Parameters:

pIUnkSink - Reference to the sink component who hosts the interface that the receptacle is to be connected to.

riid - A string representing the interface type of the connection.

Returns:

A boolean indicating the success of this operation

disconnectFromRecp

boolean disconnectFromRecp(long connID)

This method disconnects a given receptacle

Returns:

A boolean indicating the success of this operation

putData

boolean putData(java.lang.String Name,
                java.lang.String Type,
                java.lang.Object Value)

This method attaches a name-value pair element of meta-data to the receptacle

Parameters:

Name - A String describing the attribute name.

Type - A String describing the attribute name.

Value - An object representing the attribute value.

Returns:

A boolean indicating the success of this operation

getValue

TypedAttribute getValue(java.lang.String Name)

This method retrieves the value of a name attribute from the receptacle.

Parameters:

Name - A String describing the attribute name.

Returns:

A TypedAttribute object containing the value of the meta-data attribute.

getValues

java.util.Hashtable getValues()

This method retrieves all the meta-data stored on the receptacle.

Returns:

A hashatable containing all of the attribute-value pairs for the receptacle.