OpenClovis Logo

clProvOmApi.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2002-2012 OpenClovis Solutions Inc. All Rights Reserved.
3  *
4  * This file is available under a commercial license from the
5  * copyright holder or the GNU General Public License Version 2.0.
6  *
7  * The source code for this program is not published or otherwise
8  * divested of its trade secrets, irrespective of what has been
9  * deposited with the U.S. Copyright office.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * General Public License for more details.
15  *
16  * For more information, see the file COPYING provided with this
17  * material.
18  */
19 /*******************************************************************************
20  * ModuleName : prov
21  * File : clProvOmApi.h
22  *******************************************************************************/
23 
24 /*******************************************************************************
25  * Description :
26  * This header file contains Provision OM class defination.
27  *
28  *
29  *****************************************************************************/
30 
31 #ifndef _CL_PROV_OM_API_H_
32 #define _CL_PROV_OM_API_H_
33 
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37 
38 
39 #include <clCommon.h>
40 #include <clOmObjectManage.h>
41 #include <clOmCommonClassTypes.h>
42 #include <clOmBaseClass.h>
43 #include <clProvApi.h>
44 
57 /******************************** Provision OM Callbacks *************************/
58 /*********************************************************************************/
59 /* clProvValidate */
60 /* clProvUpdate */
61 /* clProvRollback */
62 /* clProvRead */
63 /* */
64 /*********************************************************************************/
68 CL_OM_BEGIN_CLASS(CL_OM_BASE_CLASS,CL_OM_PROV_CLASS)
106 ClRcT(*clProvValidate)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle, ClProvTxnDataT* pProvTxn);
107 
137 ClRcT(*clProvUpdate)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle, ClProvTxnDataT* pProvTxn);
138 
165 ClRcT(*clProvRollback)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle, ClProvTxnDataT* pProvTxn);
166 
194 ClRcT(*clProvRead)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle, ClProvTxnDataT* pProvTxn);
195 
226 void (*clProvObjectStart) (ClCorMOIdPtrT pMoId, ClHandleT txnHandle);
227 
228 
259 void (*clProvObjectEnd) (ClCorMOIdPtrT pMoId, ClHandleT txnHandle);
260 
294 ClRcT(*clProvObjectValidate)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle,
295  ClProvTxnDataT* pProvTxnDataList, ClUint32T txnDataEntries);
296 
327 ClRcT(*clProvObjectUpdate)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle,
328  ClProvTxnDataT* pProvTxnDataList, ClUint32T txnDataEntries);
329 
360 ClRcT(*clProvObjectRollback)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle,
361  ClProvTxnDataT* pProvTxnDataList, ClUint32T txnDataEntries);
362 
391 ClRcT(*clProvObjectRead)(CL_OM_PROV_CLASS* pThis, ClHandleT txnHandle,
392  ClProvTxnDataT* pProvTxnDataList, ClUint32T txnDataEntries);
393 
394 CL_OM_END
395 
396 
400 #ifdef __cplusplus
401 }
402 #endif
403 
404 #endif /* _CL_PROV_OM_API_H_ */
405 
Typical defines found in any software project.
Header file of Provision Library related APIs.
ClUint32T ClRcT
Clovis return code type.
Definition: clCommon.h:168
ClRcT(* clProvRead)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxn)
Get attribute value.
Definition: clProvOmApi.h:194
ClRcT(* clProvRollback)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxn)
Rollback provision attribute change request.
Definition: clProvOmApi.h:165
ClRcT(* clProvObjectRollback)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxnDataList, ClUint32T txnDataEntries)
Group rollback proivision attributes changes.
Definition: clProvOmApi.h:360
ClRcT(* clProvUpdate)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxn)
Update provision attribute change request.
Definition: clProvOmApi.h:137
ClRcT(* clProvObjectValidate)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxnDataList, ClUint32T txnDataEntries)
Group validate proivision attributes change requests.
Definition: clProvOmApi.h:294
void(* clProvObjectEnd)(ClCorMOIdPtrT pMoId, ClHandleT txnHandle)
Object operations end callback function which will be provided by the user.
Definition: clProvOmApi.h:259
ClRcT(* clProvValidate)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxn)
Provision Library base class.
Definition: clProvOmApi.h:106
void(* clProvObjectStart)(ClCorMOIdPtrT pMoId, ClHandleT txnHandle)
Object operations start callback function which will be provided by the user.
Definition: clProvOmApi.h:226
ClRcT(* clProvObjectUpdate)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxnDataList, ClUint32T txnDataEntries)
Group update proivision attributes changes.
Definition: clProvOmApi.h:327
ClRcT(* clProvObjectRead)(CL_OM_PROV_CLASS *pThis, ClHandleT txnHandle, ClProvTxnDataT *pProvTxnDataList, ClUint32T txnDataEntries)
Get all the attributes values.
Definition: clProvOmApi.h:391
The structure ClCorMOId contains MoId of the object, which is the address of the COR object.
Definition: clCorMetaData.h:918
The structure is used to pass the job information while calling the object implementer's callback fun...
Definition: clProvApi.h:75

Generated on Tue Jan 10 10:29:15 PST 2012 for OpenClovis SDK using Doxygen