001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: welker $'
006 * '$Date: 2010-05-06 05:21:26 +0000 (Thu, 06 May 2010) $' 
007 * '$Revision: 24234 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.objectmanager.cache;
031
032import org.kepler.objectmanager.lsid.KeplerLSID;
033
034/**
035 * Interface that represents an object in the ObjectCache.
036 */
037public interface CacheObjectInterface {
038        /**
039         * get the name of this object
040         */
041        public String getName();
042
043        /**
044         * get the lsid for this object
045         */
046        public KeplerLSID getLSID();
047
048        /**
049         * set the lsid
050         */
051        public void setLSID(KeplerLSID lsid);
052
053        /**
054         * set the name
055         */
056        public void setName(String name);
057
058        /**
059         * set a user configured attribute on the CacheObject
060         */
061        public void addAttribute(String name, String value);
062
063        /**
064         * get the attribute with the specified name
065         */
066        public String getAttribute(String name);
067
068        /**
069         * remove the attribute with the given name and return it.
070         */
071        public void removeAttribute(String name);
072
073        /**
074         * return the java object associated with this CacheObject
075         */
076        public Object getObject();
077
078        /**
079         * call back for when this object is added to the cache
080         */
081        public void objectAdded();
082
083        /**
084         * call back for when this object is removed by CacheManager
085         */
086        public void objectRemoved();
087
088        /**
089         * call back for when this object is purged by CacheManager
090         */
091        public void objectPurged();
092
093        /**
094         * deserialize this cache object
095         */
096        // public void deserialize(InputStream in) throws CacheException;
097        /**
098         * serialize this cache object
099         */
100        // public void serialize(OutputStream out) throws CacheException;
101}