001package org.apache.commons.jcs.engine.logging.behavior;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import java.io.Serializable;
023
024/** Defines the common fields required by a cache event. */
025public interface ICacheEvent<K>
026    extends Serializable
027{
028    /**
029     * @param source the source to set
030     */
031    void setSource( String source );
032
033    /**
034     * @return the source
035     */
036    String getSource();
037
038    /**
039     * @param region the region to set
040     */
041    void setRegion( String region );
042
043    /**
044     * @return the region
045     */
046    String getRegion();
047
048    /**
049     * @param eventName the eventName to set
050     */
051    void setEventName( String eventName );
052
053    /**
054     * @return the eventName
055     */
056    String getEventName();
057
058    /**
059     * @param optionalDetails the optionalDetails to set
060     */
061    void setOptionalDetails( String optionalDetails );
062
063    /**
064     * @return the optionalDetails
065     */
066    String getOptionalDetails();
067
068    /**
069     * @param key the key to set
070     */
071    void setKey( K key );
072
073    /**
074     * @return the key
075     */
076    K getKey();
077}