com.arnaudpiroelle.marvel.api.params.name.character.GetCharacterSeriesParamName Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of marvel-api Show documentation
Marvel API is an OpenSource client for Marvel API
There is a newer version: 0.5.0
/**
 * Copyright (C) 2014 Arnaud Piroelle (contact@arnaudpiroelle.com)
 *
 * 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 com.arnaudpiroelle.marvel.api.params.name.character;

/**
 * Created by Arnaud on 04/03/2014.
 */
public enum GetCharacterSeriesParamName {
    /**
     * Description: Filter by series title.
     * Parameter type: query
     * Data type: string
     */
    TITLE("title"),

    /**
     * Description: Return series with titles that begin with the specified string (e.g. Sp).
     * Parameter type: query
     * Data type: string
     */
    TITLE_STARTS_WITH("titleStartsWith"),

    /**
     * Description: Return only series matching the specified start year.
     * Parameter type: query
     * Data type: int
     */
    START_YEAR("startYear"),

    /**
     * Description: Return only series which have been modified since the specified date.
     * Parameter type: query
     * Data type: Date
     */
    MODIFIED_SINCE("modifiedSince"),

    /**
     * Description: Return only series which contain the specified comics (accepts a comma-separated list of ids).
     * Parameter type: query
     * Data type: int
     */
    COMICS("comics"),

    /**
     * Description: Return only series which contain the specified stories (accepts a comma-separated list of ids).
     * Parameter type: query
     * Data type: int
     */
    STORIES("stories"),

    /**
     * Description: Return only series which have comics that take place during the specified events (accepts a comma-separated list of ids).
     * Parameter type: query
     * Data type: int
     */
    EVENTS("events"),

    /**
     * Description: Return only series which feature work by the specified creators (accepts a comma-separated list of ids).
     * Parameter type: query
     * Data type: int
     */
    CREATORS("creators"),

    /**
     * Description: Filter the series by publication frequency type.
     * Parameter type: query
     * Data type: string
     */
    SERIES_TYPE("seriesType"),

    /**
     * Description: Return only series containing one or more comics with the specified format.
     * Parameter type: query
     * Data type: string
     */
    CONTAINS("contains"),

    /**
     * Description: Order the result set by a field or fields. Add a "-" to the value sort in descending order. Multiple values are given priority in the order in which they are passed.
     * Parameter type: query
     * Data type: string
     */
    ORDER_BY("orderBy"),

    /**
     * Description: Limit the result set to the specified number of resources.
     * Parameter type: query
     * Data type: int
     */
    LIMIT("limit"),

    /**
     * Description: Skip the specified number of resources in the result set.
     * Parameter type: query
     * Data type: int
     */
    OFFSET("offset");

    private String label;

    private GetCharacterSeriesParamName(String value) {
        this.label = value;
    }

    @Override
    public String toString() {
        return this.label;
    }
}