/*
 * Copyright © Yan Zhenjie. All Rights Reserved
 *
 * 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.yolanda.nohttp.rest;

import com.yolanda.nohttp.IBasicRequest;

/**
 * <p>For the Request to encapsulate some Http protocol related properties.</p>
 * Created by Yan Zhenjie on 2016/8/20.
 */
public interface IProtocolRequest extends IBasicRequest {

    /**
     * Set the request cache primary key, it should be globally unique.
     *
     * @param key unique key.
     */
    void setCacheKey(String key);

    /**
     * Get key of cache data.
     *
     * @return cache key.
     */
    String getCacheKey();

    /**
     * Set the cache mode.
     *
     * @param cacheMode The value from {@link CacheMode}.
     */
    void setCacheMode(CacheMode cacheMode);

    /**
     * He got the request cache mode.
     *
     * @return value from {@link CacheMode}.
     */
    CacheMode getCacheMode();

}
