Unicorn XML Toolkit
Version 1.00.00

Namespace Som
Class COperationDef

class COperationDef: public CInterface {
public:
    COperationDef();
    ~COperationDef();
public:
    void Create(
        const CString &strName,
        int nType,
        CInterfaceDef *pTypeInterface);
    void AddParameter(const XParameterDef &pParameter);
    CString GetName();
    int GetType();
    CInterfaceDef *GetTypeInterface();
    int GetParameterCount();
    XParameterDef GetParameter(int nIndex);
    };

The definition of an operation in a SOM repository.

Since:
1.00.00
Version:
1.00.00
Author:
Alexey Gokhberg
See Also:
CParameterDef, CInterfaceDef
Constructor/Destructor Summary
COperationDef ();
����������Constructs the operation definition.
~COperationDef ();
����������Destroys the operation definition.

Function Summary
void Create (const CString &strName, int nType, CInterfaceDef *pTypeInterface);
����������Creates the operation definition.
void AddParameter (const XParameterDef &pParameter);
����������Adds a definition of an operation parameter.
CString GetName ();
����������Returns a name of the operation.
int GetType ();
����������Returns a type code of the result returned by the operation.
CInterfaceDef�* GetTypeInterface ();
����������Returns an interface corresponding to the operation result type.
int GetParameterCount ();
����������Returns the number of parameters of the operation.
XParameterDef GetParameter (int nIndex);
����������Returns a parameter definition at the specified index.

Constructor/Destructor Detail

COperationDef

COperationDef();

Constructs the operation definition.

~COperationDef

~COperationDef();

Destroys the operation definition.

Function Detail

Create

void Create(
    const CString &strName,
    int nType,
    CInterfaceDef *pTypeInterface);

Creates the operation definition.

Parameters:
strName - the name of the operation
nType - the type code of the result returned by the operation
pTypeInterface - if the result is of type interface ( nType is typeInterface ), points to the appropriate interface definition; otherwise NULL

AddParameter

void AddParameter(const XParameterDef &pParameter);

Adds a definition of an operation parameter.

The operation definition owns the list of parameter definitions. The order of parameter definitions in the list is significant. This function adds a parameter definition to the end of the list.

Parameters:
pParameter - the parameter definition

GetName

CString GetName();

Returns a name of the operation.

Returns:
the name of the operation

GetType

int GetType();

Returns a type code of the result returned by the operation.

Returns:
the type code of the result returned by the operation

GetTypeInterface

CInterfaceDef *GetTypeInterface();

Returns an interface corresponding to the operation result type.

Returns:
the interface corresponding to the operation result type; NULL if the operation result has type code other than typeInterface

GetParameterCount

int GetParameterCount();

Returns the number of parameters of the operation.

Returns:
the number of parameters of the operation

GetParameter

XParameterDef GetParameter(int nIndex);

Returns a parameter definition at the specified index.

Parameters:
nIndex - the index (zero-based)
Returns:
the parameter definition at the specified index

Unicorn XML Toolkit
Version 1.00.00


This document was created using Unicorn DOC++.

Copyright 1999-2001 Unicorn Enterprises SA.
All Rights Reserved.