operationcontext.h

Pegasus is an open-source implementationof the DMTF CIM and WBEM standards. It is designed to be por

private:
    SubscriptionInstanceContainer();    // Unimplemented
};


class SubscriptionFilterConditionContainerRep;

/**
    A SubscriptionFilterConditionContainer object holds the filter condition
    and query language associated with an indication subscription.  The
    filter condition is equivalent to only the "WHERE" clause of a filter
    query.
*/
class PEGASUS_COMMON_LINKAGE SubscriptionFilterConditionContainer
    : virtual public OperationContext::Container
{
public:
    /**
        The unique name for this container type.
    */
    static const String NAME;

    /**
        Constructs a SubscriptionFilterConditionContainer object from the
        specified Container.
        @param container The Container object to copy.
        @exception DynamicCastFailedException If the specified Container
        object is not a SubscriptionFilterConditionContainer object.
    */
    SubscriptionFilterConditionContainer(
        const OperationContext::Container& container);

    /**
        Constructs a copy of the specified
        SubscriptionFilterConditionContainer.
        @param container The SubscriptionFilterConditionContainer object
        to copy.
    */
    SubscriptionFilterConditionContainer(
        const SubscriptionFilterConditionContainer& container);

    /**
        Constructs a SubscriptionFilterConditionContainer with the specified
        filter condition and query language.
        @param filterCondition The query condition String associated with an
        indication subscription filter.
        @param queryLanguage The query language String associated with an
        indication subscription filter.
    */
    SubscriptionFilterConditionContainer(
        const String& filterCondition, 
        const String& queryLanguage);

    /**
        Destructs the SubscriptionFilterConditionContainer.
    */
    virtual ~SubscriptionFilterConditionContainer();

    /**
        Assigns the value of the specified SubscriptionFilterConditionContainer
        object to this object.
        @param container The SubscriptionFilterConditionContainer object to
        copy.
    */
    SubscriptionFilterConditionContainer& operator=(
        const SubscriptionFilterConditionContainer& container);

    /**
        Returns the unique name for this Container type.
        @return The String name of the Container type.
    */
    virtual String getName() const;

    /**
        Makes a copy of this SubscriptionFilterConditionContainer object.
        The caller is responsible for cleaning up the copy by calling
        destroy() method.
        @return A pointer to the new Container object.
    */
    virtual OperationContext::Container* clone() const;

    /**
        Cleans up a SubscriptionFilterConditionContainer object that was
        created by the clone() method.
    */
    virtual void destroy();

    /**
        Gets the filter query condition from the
        SubscriptionFilterConditionContainer.  Note that the filter query
        condition is equivalent to only the "WHERE" clause of a filter query.
        @return The query condition String associated with an indication
        subscription filter.
    */
    String getFilterCondition() const;

    /**
        Gets the query language from the SubscriptionFilterConditionContainer.
        @return The query language String associated with an indication
        subscription filter.
    */
    String getQueryLanguage() const;

protected:
    SubscriptionFilterConditionContainerRep* _rep;

private:
    SubscriptionFilterConditionContainer();    // Unimplemented
};


class SubscriptionFilterQueryContainerRep;

/**
    A SubscriptionFilterQueryContainer object holds the query filter
    and query language associated with an indication subscription, as well
    as the source namespace of the filter.  The query filter contains the
    whole query string ("SELECT" statement) from the subscription filter
    instance.  (This differs from the filter condition string in
    SubscriptionFilterConditionContainer, which only contains the "WHERE"
    clause of the filter.)
*/
class PEGASUS_COMMON_LINKAGE SubscriptionFilterQueryContainer
    : virtual public OperationContext::Container
{
public:
    /**
        The unique name for this container type.
    */
    static const String NAME;

    /**
        Constructs a SubscriptionFilterQueryContainer object from the
        specified Container.
        @param container The Container object to copy.
        @exception DynamicCastFailedException If the specified Container
        object is not a SubscriptionFilterQueryContainer object.
    */
    SubscriptionFilterQueryContainer(
        const OperationContext::Container& container);

    /**
        Constructs a copy of the specified SubscriptionFilterQueryContainer.
        @param container The SubscriptionFilterQueryContainer object to copy.
    */
    SubscriptionFilterQueryContainer(
        const SubscriptionFilterQueryContainer& container);

    /**
        Constructs a SubscriptionFilterQueryContainer with the specified
        filter query, query language, and source namespace.
        @param filterQuery The filter query String associated with an
        indication subscription filter.
        @param queryLanguage The query language String associated with an
        indication subscription filter.
        @param sourceNameSpace The CIMNamespaceName of the source namespace
        associated with an indication subscription filter.
    */
    SubscriptionFilterQueryContainer(
       const String& filterQuery,
       const String& queryLanguage,
       const CIMNamespaceName& sourceNameSpace);

    /**
        Destructs the SubscriptionFilterQueryContainer.
    */
    virtual ~SubscriptionFilterQueryContainer();

    /**
        Assigns the value of the specified SubscriptionFilterQueryContainer
        object to this object.
        @param container The SubscriptionFilterQueryContainer object to copy.
    */
    SubscriptionFilterQueryContainer& operator=(
        const SubscriptionFilterQueryContainer& container);

    /**
        Returns the unique name for this Container type.
        @return The String name of the Container type.
    */
    virtual String getName() const;

    /**
        Makes a copy of this SubscriptionFilterQueryContainer object.
        The caller is responsible for cleaning up the copy by calling
        destroy() method.
        @return A pointer to the new Container object.
    */
    virtual OperationContext::Container* clone() const;

    /**
        Cleans up a SubscriptionFilterQueryContainer object that was
        created by the clone() method.
    */
    virtual void destroy();

    /**
        Gets the filter query from the SubscriptionFilterQueryContainer.
        @return The query String associated with an indication subscription
        filter.
    */
    String getFilterQuery() const;

    /**
        Gets the filter query language from the
        SubscriptionFilterQueryContainer.
        @return The query language String associated with an indication
        subscription filter.
    */
    String getQueryLanguage() const;

    /**
        Gets the source namespace from the SubscriptionFilterQueryContainer.
        @return The source namespace associated with an indication
        subscription filter.
    */
    CIMNamespaceName getSourceNameSpace() const;

protected:
    SubscriptionFilterQueryContainerRep* _rep;

private:
    SubscriptionFilterQueryContainer();    // Unimplemented
};


class SubscriptionInstanceNamesContainerRep;

/**
    A SubscriptionInstanceNamesContainer object holds a list of subscription
    instance names.  This can be used to limit the set of subscriptions that
    are considered targets for an indication when it is generated, which is
    necessary for a provider to generate localized indications or to
    implement a subscription's repeat notification policy.
*/
class PEGASUS_COMMON_LINKAGE SubscriptionInstanceNamesContainer
    : virtual public OperationContext::Container
{
public:

    /**
        The unique name for this container type.
    */
    static const String NAME;

    /**
        Constructs a SubscriptionInstanceNamesContainer object from the
        specified Container.
        @param container The Container object to copy.
        @exception DynamicCastFailedException If the specified Container
        object is not a SubscriptionInstanceNamesContainer object.
    */
    SubscriptionInstanceNamesContainer(
        const OperationContext::Container& container);

    /**
        Constructs a copy of the specified SubscriptionInstanceNamesContainer.
        @param container The SubscriptionInstanceNamesContainer object to copy.
    */
    SubscriptionInstanceNamesContainer(
        const SubscriptionInstanceNamesContainer& container);

    /**
        Constructs a SubscriptionInstanceNamesContainer with the specified
        list of subscription instance names.
        @param subscriptionInstanceNames A CIMObjectPath Array with the names
        of indication subscription instances.
    */
    SubscriptionInstanceNamesContainer(
        const Array<CIMObjectPath>& subscriptionInstanceNames);

    /**
        Destructs the SubscriptionInstanceNamesContainer.
    */
    virtual ~SubscriptionInstanceNamesContainer();

    /**
        Assigns the value of the specified SubscriptionInstanceNamesContainer
        object to this object.
        @param container The SubscriptionInstanceNamesContainer object to copy.
    */
    SubscriptionInstanceNamesContainer& operator=(
        const SubscriptionInstanceNamesContainer& container);

    /**
        Returns the unique name for this Container type.
        @return The String name of the Container type.
    */
    virtual String getName() const;

    /**
        Makes a copy of this SubscriptionInstanceNamesContainer object.
        The caller is responsible for cleaning up the copy by calling
        destroy() method.
        @return A pointer to the new Container object.
    */
    virtual OperationContext::Container* clone() const;

    /**
        Cleans up a SubscriptionInstanceNamesContainer object that was
        created by the clone() method.
    */
    virtual void destroy();

    /**
        Gets the list of subscription instance names from the
        SubscriptionInstanceNamesContainer.
        @return A CIMObjectPath Array of indication subscription instance
        names.
    */
    Array<CIMObjectPath> getInstanceNames() const;

protected:
    SubscriptionInstanceNamesContainerRep* _rep;

private:
    SubscriptionInstanceNamesContainer();    // Unimplemented
};


/**
    A TimeoutContainer object holds an operation timeout value, in
    milliseconds.
*/
class PEGASUS_COMMON_LINKAGE TimeoutContainer