corba::osbadm::User Interface Reference

Inheritance diagram for corba::osbadm::User:

[legend]List of all members.

---

Detailed Description

Provides readonly access to user information.

All functions throw if the user can not be locked.

Definition at line 62 of file osbuser.idl.

Public Member Functions

• UserId id () raises (common::OsbCorbaException)

  Unique user id.
  

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

  Get the user login name.
  

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

  Gets user (full) name.
  

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

  Gets email address of the user.
  

• UserWriter getWriter () raises (common::OsbCorbaException)

  Gets user writer for user information modification.
  

OSB modules assigned to the user:

• ModuleId defModule () raises (common::OsbCorbaException)

  Default OSB module of the user, it may not be set.
  

• ModuleIdSeq availModules () raises (common::OsbCorbaException)

  List of OSB modules available to the user.
  

• UserGroupId userGroup (in ModuleId modId) raises (common::OsbCorbaException)

  Get the user group that defines the access rights for a module.
  

• boolean isAvailable (in ModuleId id) raises (common::OsbCorbaException)

  Module available for the user?
  

---

Member Function Documentation

ModuleIdSeq corba::osbadm::User::availModules

(

)

raises (common::OsbCorbaException)

List of OSB modules available to the user.

ModuleId corba::osbadm::User::defModule

(

)

raises (common::OsbCorbaException)

Default OSB module of the user, it may not be set.

common::Utf8String corba::osbadm::User::email

(

)

raises (common::OsbCorbaException)

Gets email address of the user.

UserWriter corba::osbadm::User::getWriter

(

)

raises (common::OsbCorbaException)

Gets user writer for user information modification.

Returns:

user writer.

UserId corba::osbadm::User::id

(

)

raises (common::OsbCorbaException)

Unique user id.

User id is unique and created by the system. It cannot be changed once created.

boolean corba::osbadm::User::isAvailable

(

in ModuleId

id

)

raises (common::OsbCorbaException)

Module available for the user?

common::Utf8String corba::osbadm::User::loginName

(

)

raises (common::OsbCorbaException)

Get the user login name.

common::Utf8String corba::osbadm::User::name

(

)

raises (common::OsbCorbaException)

Gets user (full) name.

The user (full) name is not used for login. It is for information only.

Returns:

user (full) name.

UserGroupId corba::osbadm::User::userGroup

(

in ModuleId

modId

)

raises (common::OsbCorbaException)

Get the user group that defines the access rights for a module.

Parameters:

modId

Id of the module.

Returns:

The id of the user group for module,
it is 0 if the user does not have access to the module.

---

The documentation for this interface was generated from the following file:

• osbuser.idl

---