DateTimeQuerySettings.java

/*
 * Copyright 2015 Open mHealth
 *
 * 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.openmhealth.shimmer.common.configuration;

import org.openmhealth.shimmer.common.domain.DateTimeQueryReferenceFrame;
import org.openmhealth.shimmer.common.domain.DateTimeQueryTimeZoneRestriction;

import java.time.Duration;
import java.time.ZoneId;
import java.util.Optional;


/**
 * @author Emerson Farrugia
 */
public interface DateTimeQuerySettings {

    /**
     * @return the frame of reference that the bounds are expressed in
     */
    DateTimeQueryReferenceFrame getReferenceFrame();

    /**
     * @return the time zone restriction placed on the query bounds
     */
    Optional<DateTimeQueryTimeZoneRestriction> getTimeZoneRestriction();

    /**
     * @return the time zone that the query bounds are fixed to
     */
    Optional<ZoneId> getFixedTimeZone();

    /**
     * @return the minimum amount of time between the query bounds
     */
    Optional<Duration> getMinimumDuration();

    /**
     * @return the maximum amount of time between the query bounds
     */
    Optional<Duration> getMaximumDuration();
}