org.enhydra.shark.api.client.wfmodel
Interface WfActivityIterator

All Superinterfaces:
BaseIterator

public interface WfActivityIterator
extends BaseIterator

OMG definition: The WfActivityIterator interface specializes the WfBase::BaseIterator interface and adds activity specific operations. The following attributes can be used in query expressions using: key, name, priority, description, state.

We extended OMG's interface by duplicating methods, and adding additional parameter that represents transaction. If you use methods without SharkTransaction parameter, the transaction will be implicitly created, and if you use it with SharkTransaction parameter you must obey to some rules explained in HowTo documentation.

Also, look at our implementation API documentation of this interface to see which additional attributes can be used in query expressions.


Method Summary
 WfActivity[] get_next_n_sequence(int max_number)
           
 WfActivity get_next_object()
           
 WfActivity[] get_previous_n_sequence(int max_number)
           
 WfActivity get_previous_object()
           
 
Methods inherited from interface org.enhydra.shark.api.client.wfbase.BaseIterator
goto_end, goto_start, how_many, names_in_expression, query_expression, query_grammar, set_names_in_expression, set_query_expression, set_query_grammar
 

Method Detail

get_next_object

public WfActivity get_next_object()
                           throws java.lang.Exception
Throws:
java.lang.Exception

get_previous_object

public WfActivity get_previous_object()
                               throws java.lang.Exception
Throws:
java.lang.Exception

get_next_n_sequence

public WfActivity[] get_next_n_sequence(int max_number)
                                 throws java.lang.Exception
Throws:
java.lang.Exception

get_previous_n_sequence

public WfActivity[] get_previous_n_sequence(int max_number)
                                     throws java.lang.Exception
Throws:
java.lang.Exception