org.kie.api.runtime.query.AdvancedQueryContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kogito-api

The Kogito public API which is backwards compatible between releases.

There is a newer version: 10.0.0

/*
* Copyright 2017 Red Hat, Inc. and/or its affiliates.
* 
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* 
*     http://www.apache.org/licenses/LICENSE-2.0
* 
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.kie.api.runtime.query;

/**
 * 
 * Extension class to the basic ordering and pagination queries which use QueryContext.  
 * The AdvancedQueryContext is intended for use wherever advanced query functionality provided by the
 * KIE Query Service which provides advanced search capabilities that are based on Dashbuilder DataSets.
 * 
 */
public class AdvancedQueryContext extends QueryContext {

    private String orderByClause;

    public AdvancedQueryContext() {
        super();
    }

    public AdvancedQueryContext(QueryContext queryContext) {
        super(queryContext);
    }

    public AdvancedQueryContext(QueryContext queryContext, String orderByClause) {
        super(queryContext);
        this.orderByClause = orderByClause;
    }

    public AdvancedQueryContext(String orderByClause) {
        this.orderByClause = orderByClause;
    }

    /**
     * @return  the SQL Order By clause
     */
    public String getOrderByClause() {
        return orderByClause;
    }

    /**
     * Set the ORDER BY clause for advanced query.  For instance:
     * 
     * SELECT * FROM PROCESSINSTANCELOG 
     * ORDER BY PROCESSID ASC, PROCESSINSTANCEID DESC
     * 
     * has orderByClause of "PROCESSID ASC, PROCESSINSTANCEID DESC"
     * 
     * @param orderByClause the SQL Order By clause to set
     */
    public void setOrderByClause(String orderByClause) {
        this.orderByClause = orderByClause;
    }

}