User's Guide
Reference Manual
Release Notes
PDF
Top

cosNotification
Reference Manual
Version 1.1.18

Expand All
Contract All

Table of Contents

# CosNotification_AdminPropertiesAdmin

### MODULE

CosNotification_AdminPropertiesAdmin

### MODULE SUMMARY

This module implements the OMG CosNotification::AdminPropertiesAdmin interface.

### DESCRIPTION

To get access to the record definitions for the structures use:
-include_lib("cosNotification/include/*.hrl").

All objects, which inherit this interface, export functions described in this module.

### EXPORTS

get_admin(Object) -> AdminProperties

Types:

Object = #objref
AdminProperties = [AdminProperty]
AdminProperty = #'CosNotification_Property'{name, value}
name = string()
value = #any

This operation returns sequence of name-value pairs which encapsulates the current administrative properties of the target object.

set_admin(Object, AdminProperties) -> Reply

Types:

Object = #objref
AdminProperties = [AdminProperty]
AdminProperty = #'CosNotification_Property'{name, value}
name = string()
value = #any
Reply = ok | {'EXCEPTION', CosNotification_UnsupportedAdmin}

As input, this operation accepts a sequence of name-value pairs encapsulating the desired administrative settings for the target object. If it is not possible to set the given properties the exception UnsupportedAdmin will be raised.