associate.idl

Go to the documentation of this file.

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

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.47.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 ASSOCIATE_IDL
#define ASSOCIATE_IDL
// *********************************************************************
#include "address.idl"
#include "contract.idl"

module corba {
  module cadmin {
    module assoc {
      enum AssociateType {
          atUnknown,     
          atCustomer     
      };

      interface AssociateWriter {
          readonly attribute AssociateId id;

          readonly attribute common::Utf8String name;

          readonly attribute AssociateId parentId;

          readonly attribute unsigned long levelId;

          readonly attribute AssociateType asType;

          readonly attribute AssociateIdSeq getChildren;

          readonly attribute common::TaxKeyId tkId;

          readonly attribute Status effStatus;

          readonly attribute Status prefStatus;

          readonly attribute common::DateTime effStatusDate;

          readonly attribute common::DateTime prefStatusDate;

          readonly attribute common::Account salesLedger;

          readonly attribute common::Account purchaseLedger;

          readonly attribute common::Utf8String accNo;

          StatusValue requestedStatus(
              in common::DateTime ts
          ) raises (common::OsbCorbaException);

          StatusHistory statusHistory(
              in common::DateTime from,
              in common::DateTime to,
              in boolean          noWait
          ) raises (common::OsbCorbaException);

          cadmin::addr::AddressWriter getAddress
              (in cadmin::addr::AddrTypeId type
          ) raises (common::OsbCorbaException);

          cadmin::addr::AddressSeq getAddresses()
              raises (common::OsbCorbaException);

          cadmin::addr::AddressWriter getNewAddress(
              in cadmin::addr::AddrTypeIdSeq types
          ) raises (common::OsbCorbaException);

          boolean removeAddress(
              in cadmin::addr::AddrTypeId type,
              in boolean noWait,
              out common::CfgErrorSeq errors
          ) raises (common::OsbCorbaException);

          boolean linkAddressType(
              in cadmin::addr::AddrTypeId type,
              in cadmin::addr::AddrTypeId newType,
              in boolean noWait
          ) raises (common::OsbCorbaException);

          boolean unlinkAddressType(
              in cadmin::addr::AddrTypeId type,
              in boolean noWait
          ) raises (common::OsbCorbaException);

          cadmin::contract::ContractIdSeq getContractIds();

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

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

          void setTaxKey(in common::TaxKeyId tId);

          void setSalesLedger(in common::Account salesLedger);

          void setPurchaseLedger(in common::Account purchaseLedger);

          void setName(in common::Utf8String name);

          void setAccountNo(in common::Utf8String accNo);

          AssociateId create(
              in boolean noWait
          ) raises (common::OsbCorbaException);

          boolean commitChanges(
              in boolean noWait
          ) raises(common::OsbCorbaException);



          boolean changeStatus(
              inout StatusRequest       status,
              in    boolean             noWait,
              out   common::CfgErrorSeq errors
          ) raises (common::OsbCorbaException);
      };                          // interface AssociateWriter

      interface CustomerWriter : AssociateWriter {};
    };             // module assoc
  };               // module cadmin
};
#endif                                  // #ifndef ASSOCIATE_IDL

---