com.ibm.bpc.clientcore

Class GenericBPCQuery

  • java.lang.Object
    • com.ibm.bpc.clientcore.GenericBPCQuery
  • All Implemented Interfaces:
    Query


    public abstract class GenericBPCQuery
    extends java.lang.Object
    implements Query
    GenericBPCQuery is an abstract base class used to issue queries against the Business Flow Manager and the Human Task Manager.
    The class allows you to dynamically set the SELECT, WHERE and ORDER BY clauses as well as the Threshold.

    In addition, it provides static methods for common conversions that may be required to generate SQL queries.

    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String COPYRIGHT 
      protected java.lang.String orderClause 
      protected java.lang.String selectClause 
      protected java.lang.Integer threshold 
      protected java.lang.String type 
      protected java.lang.String whereClause 
    • Constructor Summary

      Constructors 
      Constructor and Description
      GenericBPCQuery() 
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      abstract java.util.List execute()
      Retrieves a list of application objects.
      java.lang.String getOrderClause()
      Returns the ORDER BY clause stored for the query.
      java.lang.String getSelectClause()
      Returns the SELECT clause stored for the query.
      java.lang.Integer getThreshold()
      Returns the Threshold value stored for the query.
      java.lang.String getType()
      Returns a type that identifies the objects returned by the Query.execute method.
      java.lang.String getWhereClause()
      Returns the WHERE clause stored for the query.
      void resetWhereClause()
      Resets the WHERE clause for the query.
      void setOrderClause(java.lang.String string)
      Sets the ORDER BY clause for the query.
      void setSelectClause(java.lang.String string)
      Sets the SELECT clause for the query.
      void setThreshold(int integer)
      Sets the Threshold value for the query.
      void setThreshold(java.lang.Integer integer)
      Sets the Threshold value for the query.
      void setType(java.lang.String value)
      Sets a type that identifies the objects returned by the Query.execute method.
      void setWhereClause(java.lang.String string)
      Sets the WHERE clause for the query.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • type

        protected java.lang.String type
      • selectClause

        protected java.lang.String selectClause
      • whereClause

        protected java.lang.String whereClause
      • orderClause

        protected java.lang.String orderClause
      • threshold

        protected java.lang.Integer threshold
    • Constructor Detail

      • GenericBPCQuery

        public GenericBPCQuery()
    • Method Detail

      • execute

        public abstract java.util.List execute()
                                        throws ClientException
        Description copied from interface: Query
        Retrieves a list of application objects. Implement this method to access backend modules and to filter the result list.
        Specified by:
        execute in interface Query
        Returns:
        a list of objects that adhere to the Java Bean conventions.
        Throws:
        ClientException
      • getType

        public java.lang.String getType()
        Description copied from interface: Query
        Returns a type that identifies the objects returned by the Query.execute method. Implement this type to establish type checking between the query and its caller.
        Specified by:
        getType in interface Query
        Returns:
        The String representing the type of objects.
      • setType

        public void setType(java.lang.String value)
        Sets a type that identifies the objects returned by the Query.execute method.
        Parameters:
        value - a String representing the type of objects
      • getOrderClause

        public java.lang.String getOrderClause()
        Returns the ORDER BY clause stored for the query.
        Returns:
        the ORDER BY clause
      • getSelectClause

        public java.lang.String getSelectClause()
        Returns the SELECT clause stored for the query.
        Returns:
        the SELECT clause
      • getThreshold

        public java.lang.Integer getThreshold()
        Returns the Threshold value stored for the query.
        Returns:
        the Threshold value
      • getWhereClause

        public java.lang.String getWhereClause()
        Returns the WHERE clause stored for the query.
        Returns:
        the WHERE clause
      • setOrderClause

        public void setOrderClause(java.lang.String string)
        Sets the ORDER BY clause for the query.
        Parameters:
        string - an ORDER BY clause
      • setSelectClause

        public void setSelectClause(java.lang.String string)
        Sets the SELECT clause for the query.
        Parameters:
        string - a SELECT clause
      • setThreshold

        public void setThreshold(int integer)
        Sets the Threshold value for the query.
        Parameters:
        integer - a Threshold value
      • setThreshold

        public void setThreshold(java.lang.Integer integer)
        Sets the Threshold value for the query.
        Parameters:
        integer - a Threshold value
      • setWhereClause

        public void setWhereClause(java.lang.String string)
        Sets the WHERE clause for the query.
        Parameters:
        string - a WHERE clause
      • resetWhereClause

        public void resetWhereClause()
        Resets the WHERE clause for the query.
IBM Business Process ManagerTM
Release 8