KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > omg > DynamicAny > DynStructOperations


1 package org.omg.DynamicAny;
2
3
4 /**
5 * org/omg/DynamicAny/DynStructOperations.java .
6 * Generated by the IDL-to-Java compiler (portable), version "3.2"
7 * from ../../../../src/share/classes/org/omg/DynamicAny/DynamicAny.idl
8 * Saturday, February 9, 2008 9:40:12 AM GMT
9 */

10
11
12 /**
13     * DynStruct objects support the manipulation of IDL struct and exception values.
14     * Members of the exceptions are handled in the same way as members of a struct.
15     */

16 public interface DynStructOperations extends org.omg.DynamicAny.DynAnyOperations JavaDoc
17 {
18
19   /**
20         * Returns the name of the member at the current position.
21         * This operation may return an empty string since the TypeCode of the value being
22         * manipulated may not contain the names of members.
23         *
24         * @exception TypeMismatch if the DynStruct represents an empty exception.
25         * @exception InvalidValue if the current position does not indicate a member
26         */

27   String JavaDoc current_member_name () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch JavaDoc, org.omg.DynamicAny.DynAnyPackage.InvalidValue JavaDoc;
28
29   /**
30         * Returns the TCKind associated with the member at the current position.
31         *
32         * @exception TypeMismatch if the DynStruct represents an empty exception.
33         * @exception InvalidValue if the current position does not indicate a member
34         */

35   org.omg.CORBA.TCKind JavaDoc current_member_kind () throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch JavaDoc, org.omg.DynamicAny.DynAnyPackage.InvalidValue JavaDoc;
36
37   /**
38         * Returns a sequence of NameValuePairs describing the name and the value of each member
39         * in the struct associated with a DynStruct object.
40         * The sequence contains members in the same order as the declaration order of members
41         * as indicated by the DynStruct's TypeCode. The current position is not affected.
42         * The member names in the returned sequence will be empty strings if the DynStruct's TypeCode
43         * does not contain member names.
44         */

45   org.omg.DynamicAny.NameValuePair JavaDoc[] get_members ();
46
47   /**
48         * Initializes the struct data value associated with a DynStruct object from a sequence of NameValuePairs.
49         * The operation sets the current position to zero if the passed sequences has non-zero length. Otherwise,
50         * if an empty sequence is passed, the current position is set to -1.
51         * <P>Members must appear in the NameValuePairs in the order in which they appear in the IDL specification
52         * of the struct as indicated by the DynStruct's TypeCode or they must be empty strings.
53         * The operation makes no attempt to assign member values based on member names.
54         *
55         * @exception TypeMismatch if the member names supplied in the passed sequence do not match the
56         * corresponding member name in the DynStruct's TypeCode and they are not empty strings
57         * @exception InvalidValue if the passed sequence has a number of elements that disagrees
58         * with the number of members as indicated by the DynStruct's TypeCode
59         */

60   void set_members (org.omg.DynamicAny.NameValuePair JavaDoc[] value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch JavaDoc, org.omg.DynamicAny.DynAnyPackage.InvalidValue JavaDoc;
61
62   /**
63         * Returns a sequence of NameDynAnyPairs describing the name and the value of each member
64         * in the struct associated with a DynStruct object.
65         * The sequence contains members in the same order as the declaration order of members
66         * as indicated by the DynStruct's TypeCode. The current position is not affected.
67         * The member names in the returned sequence will be empty strings if the DynStruct's TypeCode
68         * does not contain member names.
69         */

70   org.omg.DynamicAny.NameDynAnyPair JavaDoc[] get_members_as_dyn_any ();
71
72   /**
73         * Initializes the struct data value associated with a DynStruct object from a sequence of NameDynAnyPairs.
74         * The operation sets the current position to zero if the passed sequences has non-zero length. Otherwise,
75         * if an empty sequence is passed, the current position is set to -1.
76         * <P>Members must appear in the NameDynAnyPairs in the order in which they appear in the IDL specification
77         * of the struct as indicated by the DynStruct's TypeCode or they must be empty strings.
78         * The operation makes no attempt to assign member values based on member names.
79         *
80         * @exception TypeMismatch if the member names supplied in the passed sequence do not match the
81         * corresponding member name in the DynStruct's TypeCode and they are not empty strings
82         * @exception InvalidValue if the passed sequence has a number of elements that disagrees
83         * with the number of members as indicated by the DynStruct's TypeCode
84         */

85   void set_members_as_dyn_any (org.omg.DynamicAny.NameDynAnyPair JavaDoc[] value) throws org.omg.DynamicAny.DynAnyPackage.TypeMismatch JavaDoc, org.omg.DynamicAny.DynAnyPackage.InvalidValue JavaDoc;
86 } // interface DynStructOperations
87
Popular Tags