cpp/include/qmf/ConsoleObject.h

#ifndef _QmfConsoleObject_
#define _QmfConsoleObject_

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

#include "qmf/QmfImportExport.h"

namespace qmf {

    class ConsoleObjectImpl;
    class SchemaObjectClass;
    class ObjectId;
    class Value;

    /**
     * ConsoleObject is an extension of Object with console-specific methods added.
     *
     * \ingroup qmfapi
     */
    class ConsoleObject : public Object {
    public:
        /**
         * Create a new Object of a specific type.
         *
         * @param type Pointer to the schema class to use as a type for this object.
         */
        QMF_EXTERN ConsoleObject(const SchemaObjectClass* type);

        /**
         * Destroy the object.
         */
        QMF_EXTERN virtual ~ConsoleObject();

        /**
         *
         */
        QMF_EXTERN const SchemaObjectClass* getSchema() const;

        /**
         *
         */
        QMF_EXTERN ObjectId* getObjectId() const;

        /**
         *
         */
        QMF_EXTERN uint64_t getCurrentTime() const;
        QMF_EXTERN uint64_t getCreateTime() const;
        QMF_EXTERN uint64_t getDeleteTime() const;

        /**
         *
         */
        QMF_EXTERN bool isDeleted() const;

        /**
         *
         */
        QMF_EXTERN void update();

        /**
         *
         */
        QMF_EXTERN void invokeMethod(const char* name, const Value* arguments, MethodResult& result);

        /**
         *
         */
        QMF_EXTERN uint32_t invokeMethodAsync(const char* name, const Value* arguments = 0);

    private:
        ConsoleObjectImpl* impl;
    };

}

#endif