org.enhydra.shark.api.client.wfbase
Interface BaseIterator

All Known Subinterfaces:
WfActivityIterator, WfAssignmentIterator, WfEventAuditIterator, WfProcessIterator, WfProcessMgrIterator, WfResourceIterator

public interface BaseIterator

Java implementation of OMG's interface. This is how OMG defines it:

The BaseIterator interface is used to navigate relationships of cardinality greater than 1 in this specification. It supports specification of a filter using parameterized query expressions.


Method Summary
 void goto_end()
          Positions the iterator such that the next "previous" retrieval will retrieve the last element in the collection.
 void goto_start()
          Positions the iterator such that the next "next" retrieval will retrieve the first element in he collection.
 int how_many()
          Returns the number of elements in the collection.
 java.util.Map names_in_expression()
          OMG definition: Returns a set of parameters that are used to substitute variables in the query_expression.
 java.lang.String query_expression()
          Returns the query expression used to filter the contents of the iterator.
 java.lang.String query_grammar()
          OMG definition: The query_grammar attribute identifies the query grammar used to define the query expression.
 void set_names_in_expression(java.util.Map query)
          NOTE: It does not have any influence on querying in our implementations.
 void set_query_expression(java.lang.String query)
          Defines the query expression used to filter the contents of the iterator.
 void set_query_grammar(java.lang.String query_grammmar)
          OMG definition: The query_grammar attribute identifies the query grammar used to define the query expression.
 

Method Detail

query_expression

public java.lang.String query_expression()
                                  throws java.lang.Exception
Returns the query expression used to filter the contents of the iterator.

Throws:
java.lang.Exception

set_query_expression

public void set_query_expression(java.lang.String query)
                          throws java.lang.Exception,
                                 InvalidQuery
Defines the query expression used to filter the contents of the iterator.

Throws:
java.lang.Exception
InvalidQuery

names_in_expression

public java.util.Map names_in_expression()
                                  throws java.lang.Exception
OMG definition: Returns a set of parameters that are used to substitute variables in the query_expression. The parameters are defined by name-value pairs, where the name identifies the variable and the value represents the variable value to be substituted.

Throws:
java.lang.Exception

set_names_in_expression

public void set_names_in_expression(java.util.Map query)
                             throws java.lang.Exception,
                                    NameMismatch
NOTE: It does not have any influence on querying in our implementations.

OMG definition: Defines a set of parameters that are used to substitute variables in the query_expression. The parameters are defined by name-value pairs, where the name identifies the variable and the value represents the variable value to be substituted.

Throws:
java.lang.Exception
NameMismatch

query_grammar

public java.lang.String query_grammar()
                               throws java.lang.Exception
OMG definition: The query_grammar attribute identifies the query grammar used to define the query expression. The Constraint Language defined by the OMG Object Trading Service is used as the mandatory query grammar in this specification; implementations of the WfM Facility may support additional query grammars. The Trader Constraint Language is identified via the string TCL.

Throws:
java.lang.Exception

set_query_grammar

public void set_query_grammar(java.lang.String query_grammmar)
                       throws java.lang.Exception,
                              GrammarNotSupported
OMG definition: The query_grammar attribute identifies the query grammar used to define the query expression. The Constraint Language defined by the OMG Object Trading Service is used as the mandatory query gramma in this specification; implementations of the WfM Facility may support additional query grammars. The Trader Constraint Language is identified via the string TCL.

Throws:
java.lang.Exception
GrammarNotSupported

how_many

public int how_many()
             throws java.lang.Exception
Returns the number of elements in the collection.

Throws:
java.lang.Exception

goto_start

public void goto_start()
                throws java.lang.Exception
Positions the iterator such that the next "next" retrieval will retrieve the first element in he collection.

Throws:
java.lang.Exception

goto_end

public void goto_end()
              throws java.lang.Exception
Positions the iterator such that the next "previous" retrieval will retrieve the last element in the collection.

Throws:
java.lang.Exception