basiccmirpsystem.idl

UCS (Ultra Corba Simulator) is one more powerful corba client/servant simulator tool than other simi

//File: BasicCMIRPSystem.idl
#ifndef _BASIC_CM_IRP_SYSTEM_IDL_
#define _BASIC_CM_IRP_SYSTEM_IDL_

#include <ManagedGenericIRPConstDefs.idl>
#include <ManagedGenericIRPSystem.idl>
#include <BasicCMIRPConstDefs.idl>

// This statement must appear after all include statements
#pragma prefix "3gppsa5.org"

module BasicCmIRPSystem
{
   exception IllegalFilterFormatException {
      string reason;
   };
   exception IllegalDNFormatException {
      string reason;
   };
   exception IllegalScopeTypeException {
      string reason;
   };
   exception IllegalScopeLevelException {
      string reason;
   };
   exception UndefinedMOException {
      string reason;
   };

   exception UndefinedScopeException {
      string reason;
   };

   exception FilterComplexityLimit {
      string reason;
   };

   exception DuplicateMO {};

   exception CreateNotAllowed {};

   exception ObjectClassMismatch {};

   exception NoSuchObjectClass {
      BasicCMIRPConstDefs::MOClass objectClass;
   };

   exception ParentObjectDoesNotExist {};

   /**
    * System otherwise fails to complete the operation. System can provide
    * reason to qualify the exception. The semantics carried in reason
    * is outside the scope of this IRP.
    */
   exception NextBasicCmInformations { string reason; };
   exception NextDeleteErrors { string reason; };
   exception NextModifyErrors { string reason; };
   exception DestroyException { string reason; };
   exception GetBasicCmIRPVersion { string reason; };
   exception GetBasicCmIRPOperationProfile { string reason; };
   exception GetBasicCmIRPNotificationProfile { string reason; };
   exception FindManagedObjects { string reason; };
   exception CreateManagedObject { string reason; };
   exception DeleteManagedObjects { string reason; };
   exception ModifyManagedObjects { string reason; };

   /**
   The BasicCmInformationIterator is used to iterate through a snapshot of
   Managed Object Information when IRPManager invokes find_managed_objects.
   IRPManager uses it to pace the return of Managed Object Information.

   IRPAgent controls the life-cycle of the iterator. However, a destroy
   operation is provided to handle the case where IRPManager wants to stop
   the iteration procedure before reaching the last iteration.
   */
   interface BasicCmInformationIterator
   {
      /**
      This method returns between 1 and "how_many" Managed Object information.
      The IRPAgent may return less than "how_many" items even if there are
      more items to return. "how_many" must be non-zero. Return TRUE if there
      may be more Managed Object information to return. Return FALSE if there
      are no more Managed Object information to be returned.

      If FALSE is returned, the IRPAgent will automatically destroy the
      iterator.

      @parm how_many how many elements to return in the "fetched_elements" out
       parameter.
      @parm fetched_elements the elements.
      @returns A boolean indicating if any elements are returned.
       "fetched_elements" is empty when the BasicCmInformationIterator is
       empty.
      */

      boolean next_basic_cm_informations (
         in unsigned short how_many,
         out BasicCMIRPConstDefs::ResultSet fetched_elements
      )
      raises (
         NextBasicCmInformations,
         ManagedGenericIRPSystem::InvalidParameter,
         ManagedGenericIRPSystem::OperationNotSupported);

      /**
      This method destroys the iterator.
      */
      void destroy ()
      raises (
         DestroyException,
         ManagedGenericIRPSystem::OperationNotSupported);

   }; // end of BasicCmInformationIterator

   /**
   The DeleteResultIterator is used to iterate through the list of deleted MOs
   when IRPManager invokes method "delete_managed_objects".
   IRPManager uses it to pace the return of Managed Object Information.

   IRPAgent controls the life-cycle of the iterator. However, a destroy
   operation is provided to handle the case where IRPManager wants to stop
   the iteration procedure before reaching the last iteration.
   */
   interface DeleteResultIterator : BasicCmInformationIterator
   {
      /**
      Inherited method "next_basic_cm_informations" has the same behaviour as
      for interface BasicCmInformationIterator, except that:
      - The Managed Object information returned in parameter
        "fetched_elements" contains only the DNs of the deleted MOs
        (no attributes are returned).
      - If FALSE is returned, the IRPAgent will not automatically destroy the
        iterator.
      */

      /**
      This method returns between 0 and "how_many" deletion errors. The
      IRPAgent may return less than "how_many" items even if there are more
      items to return. "how_many" must be non-zero. Return TRUE if there are
      more deletion errors to return. Return FALSE if there are no more
      deletion errors to be returned.

      If FALSE is returned and last call to inherited method
      "next_basic_cm_informations" also returned FALSE (i.e. no more Managed
      Object information to be returned), the IRPAgent will automatically
      destroy the iterator.

      @parm how_many: how many deletion errors to return in the
       "fetched_delete_errors" out parameter.
      @parm fetched_delete_errors: the deletion errors.
      @returns: a boolean indicating if any deletion errors are returned.
      */

      boolean next_delete_errors (
         in unsigned short how_many,
         out BasicCMIRPConstDefs::DeleteErrorSeq fetched_delete_errors
      )
      raises (
         NextDeleteErrors,
         ManagedGenericIRPSystem::InvalidParameter);

   }; // end of DeleteResultIterator

   /**
   The ModifyResultIterator is used to iterate through the list of modified
   MOs when IRPManager invokes method "modify_managed_objects".
   IRPManager uses it to pace the return of Managed Object Information.

   IRPAgent controls the life-cycle of the iterator. However, a destroy
   operation is provided to handle the case where IRPManager wants to stop
   the iteration procedure before reaching the last iteration.
   */
   interface ModifyResultIterator : BasicCmInformationIterator
   {
      /**
      Inherited method "next_basic_cm_informations" has the same behaviour as
      for interface BasicCmInformationIterator, except that:
      - The Managed Object information returned in parameter
        "fetched_elements" contains DNs and attributes of the modified MOs.
      - If FALSE is returned, the IRPAgent will not automatically destroy the
        iterator.
      */

      /**
      This method returns between 0 and "how_many" modification errors. The
      IRPAgent may return less than "how_many" items even if there are more
      items to return. "how_many" must be non-zero. Return TRUE if there are
      more modification errors to return. Return FALSE if there are no more
      modification errors to be returned.

      If FALSE is returned and last call to inherited method
      "next_basic_cm_informations" also returned FALSE (i.e. no more Managed
      Object information to be returned), the IRPAgent will automatically
      destroy the iterator.

      @parm how_many: how many modification errors to return in the
       "fetched_modify_errors" out parameter.
      @parm fetched_modify_errors: the modification errors.
      @returns: a boolean indicating if any modification errors are returned.
      */

      boolean next_modification_errors (
         in unsigned short how_many,
         out BasicCMIRPConstDefs::ModifyAttributeErrorsSeq
            fetched_modify_errors
      )
      raises (
         NextModifyErrors,
         ManagedGenericIRPSystem::InvalidParameter);

   }; // end of ModifyResultIterator

   /**
     * The BasicCmIrpOperations interface.
     * Supports a number of Resource Model versions.
     */
   interface BasicCmIrpOperations
   {
      /**
       * Get the version(s) of the interface
       *
       * @raises GetBasicCmIRPVersion when the system for some reason
       *   can not return the supported versions.
       * @returns all supported versions.
       */
      ManagedGenericIRPConstDefs::VersionNumberSet get_basic_cm_irp_version()
         raises (GetBasicCmIRPVersion);

      /**
       * Return the operation profile for a specific Basic CM IRP version.
       *
       * @raises GetBasicCmIRPOperationProfile when the system for some reason
       *   cannot return the supported operations and parameters.
       * @returns the list of all supported operations and their supported
       *   parameters for the specified version.
       */
      ManagedGenericIRPConstDefs::MethodList get_basic_cm_irp_operation_profile