ComponentContext Class Reference

#include <ComponentContext.h>

List of all members.

Public Member Functions

virtual std::string getURI () const =0
virtual ServiceProxyPtr getService (const std::string &referenceName) const =0
virtual std::vector
< ServiceProxyPtr
getServices (const std::string &referenceName) const =0
virtual ServiceReferencePtr getServiceReference (const std::string &referenceName) const =0
virtual std::vector
< ServiceReferencePtr
getServiceReferences (const std::string &referenceName) const =0
virtual commonj::sdo::DataObjectPtr getProperties () const =0
virtual
commonj::sdo::DataFactoryPtr 
getDataFactory () const =0
virtual ServiceReferencePtr getSelfReference () const =0
virtual ServiceReferencePtr getSelfReference (const std::string &serviceName) const =0

Static Public Member Functions

static ComponentContextPtr getCurrent ()

Detailed Description

Defines the ComponentContext interface


Member Function Documentation

static ComponentContextPtr getCurrent (  )  [static]

Return a ComponentContext object for the current component.

Returns:
ComponentContext for the current component.
virtual commonj::sdo::DataFactoryPtr getDataFactory (  )  const [pure virtual]

Used to get its an SDO DataFactory which can be used to create DataObjects for complex data types used by this component.

Returns:
An SDO DataFactory which has definitions for all complex data types used by a component
virtual commonj::sdo::DataObjectPtr getProperties (  )  const [pure virtual]

Used to get a component's configured property values.

Returns:
An SDO from which all the properties defined in the componentType file can be retrieved.
virtual ServiceReferencePtr getSelfReference ( const std::string &  serviceName  )  const [pure virtual]

Used to get a ServiceReference for a specific service for use with some callback APIs.

Parameters:
serviceName Name of the Service to get a ServiceReference for.
Returns:
A ServiceReference for the named service provided by this component.
virtual ServiceReferencePtr getSelfReference (  )  const [pure virtual]

Used to get a ServiceReference for use with some callback APIs.

Returns:
A ServiceReference for the service provided by this component
Exceptions:
MultipleServicesException if the component implements more than one Service
virtual ServiceProxyPtr getService ( const std::string &  referenceName  )  const [pure virtual]

Used to get a service proxy implementing the interface defined for a Reference.

Parameters:
referenceName Name of the Reference to get an interface object for
Returns:
Pointer to a ServiceProxy implementing the interface of the Reference. This will be NULL if referenceName is not defined for the component.
Exceptions:
MultipleServicesException if the reference resolves to more than one service.
virtual ServiceReferencePtr getServiceReference ( const std::string &  referenceName  )  const [pure virtual]

Used to get a ServiceReference for a Reference.

Parameters:
referenceName Name of the Reference to get an interface object for
Returns:
ServiceReference for the Reference. This will be NULL if referenceName is not defined for the component.
Exceptions:
MultipleServicesException if the reference resolves to more than one service
virtual std::vector<ServiceReferencePtr> getServiceReferences ( const std::string &  referenceName  )  const [pure virtual]

Used to to get a vector of ServiceReferences for a Reference.

Parameters:
referenceName Name of the Reference to get an interface object for
Returns:
vector of ServiceReferences for the Reference. This vector will be empty if referenceName is not defined for the component.
virtual std::vector<ServiceProxyPtr> getServices ( const std::string &  referenceName  )  const [pure virtual]

Used to get a vector of service proxies implementing the interface defined for a Reference.

Parameters:
referenceName Name of the Reference to get an interface object for
Returns:
vector of pointers to ServiceProxy objects implementing the interface of the Reference. This vector will be empty if referenceName is not defined for the component.
virtual std::string getURI (  )  const [pure virtual]

Returns the structural URI for this component

Returns:
Structural URI for the current component.

The documentation for this class was generated from the following file:

Service Component Architecture (SCA) Version 1.1 C++ API, CD05 March 2010  doxygen