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

Go to download
/*
 * Copyright (C) 2015 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.Category;
import travel.izi.api.model.enumeration.MtgObjectType;
import travel.izi.api.model.enumeration.PlaybackType;

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

/**
 * Promoted or most popular published tours and museums.
 */
@SuppressWarnings("unused")
@AutoValue
@JsonDeserialize(builder = AutoValue_AppFeaturedObject.Builder.class)
public abstract class AppFeaturedObject implements Serializable {

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

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

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

    /**
     * Category (typical for tour).
     */
    @Nullable
    public abstract Category category();

    /**
     * Type of playback algorithm.
     */
    // TODO: Make mandatory as from 1.3 version
    @Nullable
    public abstract PlaybackType playbackType();

    /**
     * Title (name) defined by a featured content publisher.
     */
    public abstract String title();

    /**
     * Optional sub-title (additional info) defined by a featured content publisher.
     * Examples: 'BUS TOUR', 'MUSEUM', 'WALKING TOUR'.
     */
    @Nullable
    public abstract String subTitle();

    /**
     * A position of object in returned set (the order to show on a dashboard). Values: [1..10]
     */
    public abstract Integer position();

    /**
     * Images of the content.
     * NOTE: Contains only one object (first image).
     */
    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 category(Category category);
        public abstract Builder playbackType(PlaybackType playbackType);
        public abstract Builder title(String title);
        public abstract Builder subTitle(String subTitle);
        public abstract Builder position(Integer position);
        public abstract Builder images(List images);

        public abstract AppFeaturedObject build();
    }
}