com.ibm.bpc.clientcore
Interface Query

All Known Implementing Classes:
GenericBPCQuery

public interface Query

This interface encapsulates custom queries for application objects in the back end modules. In contrast to the modules' APIs, the query returns a list of application objects which adhere to the Java beans conventions, e.g. ActivityInstanceBean or TaskInstanceBean. That means these object provide access to their properties through associated getter methods. Implement this interface to shield the application from configuring or access details for backs ends.

In the Business Process Choreographer context, the components and the application use this interface to query the BusinessFlowManagerService and HumanTaskManagerService back ends.


Field Summary
static java.lang.String COPYRIGHT
          (C) Copyright IBM Corporation 2005.
 
Method Summary
 java.util.List execute()
          Retrieves a list of application objects.
 java.lang.String getType()
          Returns a type which identifies the objects returned by the Query.execute method.
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
(C) Copyright IBM Corporation 2005.

See Also:
Constant Field Values
Method Detail

execute

public java.util.List execute()
                       throws ClientException
Retrieves a list of application objects. Implement this method to access back ends and to filter the result list.

Returns:
a list of objects which adhere to the Java Bean conventions.
Throws:
ClientException

getType

public java.lang.String getType()
Returns a type which identifies the objects returned by the Query.execute method. Implement this type to establish type checking between the query and its caller.

Returns:
The String representing the type of objects