anclist.idl

Go to the documentation of this file.

// OSB library ************************************************ -*- IDL -*-
/*
  AUTHOR(S): Darryl Kang (dk)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.28.2.1 $

  License
   OSB rating and billing library for communication networks
   Copyright (C) 2004, 2005, 2006  OSB systems

   This file may be distributed and/or modify under the terms of the
   GNU General Public License (GPL) as published by the Free Software
   Foundation which is provided in the file LICENSE.GPL included in the
   packaging of this file.

   The file 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.

   Holders of a OSB Commercial License may use this file under the terms
   and conditions of this commercial license.
 */

#ifndef ANCLIST_IDL
#define ANCLIST_IDL
// ************************************************************************
#include "associate.idl"
#include "exception.idl"

module corba {
  module cadmin {
    struct AnCFilter {
        AssociateId        asId_;
        common::Utf8String asName_;
        ContractId         coId_;
        unsigned long      maxRows_;
        boolean            moreRows_;
    };                                  // struct AnCFilter

    interface AnCList {
        long search(
            inout AnCFilter filter
        ) raises (common::OsbCorbaException);

        readonly attribute long numAssoc;
        readonly attribute long numContract;

        void refresh(
            in boolean noWait
        ) raises (common::OsbCorbaException);

        /* !
          @brief Replace associate with a new copy from database.

          This function replaces the associate in the list with a
          fresh copy of associate by reading from the database.

          @param  id     The unique id of associate
          @param  noWait Don't wait for database locks?
          @throw  OsbCorbaException if fetching at gateway fails.
          @return An associate writer if successful.
         */
/*
 *      cadmin::assoc::AssociateWriter refreshAssociate(
 *          in cadmin::AssociateId id,
 *          in boolean noWait
 *      ) raises (common::OsbCorbaException);
 */

        /* !
          @brief Replace a contract with a new copy from database.

          This function reads a fresh copy of the same contract from
          the database and replaces the contract in the list.

          @param id Unique id of contract.
          @param noWait Don't wait for database locks?
          @throw OsbCorbaException if operation at gateway fails.
          @return Contract writer.
         */
/*
 *      cadmin::contract::ContractWriter refreshContract(
 *          in cadmin::contract::ContractId id,
 *          in boolean                      noWait
 *      ) raises (common::OsbCorbaException);
 */



        cadmin::assoc::AssociateWriter getAssociate(
            in cadmin::AssociateId id,
            in boolean             noWait
        ) raises (common::OsbCorbaException);

        cadmin::assoc::AssociateIdSeq getAssociateIds();

        cadmin::assoc::AssociateSeq getAssociates()
            raises (common::OsbCorbaException);



        cadmin::assoc::AssociateWriter newAssociate(
            in cadmin::assoc::AssociateType type
        ) raises (common::OsbCorbaException);

        boolean delAssociate (
            in cadmin::AssociateId id,
            in boolean             noWait
        ) raises (common::OsbCorbaException);



        cadmin::contract::ContractWriter getContract(
            in cadmin::ContractId id
        ) raises (common::OsbCorbaException);

        cadmin::contract::ContractSeq getContracts(
            in cadmin::contract::ContractIdSeq idList
        ) raises (common::OsbCorbaException);

        cadmin::contract::ContractIdSeq getContractIds();

        cadmin::contract::ContractSeq getAllContracts()
            raises (common::OsbCorbaException);



        cadmin::contract::ContractWriter newContract(
            in contract::AccountingType acctType
        ) raises (common::OsbCorbaException);

        boolean delContract(
            in cadmin::ContractId cId,
            in boolean                      noWait
        ) raises (common::OsbCorbaException);
    };                                  // interface AnCList
  };                                    // module cadmin
};                                      // module corba
#endif                                  // ANCLIST_IDL

---