CSTM_Common.idl

CSTM_Common.idl
Module List
Module com

Data Structures and Types

CSTMResultInfo Structure

CSTMUserInfo Structure

Constants

CSTM_Common.idl

Module List

The file CSTM_Common.idl contains the following modules:

com

 
cisco::com

 
nms::cisco

 
cstm_server::nms

 
CSTM_Common::cstm_server

Module com

Data Structures and Types

CSTMResultInfo Structure

The CSTMResultInfo structure is used by IDL calls to return the result of an operation.

Usage

 
struct CSTMResultInfo

{

 
long return_code;

 
string return_str;

};

Members

return_code— 0 = SUCCESS, non-zero = ERROR.

return_str — indicates the error message in the event of non-zero return_code.

CSTMUserInfo Structure

The CSTMUserInfo structure is used by IDL calls to track who invoked the call, who locked it and locking/unlocking the template/datafiles for a given user.

Usage

 
struct CSTMUserInfo

{

 
string userId;

 
string password;

};

Members

userId—this field indicates the username.

password—this field indicates the user password.

Constants

 
const long CSTM_DATAFILE_ALREADY_EXIST = 120006

 
const long CSTM_DATAFILE_DOESNOT_EXIST = 120005

 
const string CSTM_ERR_DATA_VALIDATION = "Data Validation Failed on Datafile:"

 
const string CSTM_ERR_DATAFILE_LOCKED = "Datafile Locked by User: "

 
const string CSTM_ERR_INVALID_DATATYPE = "Type of Data is neither String nor ArrayList:"

 
const string CSTM_ERR_INVALID_TEMPLHJI = "Invalid TemplateHomeJI instance"

 
const string CSTM_ERR_INVALID_TEMPLOBJ = "Invalid Template object for Template:"

 
const string CSTM_ERR_NO_DATNM_IN_XML = "No Datafile Node specified in Request XML"

 
const string CSTM_ERR_NO_DATVAL_IN_XML = "No Datafile Value specified in Request XML"

 
const string CSTM_ERR_NO_DTBLNM_IN_XML = "No DataTable Node specified in Request XML"

 
const string CSTM_ERR_NO_DTBLVAL_IN_XML = "No DataTable Value specified in Request XML"

 
const string CSTM_ERR_NO_FLDNM_IN_XML = "No Folder Node specified in Request XML"

 
const string CSTM_ERR_NO_FLDVAL_IN_XML = "No Folder Value specified in Request XML"

 
const string CSTM_ERR_NO_OPNM_IN_XML = "No Operation Type specified in Request XML"

 
const string CSTM_ERR_NO_OPVAL_IN_XML = "No OpType Value specified in Request XML"

 
const string CSTM_ERR_NO_SRVNM_IN_XML = "No Service Node specified in Request XML"

 
const string CSTM_ERR_NO_SRVVAL_IN_XML = "No Service Value specified in Request XML"

 
const string CSTM_ERR_NO_SUBTEMPLATES = "No associated Sub-Templates"

 
const string CSTM_ERR_NO_TMPNM_IN_XML = "No Template Node specified in Request XML"

 
const string CSTM_ERR_NO_TMPVAL_IN_XML = "No Template Value specified in Request XML"

 
const string CSTM_ERR_PARSING_TEMPLATE = "parseIt() failed for Template:"

 
const string CSTM_ERR_RESPONSE_DATA = "could not generate responseData"

 
const string CSTM_ERR_TEMPLATE_LOCKED = "Template Locked by User: "

 
const long CSTM_FOLDER_DOESNOT_EXIST = 120002

 
const long CSTM_SERVER_INTERNAL_FAILURE = 120001

 
const long CSTM_SERVER_RETURN_CODE_BASE = 120000

 
const long CSTM_SERVER_RETURN_SUCCESS = 0

 
const long CSTM_TEMPLATE_ALREADY_EXIST = 120004

 
const long CSTM_TEMPLATE_DOESNOT_EXIST = 120003

Table of Contents

CSTM_Common.idl

Module List

Module com

Data Structures and Types

CSTMResultInfo Structure

Usage

Members

CSTMUserInfo Structure

Usage

Members

Constants