BaseIterator


1   package org.enhydra.shark.api.client.wfbase;
2   
3   import org.enhydra.shark.api.SharkTransaction;
4   
5   import java.util.Map  ;
6   
7   /**
8    * Java implementation of OMG's interface. This is how OMG defines it:
9    * <p>
10   * The BaseIterator interface is used to navigate relationships of cardinality
11   * greater than 1 in this specification. It supports specification of a filter
12   * using parametrized query expressions.
13   */
14  public interface BaseIterator {
15     /** Returns the query expression used to filter the contents of the iterator. */
16     String   query_expression () throws BaseException;
17  
18     /** Returns the query expression used to filter the contents of the iterator. */
19     String   query_expression (SharkTransaction t) throws BaseException;
20  
21     /** Defines the query expression used to filter the contents of the iterator. */
22     void set_query_expression (String   query) throws BaseException, InvalidQuery;
23  
24     /** Defines the query expression used to filter the contents of the iterator. */
25     void set_query_expression (SharkTransaction t,String   query) throws BaseException, InvalidQuery;
26  
27     /**
28      * OMG definition: Returns a set of parameters that are used to substitute variables in the
29      * query_expression. The parameters are defined by name-value pairs, where the name
30      * identifies the variable and the value represents the variable value to be substituted.
31      */
32     Map   names_in_expression () throws BaseException;
33  
34     /**
35      * OMG definition: Returns a set of parameters that are used to substitute variables in the
36      * query_expression. The parameters are defined by name-value pairs, where the name
37      * identifies the variable and the value represents the variable value to be substituted.
38      */
39     Map   names_in_expression (SharkTransaction t) throws BaseException;
40  
41     /**
42      * NOTE: It does not have any influence on querying in our implementations.
43      * <p>
44      * OMG definition: Defines a set of parameters that are used to substitute variables in the
45      * query_expression. The parameters are defined by name-value pairs, where the name
46      * identifies the variable and the value represents the variable value to be substituted.
47      */
48     void set_names_in_expression (Map   query) throws BaseException, NameMismatch;
49  
50     /**
51      * NOTE: It does not have any influence on querying in our implementations.
52      * <p>
53      * OMG definition: Defines a set of parameters that are used to substitute variables in the
54      * query_expression. The parameters are defined by name-value pairs, where the name
55      * identifies the variable and the value represents the variable value to be substituted.
56      */
57     void set_names_in_expression (SharkTransaction t,Map   query) throws BaseException, NameMismatch;
58  
59     /**
60      * OMG definition: The query_grammar attribute identifies the query grammar
61      * used to define the query expression. The Constraint Language defined by
62      * the OMG Object Trading Service is used as the mandatory query grammar in
63      * this specification; implementations of the WfM Facility may support
64      * additional query grammars. The Trader Constraint Language is identified
65      * via the string TCL.
66      */
67     String   query_grammar () throws BaseException;
68  
69     /**
70      * OMG definition: The query_grammar attribute identifies the query grammar
71      * used to define the query expression. The Constraint Language defined by
72      * the OMG Object Trading Service is used as the mandatory query grammar in
73      * this specification; implementations of the WfM Facility may support
74      * additional query grammars. The Trader Constraint Language is identified
75      * via the string TCL.
76      */
77     String   query_grammar (SharkTransaction t) throws BaseException;
78  
79     /**
80      * OMG definition: The query_grammar attribute identifies the query grammar
81      * used to define the query expression. The Constraint Language defined by
82      * the OMG Object Trading Service is used as the mandatory query gramma in
83      * this specification; implementations of the WfM Facility may support
84      * additional query grammars. The Trader Constraint Language is identified
85      * via the string TCL.
86      */
87     void set_query_grammar (String   query_grammmar) throws BaseException, GrammarNotSupported;
88  
89     /**
90      * OMG definition: The query_grammar attribute identifies the query grammar
91      * used to define the query expression. The Constraint Language defined by
92      * the OMG Object Trading Service is used as the mandatory query gramma in
93      * this specification; implementations of the WfM Facility may support
94      * additional query grammars. The Trader Constraint Language is identified
95      * via the string TCL.
96      */
97     void set_query_grammar (SharkTransaction t,String   query_grammmar) throws BaseException, GrammarNotSupported;
98  
99     /** Returns the number of elements in the collection. */
100    int how_many () throws BaseException;
101 
102    /** Returns the number of elements in the collection. */
103    int how_many (SharkTransaction t) throws BaseException;
104 
105    /**
106     * Positions the iterator such that the next "next" retrieval will retrieve
107     * the first element in he collection.
108     */
109    void goto_start () throws BaseException;
110 
111    /**
112     * Positions the iterator such that the next "next" retrieval will retrieve
113     * the first element in he collection.
114     */
115    void goto_start (SharkTransaction t) throws BaseException;
116 
117    /**
118     * Positions the iterator such that the next "previous" retrieval will
119     * retrieve the last element in the collection.
120     */
121    void goto_end () throws BaseException;
122 
123    /**
124     * Positions the iterator such that the next "previous" retrieval will
125     * retrieve the last element in the collection.
126     */
127    void goto_end (SharkTransaction t) throws BaseException;
128 
129 }
130
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags