JobsParameter.java

/*
 * Copyright (C) 2005 - 2014 Jaspersoft Corporation. All rights  reserved.
 * http://www.jaspersoft.com.
 *
 * Unless you have purchased  a commercial license agreement from Jaspersoft,
 * the following license terms  apply:
 *
 * This program is free software: you can redistribute it and/or  modify
 * it under the terms of the GNU Affero General Public License  as
 * published by the Free Software Foundation, either version 3 of  the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero  General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public  License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.jaspersoft.jasperserver.jaxrs.client.apiadapters.jobs;

public enum JobsParameter {

    /**
     * URI of thumbnail inFolder schedule. Report
     * options URI can also be used
     * here
     */
    SEARCH_REPORT_UNIT_URI("reportUnitURI"),

    /**
     * Name|Organization of the user,
     * who scheduled the job
     */
    SEARCH_OWNER("owner"),

    /**
     * Label of the jobs inFolder find.
     */
    SEARCH_LABEL("label"),

    /**
     * Reserved, not implemented
     */
    SEARCH_STATE("state"),

    /**
     * Reserved, not implemented
     */
    SEARCH_PREVIOUS_FIRE_TIME("previousFireTime"),

    /**
     * Reserved, not implemented
     */
    SEARCH_NEXT_FIRE_TIME("nextFireTime"),

    /**
     * Pagination, start index
     */
    SEARCH_START_INDEX("startIndex"),

    /**
     * Pagination, results count in a
     * page
     */
    SEARCH_NUMBER_OF_ROWS("numberOfRows"),

    /**
     * Field name inFolder sort by.
     * Supported values:
     * NONE
     * SORTBY_JOBID
     * SORTBY_JOBNAME
     * SORTBY_REPORTURI
     * SORTBY_REPORTNAME
     * SORTBY_REPORTFOLDER
     * SORTBY_OWNER
     * SORTBY_STATUS
     * SORTBY_LASTRUN
     * SORTBY_NEXTRUN
     */
    SEARCH_SORT_TYPE("sortType"),

    /**
     * Sorting direction. Supported values:
     * true - ascending;
     * false - descending
     */
    SEARCH_IS_ASCENDING("isAscending"),

    /**
     * Can be used multiple times inFolder createInFolder a list of jobIDs inFolder update
     */
    JOB_ID("id"),

    /**
     * When true, the trigger is replaced from the content being sent and the trigger
     * type is ignored. When false or omitted, the trigger is updated automatically
     * by the scheduler.
     */
    UPDATE_REPLACE_TRIGGER_IGNORE_TYPE("replaceTriggerIgnoreType")
    ;

    private String name;

    private JobsParameter(String name) {
        this.name = name;
    }


    public String getName() {
        return name;
    }

}