NAME

CORBA::Object::get_policy_overrides - (operation) return the list of policy overrides of the specified types set at Object scope


SYNOPSIS

IDL

  module CORBA
    {
    typedef sequence <Policy> PolicyList ;
    typedef unsigned long PolicyType ;
    typedef sequence <PolicyType> PolicyTypeSeq ;
    interface Object
      {
      PolicyList get_policy_overrides ( in PolicyTypeSeq types ) ;
      } ;
    } ;

C

  #include <orb.h>
  typedef struct
      {
      CORBA_unsigned_long              _maximum ;
      CORBA_unsigned_long              _length ;
      CORBA_Policy                   * _buffer ;
      }
      CORBA_PolicyList ;
  typedef CORBA_unsigned_long          CORBA_PolicyType ;
  typedef struct
      {
      CORBA_unsigned_long              _maximum ;
      CORBA_unsigned_long              _length ;
      CORBA_PolicyType               * _buffer ;
      }
      CORBA_PolicyTypeSeq ;
  CORBA_PolicyList * CORBA_Object_get_policy_overrides
      ( CORBA_Object o, CORBA_PolicyTypeSeq * types,
      CORBA_Environment * ev ) ;

C++

  #include <orb.h>
  namespace CORBA
    {
    class PolicyList
      { [...] /* mapped from sequence<Policy> */ } ;
    CORBA::ULong                       PolicyType ;
    class PolicyTypeSeq
      { [...] /* mapped from sequence<PolicyType> */ | ;
    class Object
      {
        public:
          PolicyList * _get_policy_overrides
              ( const PolicyTypeSeq & types);
      } ;
    } ;

Java

  package org.omg.CORBA ;
  public interface Object
    {
      Policy [] _get_policy_overrides ( int [] types ) ;
    }

Perl

(TBS)

Lisp

(TBS)


DESCRIPTION

The CORBA::Object::get_policy_overrides operation returns a list of policies applied at the object scope. types gives the list of policy types in which the caller is interested; if types is empty, then all policies applied at the object scope will be returned. If there are no override policies applied at the object level, then an empty list will be returned.


PARAMETERS

types (in, PolicyTypeSeq, sequence)

The list of policy types for which policies are to be returned; if empty, the all policy types are requested.

o

(C mapping only) the target object

ev

(C mapping only) a pointer to the CORBA_Environment


RETURN VALUE

A list (possibly empty) of policies applied at the Object scope.


EXCEPTIONS

(standard system exceptions)


NOTES

  1. (C++ mapping only) The IDL header is named orb.idl. The C++ mapping specification does not mention a specific header name. One might presume the header name should be orb.h. However, some ORB vendors are more imaginative, and use other, different header file names.

  2. (C++ mapping only) The C++ mapping of names may vary, depending on the implementation's support for nested classes and namespaces. The rules are:

        if C++ namespace is supported,
            then map IDL module to C++ namespace
        else if C++ nested classes are supported,
            then map IDL module to a C++ class
        else
            use the C mapping for names

    The C++ synopsis, above, assumes namespace support. For other situations, adjust accordingly.


SEE ALSO

CORBA::Object(3corba)


COPYRIGHT

Copyright 2012 Michael Marking. This document is distributed as part of corbadoc, a documentation-only package with the goal of describing the main CORBA-related definitions from the OMG specifications. This is version corbadoc-0.1.3-prototype, released 2011.12.23. corbadoc is an incomplete work in progress; this is a snapshot release. New releases will be posted at http://www.tatanka.com/software/corbadoc/.

The corbadoc documents, including this one, are licensed under the GNU Free Documentation License, v.1.3.