osbuser.idl

Go to the documentation of this file.

// OSB library ********************************************* -*- IDL -*-
/*
  AUTHOR(S): Elangovan Angannan (aen)

  RCS information
   $Name: OSB_060808 $
   $Revision: 1.13.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 _OSBUSER_IDL_
#define _OSBUSER_IDL_

// ************************************************************************
// included idl files
#include "corba_utility.idl"
#include "osbmodule.idl"
#include "osbusrgrp.idl"

// ************************************************************************
// module extensions
module corba {
  module osbadm {

// forward declarations
    interface UserWriter;

// *********************************************************************
// type definitions

    struct UserId {
        long id;
    };

// *********************************************************************
// interface definitions
    interface User {
        UserId id()
          raises (common::OsbCorbaException);

        common::Utf8String loginName()
          raises (common::OsbCorbaException);

        common::Utf8String name()
          raises (common::OsbCorbaException);

        common::Utf8String email()
          raises (common::OsbCorbaException);



        ModuleId defModule()
          raises (common::OsbCorbaException);
        ModuleIdSeq availModules()
          raises (common::OsbCorbaException);
        UserGroupId userGroup(in ModuleId modId)
          raises (common::OsbCorbaException);
        boolean isAvailable(in ModuleId id)
          raises (common::OsbCorbaException);

        UserWriter getWriter()
          raises (common::OsbCorbaException);
    };                                  // interface User

    interface UserWriter : User {
        void changePassword(
            in common::Utf8String oldPw,
            in common::Utf8String newPw
        ) raises (common::OsbCorbaException);

        void resetPassword(
            in common::Utf8String newPw
        ) raises (common::OsbCorbaException);

        void setName(in common::Utf8String name)
            raises (common::OsbCorbaException);

        void setEmail(in common::Utf8String email)
            raises (common::OsbCorbaException);

        void setGrants(in UserGroupIdSeq grps)
          raises (common::OsbCorbaException);

        boolean setDefModule(in ModuleId defMod)
          raises (common::OsbCorbaException);

        void revoke(in ModuleId modId)
            raises (common::OsbCorbaException);

        void commitChanges(in boolean noWait)
          raises (common::OsbCorbaException);
    };                                  // UserWriter
  };                                    // module osbadm
};                                      // module corba
#endif                                  // #ifndef _OSBUSER_IDL_

---