summaryrefslogtreecommitdiff
path: root/cpp/slice/Ice/UserExceptionFactory.ice
blob: e892d8d78d55345c6dd1f24f95d97100a32bc43e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
// **********************************************************************
//
// Copyright (c) 2001
// Mutable Realms, Inc.
// Huntsville, AL, USA
//
// All Rights Reserved
//
// **********************************************************************

#ifndef ICE_USER_EXCEPTION_FACTORY_ICE
#define ICE_USER_EXCEPTION_FACTORY_ICE

module Ice
{

/**
 *
 * A factory for user exceptions. User exception factories are
 * necessary if a user exception derived from an exception declared in
 * an operation's <literal>throws</literal> clause is raised, and
 * exception truncation to the base exception is not desireable.
 *
 * @see ObjectFactory
 *
 **/
local interface UserExceptionFactory
{
    /**
     *
     * Create and throw a new user exception for a given user
     * exception type. The type is the absolute Slice type name, i.e.,
     * the the name relative to the unnamed top-level Slice
     * module. For example, the absolute Slice type name for a user
     * exception [Bar] in the module [Foo] is [::Foo::Bar].
     *
     * <note><para>The leading "[::]" is required.</para></note>
     *
     * @param type The user exception type.
     *
     **/
    void createAndThrow(string type);

    /**
     *
     * Called when the factory is removed from the Communicator, or if
     * the Communicator is destroyed.
     *
     * @see Communicator::removeUserExceptionFactory
     * @see Communicator::destroy
     *
     **/
    void destroy();
};

};

#endif