operationcontext.h

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

    : virtual public OperationContext::Container
{
public:

    /**
        The unique name for this container type.
    */
    static const String NAME;
      
    /**
        Constructs a TimeoutContainer object from the specified Container.
        @param container The Container object to copy.
        @exception DynamicCastFailedException If the specified Container
        object is not a TimeoutContainer object.
    */
    TimeoutContainer(const OperationContext::Container& container);

    /**
        Constructs a TimeoutContainer with the specified timeout value.
        @param timeout An integer timeout value (in milliseconds).
    */
    TimeoutContainer(Uint32 timeout);

    /**
        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 TimeoutContainer 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 TimeoutContainer object that was created by the clone()
        method.
    */
    virtual void destroy();
      
    /**
        Gets the timeout value from the TimeoutContainer.
        @return An integer timeout value (in milliseconds).
    */
    Uint32 getTimeOut() const;

protected:
    Uint32 _value;

private:
    TimeoutContainer();
};


#ifdef PEGASUS_USE_EXPERIMENTAL_INTERFACES

class AcceptLanguageListContainerRep;

/** <I><B>Experimental Interface</B></I><BR>
    An AcceptLanguageListContainer object holds a list of languages that
    are acceptable in the response for a given operation.
*/
class PEGASUS_COMMON_LINKAGE AcceptLanguageListContainer
    : virtual public OperationContext::Container
{
public:
    /**
        The unique name for this container type.
    */
    static const String NAME;

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

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

    /**
        Constructs an AcceptLanguageListContainer with the specified
        accept language list.
        @param languages An AcceptLanguageList with the response languages
        that are acceptable in this context.
    */
    AcceptLanguageListContainer(const AcceptLanguageList& languages);
    
    /**
        Destructs the AcceptLanguageListContainer.
    */
    virtual ~AcceptLanguageListContainer();

    /**
        Assigns the value of the specified AcceptLanguageListContainer
        object to this object.
        @param container The AcceptLanguageListContainer object to copy.
    */
    AcceptLanguageListContainer& operator=(
        const AcceptLanguageListContainer& 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 AcceptLanguageListContainer 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 an AcceptLanguageListContainer object that was created by
        the clone() method.
    */
    virtual void destroy();

    /**
        Gets the list of acceptable response languages from the
        AcceptLanguageListContainer.
        @return An AcceptLanguageList with the response languages that are
        acceptable in this context.
    */
    AcceptLanguageList getLanguages() const;

protected:
    AcceptLanguageListContainerRep* _rep;

private:
    AcceptLanguageListContainer();    // Unimplemented
};


class ContentLanguageListContainerRep;

/** <I><B>Experimental Interface</B></I><BR>
    A ContentLanguageListContainer object holds a list of languages that
    are contained in the associated data.
*/
class PEGASUS_COMMON_LINKAGE ContentLanguageListContainer
    : virtual public OperationContext::Container
{
public:

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

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

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

    /**
        Constructs a ContentLanguageListContainer with the specified
        content language list.
        @param languages A ContentLanguageList with the languages that are
        contained in the associated data.
    */
    ContentLanguageListContainer(const ContentLanguageList& languages);

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

    /**
        Assigns the value of the specified ContentLanguageListContainer
        object to this object.
        @param container The ContentLanguageListContainer object to copy.
    */
    ContentLanguageListContainer& operator=(
        const ContentLanguageListContainer& 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 ContentLanguageListContainer 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 ContentLanguageListContainer object that was created
        by the clone() method.
    */
    virtual void destroy();

    /**
        Gets the list of content languages from the
        ContentLanguageListContainer.
        @return A ContentLanguageList with the languages that are contained
        in the associated data.
    */
    ContentLanguageList getLanguages() const;

protected:
    ContentLanguageListContainerRep* _rep;

private:
    ContentLanguageListContainer();    // Unimplemented
};

#endif  // PEGASUS_USE_EXPERIMENTAL_INTERFACES


class SnmpTrapOidContainerRep;

/**
    An SnmpTrapOidContainer object holds an SNMP trap OID that corresponds
    to the associated data.
*/
class PEGASUS_COMMON_LINKAGE SnmpTrapOidContainer
    : virtual public OperationContext::Container
{
public:

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

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

    /**
        Constructs an SnmpTrapOidContainer with the specified SNMP trap OID.
        @param snmpTrapOid A String containing an SNMP trap OID.
    */
    SnmpTrapOidContainer(const String& snmpTrapOid);

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

    /**
        Assigns the value of the specified SnmpTrapOidContainer
        object to this object.
        @param container The SnmpTrapOidContainer object to copy.
    */
    SnmpTrapOidContainer& operator=(const SnmpTrapOidContainer& 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 SnmpTrapOidContainer 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 an SnmpTrapOidContainer object that was created
        by the clone() method.
    */
    virtual void destroy();

    /**
        Gets the SNMP trap OID from the SnmpTrapOidContainer.
        @return A String with the SNMP trap OID corresponding to the
        associated data.
    */
    String getSnmpTrapOid() const;

protected:
    SnmpTrapOidContainerRep* _rep;

private:
    SnmpTrapOidContainer();    // Unimplemented
};


PEGASUS_NAMESPACE_END

#endif