clCorErrors.h

Go to the documentation of this file.

/*
 * Copyright (C) 2002-2012 OpenClovis Solutions Inc.  All Rights Reserved.
 *
 * This file is available  under  a  commercial  license  from  the
 * copyright  holder or the GNU General Public License Version 2.0.
 * 
 * The source code for  this program is not published  or otherwise 
 * divested of  its trade secrets, irrespective  of  what  has been 
 * deposited with the U.S. Copyright office.
 * 
 * This program is distributed in the  hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied  warranty  of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
 * General Public License for more details.
 * 
 * For more  information, see  the file  COPYING provided with this
 * material.
 */
/*******************************************************************************
 * ModuleName  : cor                                                           
 * File        : clCorErrors.h
 *******************************************************************************/

/*******************************************************************************
 * Description :                                                                
 *
 *  This file contains all the external error Ids for COR.
 *
 *
 *****************************************************************************/

#ifndef _CL_COR_ERRORS_H_
#define _CL_COR_ERRORS_H_

#ifdef __cplusplus
extern "C" {
#endif

/* INCLUDES */
#include <clCommon.h>
#include <clCommonErrors.h>

/* DEFINES */
#define CL_COR_SET_RC(ERR_ID)                   (CL_RC(CL_CID_COR, ERR_ID))

#define CL_COR_ERR_NO_MEM                               CL_ERR_NO_MEMORY

#define CL_COR_ERR_INVALID_PARAM                    CL_ERR_INVALID_PARAMETER

#define CL_COR_ERR_NULL_PTR                             CL_ERR_NULL_POINTER

#define CL_COR_ERR_NOT_EXIST                        CL_ERR_NOT_EXIST

#define CL_COR_ERR_INVALID_HANDLE                   CL_ERR_INVALID_HANDLE

#define CL_COR_ERR_INVALID_BUFFER                   CL_ERR_INVALID_BUFFER

#define CL_COR_ERR_BUFFER_OVERRUN                   CL_ERR_BUFFER_OVERRUN
   
#define CL_COR_ERR_DUPLICATE                        CL_ERR_DUPLICATE

#define CL_COR_ERR_NO_RESOURCE                      CL_ERR_NO_RESOURCE

#define CL_COR_ERR_TIMEOUT                              CL_ERR_TIMEOUT

#define CL_COR_ERR_TRY_AGAIN                    CL_ERR_TRY_AGAIN

#define CL_COR_ERR_INVALID_CLASS                        0x100   

#define CL_COR_ERR_INVALID_STATE                        0x101   

#define CL_COR_ERR_INVALID_MSP_ID                       0x102   

#define CL_COR_ERR_MAX_DEPTH                        0x103               

#define CL_COR_ERR_INVALID_DEPTH                        0x104   

#define CL_COR_ERR_CLASS_PRESENT                        0x105   

#define CL_COR_ERR_CLASS_NOT_PRESENT            0x106   

#define CL_COR_ERR_CLASS_INSTANCES_PRESENT          0x107       

#define CL_COR_ERR_CLASS_ATTR_INVALID_VAL           0x108       

#define CL_COR_ERR_CLASS_ATTR_PRESENT           0x109           

#define CL_COR_ERR_OBJECT_LOCKED                        0x10a                   

#define CL_COR_ERR_OBJECT_INVALID                       0x10b                   

#define CL_COR_ERR_CLASS_ATTR_NOT_PRESENT           0x10c       

#define CL_COR_ERR_CLASS_ATTR_TILL_REACHED          0x10d

#define CL_COR_ERR_CLASS_ATTR_OUT_OF_RANGE          0x10e       

#define CL_COR_ERR_CLASS_ATTR_INVALID_INDEX         0x10f               

#define CL_COR_ERR_CLASS_ATTR_INVALID_RELATION  0x110   

#define CL_COR_ERR_OBJ_ATTR_INVALID_SET         0x111           

#define CL_COR_ERR_CLASS_INVALID_PATH           0x112           

#define CL_COR_ERR_OBJECT_ACTIVE                0x113                   

#define CL_COR_ERR_ROUTE_PRESENT                0x114                   

#define CL_COR_ERR_UNKNOWN_COR_INSTANCE         0x115   

#define CL_COR_ERR_INSUFFICIENT_BUFFER          0x116           

#define CL_COR_ERR_CLASS_MISMATCH               0x117                   

#define CL_COR_ERR_CLASS_ATTR_INVALID_TYPE      0x118   

#define CL_COR_ERR_ROUTE_NOT_PRESENT            0x119           

#define CL_COR_ERR_NOT_SUPPORTED                        0x11a           

#define CL_COR_ERR_INVALID_OH_MASK                      0x11b           

#define CL_COR_ERR_ALREADY_INIT                     0x11c                       

#define CL_COR_ERR_CLASS_ATTR_NOT_INITIALIZED   0x11d                   

#define CL_COR_ERR_OBJ_ATTR_NOT_PRESENT         0x11e           

#define CL_COR_ERR_CLASS_IS_BASE                0x11f                           

#define CL_COR_ERR_OBJ_NOT_PRESENT              0x120                   

#define CL_COR_ERR_INVALID_SIZE                 0x121                   

#define CL_COR_ERR_VERSION_UNSUPPORTED          0x122                   



/* MO_TREE-specific error IDs, follows base COR base error IDs and starts at 0x130 */

#define CL_COR_MO_TREE_ERR_FAILED_TO_ADD_NODE       0x130       

#define CL_COR_MO_TREE_ERR_FAILED_TO_DEL_NODE       0x131       

#define CL_COR_MO_TREE_ERR_FAILED_USR_BUF           0x132               

#define CL_COR_MO_TREE_ERR_CLASS_NO_PRESENT         0x133               

#define CL_COR_MO_TREE_ERR_NODE_NOT_FOUND           0x134               

#define CL_COR_MO_TREE_ERR_NODE_FOUND               0x135                       

#define CL_COR_MO_TREE_ERR_MAX_INST                 0x136   

#define CL_COR_MO_TREE_ERR_CHILD_CLASS_EXIST        0x137               


/* INSTANCE-specific error IDs, follows MO_TREE error IDs ans start at 0x140 */

#define CL_COR_INST_ERR_NODE_NOT_FOUND              0x140               

#define CL_COR_INST_ERR_MSO_ALREADY_PRESENT         0x141       

#define CL_COR_INST_ERR_MO_ALREADY_PRESENT          0x142       

#define CL_COR_INST_ERR_MSO_NOT_PRESENT             0x143               

#define CL_COR_INST_ERR_INVALID_MOID                0x144               

#define CL_COR_INST_ERR_UNPACK_FAILED               0x145               

#define CL_COR_INST_ERR_NODE_ALREADY_PRESENT        0x146       

#define CL_COR_INST_ERR_NODE_NOT_TO_PACK                    0x147               

#define CL_COR_INST_ERR_CHILD_MO_EXIST                  0x148                   

#define CL_COR_INST_ERR_MSO_EXIST                               0x149                   

#define CL_COR_INST_ERR_MAX_INSTANCE                    0x14a                   

#define CL_COR_INST_ERR_PARENT_MO_NOT_EXIST                 0x14b



/* TXN-specific error IDs, follows INST error IDs and starts at 0x150 */

#define CL_COR_TXN_ERR_OUT_OF_TXN                   0x150

#define CL_COR_TXN_ERR_INVALID_ID                   0x151

#define CL_COR_TXN_ERR_INVALID_STATE                0x152

#define CL_COR_TXN_ERR_SPANS_MULTI_OBJ              0x153

#define CL_COR_TXN_ERR_INVALID_OP                   0x154               

#define CL_COR_TXN_ERR_FIRST_JOB                    0x155               

#define CL_COR_TXN_ERR_LAST_JOB                     0x156               

#define CL_COR_TXN_ERR_ZERO_JOBS                    0x157               

#define CL_COR_TXN_ERR_INVALID_JOB_ID               0x158               

#define CL_COR_TXN_ERR_FAILED_JOB_GET               0x159               

#define CL_COR_TXN_ERR_FAILED_JOB_NOT_EXIST         0x15a               

#define CL_COR_ERR_RUNTIME_CACHED_SET               0x15b

#define CL_COR_ERR_ATTR_NON_WRITABLE_SET            0x15c

#define CL_COR_TXN_ERR_JOB_WALK_TERMINATE           0x15d


/* Notify-specific error IDs, follows TXN error IDs and starts at 0x160 */

#define CL_COR_NOTIFY_ERR_INVALID_OP                0x160                       

#define CL_COR_NOTIFY_ERR_CANNOT_RESOLVE_CLASS      0x161       


/* Managed Services error IDs, follows Notify error IDs and starts at 0x170 */

#define CL_COR_SVC_ERR_INVALID_FLAGS                0x170       

#define CL_COR_SVC_ERR_INVALID_ID                   0x171               

#define CL_COR_INTERNAL_ERR_INVALID_COR_LIST        0x172               

#define CL_COR_INTERNAL_ERR_INVALID_RM_FLAGS        0x173               


/* COR Utils error IDs, follows SVC error IDs and starts at 0x180 */

#define CL_COR_UTILS_ERR_INVALID_KEY                0x180                       

#define CL_COR_UTILS_ERR_MEMBER_NOT_FOUND           0x181       

#define CL_COR_UTILS_ERR_INVALID_NODE_REF           0x182               

#define CL_COR_UTILS_ERR_INVALID_TAG                0x183                       

#define CL_COR_UTILS_ERR_FOUND_END_TAG              0x184               

#define CL_COR_UTILS_ERR_MOCLASSPATH_MISMATCH       0x185       



/* COR Initialization related error IDs. It starts from 0x190 onwards*/

#define CL_COR_ERR_CONFIG_ATTR_FLAG                 0x190

#define CL_COR_ERR_RUNTIME_ATTR_WRITE               0x191

#define CL_COR_ERR_ATTR_PERS_WITHOUT_CACHE          0x192

#define CL_COR_ERR_ATTR_FLAGS_INVALID               0x193

#define CL_COR_ERR_OP_ATTR_TYPE_INVALID             0x194


/* COR Session related error IDs, start from 0x1a0 onwards*/

#define CL_COR_ERR_GET_DATA_NOT_FOUND               0x1a0

#define CL_COR_ERR_BUNDLE_INIT_FAILURE              0x1a1

#define CL_COR_ERR_BUNDLE_APPLY_FAILURE             0x1a2

#define CL_COR_ERR_ZERO_JOBS_BUNDLE                 0x1a3    

#define CL_COR_ERR_ATTR_READ_ONLY                   0x1a4

#define CL_COR_ERR_BUNDLE_FINALIZE                  0x1a5

#define CL_COR_ERR_BUNDLE_TIMED_OUT                 0x1a6

#define CL_COR_ERR_BUNDLE_IN_EXECUTION              0x1a7

#define CL_COR_ERR_BUNDLE_INVALID_TYPE              0x1a8



/* COR OI registration related error IDS. It starts from 0x1c0 onwards. */

/* OI list related errors :
1. OI is not registered. 
2. A read OI is already registered for this MO. 
*/

#define CL_COR_ERR_OI_NOT_REGISTERED                0x1c0

#define CL_COR_ERR_OI_ALREADY_REGISTERED            0x1c1

/* COR COMM error IDs, follows Session error IDs and starts at 0x1d0 */


#define CL_COR_COMM_ERR_INVALID_OP                  0x1d0      



/* COR CLI error IDs, follows comm error Ids and starts from 0x1e0 */

#define CL_COR_CLI_ERR_INVALID_USAGE                0x1e0



/* Error string declarations */

#define CL_COR_ERR_STR_MEM_ALLOC_FAIL           "Memory allocation failed!"

#define CL_COR_ERR_STR_MAX_DEPTH                "Max depth already used!"

#define CL_COR_ERR_STR_INVALID_DEPTH            "Invalid depth"

#define CL_COR_ERR_INVALID_PARAM_STR            "Invalid parameter passed"

#define CL_COR_ERR_NULL_PTR_STR                 "NULL value passed"

#define CL_COR_ERR_NO_MEM_STR                   "Out of memory!"

#define CL_COR_ERR_INSUFFICIENT_BUFFER_STR      "Insufficient buffer passed!"

#define CL_COR_ERR_INVALID_BUFFER_STR           "Invalid buffer"

#define CL_COR_UTILS_ERR_INVALID_NODE_REF_STR  "Invalid Node"

#define CL_COR_MO_TREE_ERR_NODE_FOUND_STR       "Node already found"
 
#define CL_COR_MO_TREE_ERR_NODE_NOT_FOUND_STR   "Unknown node referenced"

#define CL_COR_INST_ERR_NODE_NOT_FOUND_STR      "Unknown Instance node referred"

#define CL_COR_INST_ERR_MO_ALREADY_PRESENT_STR  "MO Object already present"

#define CL_COR_ERR_STR(ERR)               ERR##_STR


#ifdef __cplusplus
}

#endif

#endif  /*       _CL_COR_ERRORS_H_ */