travel.izi.api.model.entity.WebFeaturedObject Maven / Gradle / Ivy

Go to download

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

A java wrapper around the izi.TRAVEL API using Retrofit. Remote services are grouped into local service objects which can be centrally managed by a IZITravel instance. It will act as a factory for all of the services and will automatically initialize them with your credentials and API key.

The newest version!

/*
 * Copyright (C) 2014 IZITEQ B.V.
 *
 * 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 travel.izi.api.model.entity;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonPOJOBuilder;
import com.google.auto.value.AutoValue;
import travel.izi.api.model.enumeration.MtgObjectType;
import travel.izi.api.model.enumeration.Status;

import javax.annotation.Nullable;
import java.io.Serializable;
import java.util.List;

/**
 * Promoted or most popular tours, museums and cities.
 */
@SuppressWarnings("unused")
@AutoValue
@JsonDeserialize(builder = AutoValue_WebFeaturedObject.Builder.class)
public abstract class WebFeaturedObject implements Serializable {

    public static Builder builder() {
        return new AutoValue_WebFeaturedObject.Builder();
    }

    /**
     * Universally Unique Identifier of the object.
     */
    public abstract String uuid();

    /**
     * Object type (museum, tour or city).
     */
    public abstract MtgObjectType type();

    /**
     * Content publication status.
     */
    public abstract Status status();

    /**
     * Requested content language.
     */
    public abstract String language();

    /**
     * Language of returned content.
     */
    public abstract String contentLanguage();

    /**
     * Array of all available languages of content, ISO 639-1. Typical for museum and tour.
     */
    @Nullable
    public abstract List contentLanguages();

    /**
     * Localized (see content_language) name of object (title).
     */
    @Nullable
    public abstract String name();

    /**
     * Localized (see content_language) description of the object.
     */
    @Nullable
    public abstract String description();

    /**
     * Reserved field. Don’t use for now.
     */
    @Nullable
    public abstract Boolean promoted();

    /**
     * Universally Unique Identifier of city object. Typical for museum and tour.
     */
    @Nullable
    public abstract String cityUuid();

    /**
     * Universally Unique Identifier of country object. Typical for museum and tour.
     */
    @Nullable
    public abstract String countryUuid();

    /**
     * A position of object on a dashboard. Values: [1..5]
     */
    @Nullable
    public abstract Integer position();

    /**
     * Images of the content.
     */
    @Nullable
    public abstract List images();

    @AutoValue.Builder
    @JsonPOJOBuilder(withPrefix = "")
    public abstract static class Builder {
        public abstract Builder uuid(String uuid);
        public abstract Builder type(MtgObjectType type);
        public abstract Builder status(Status status);
        public abstract Builder language(String language);
        public abstract Builder contentLanguage(String contentLanguage);
        public abstract Builder contentLanguages(List contentLanguages);
        public abstract Builder name(String name);
        public abstract Builder description(String description);
        public abstract Builder promoted(Boolean promoted);
        public abstract Builder cityUuid(String cityUuid);
        public abstract Builder countryUuid(String countryUuid);
        public abstract Builder position(Integer position);
        public abstract Builder images(List images);

        public abstract WebFeaturedObject build();
    }
}