%% @author Marc Worrell <marc@worrell.nl>
%% @copyright 2009 Marc Worrell
%%
%% Copyright 2009 Marc Worrell
%%
%% 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.
%%
%% @doc Scomp behaviour definition.  A scomp is a screen component that can optionally be cached.
%%
%%      render(Params, Vars, Context) -> {ok, NewContext} | {ok, iolist()} | {error, Error}
%%
%%      vary(Params, Context) -> {EssentialParams, MaxAge, Vary} | nocache | default
%%
%%          Params = proplist()
%%          EssentialParams = proplist()  (proplist with params that make differences in the cache key)
%%          MaxAge = integer()
%%          Vary = TermList  (used as dependencies for the depcache)


-module(zotonic_scomp).

-callback render(Params :: list(), Vars :: map(), Context :: z:context()) -> term().
-callback vary(Params :: list(), Context :: z:context()) -> atom().