= Cached
:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you 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.

For classes whose title is to be cached, use _DomainObjectLayout#titleUiEvent()_ with a subclass of _org.apache.causeway.applib.CausewayModuleApplib.TitleUiEvent_ that implements this marker interface.

The cache configuration will by default be taken from _org.apache.causeway.core.config.CausewayConfiguration.Extensions.Titlecache_ , but if the xref:refguide:extensions:index/titlecache/applib/event/CachedWithCacheSettings.adoc[CachedWithCacheSettings] is implemented, then these defaults can be fine-tuned.

== API

[source,java]
.Cached.java
----
interface Cached {
  int expiryDurationInMinutes()     // <.>
  int maxSizeInEntries()     // <.>
}
----

<.> xref:#expiryDurationInMinutes_[expiryDurationInMinutes()]
+
--
The number of minutes that a title should stay in the cache (of a given logical type name)
--
<.> xref:#maxSizeInEntries_[maxSizeInEntries()]
+
--
The maximum number of entries that can reside in the cache (of a given logical type name).
--

== Members

[#expiryDurationInMinutes_]
=== expiryDurationInMinutes()

The number of minutes that a title should stay in the cache (of a given logical type name)

[#maxSizeInEntries_]
=== maxSizeInEntries()

The maximum number of entries that can reside in the cache (of a given logical type name).
