001 /* ====================================================================
002 * The Apache Software License, Version 1.1
003 *
004 * Copyright (c) 2003 The Apache Software Foundation. All rights
005 * reserved.
006 *
007 * Redistribution and use in source and binary forms, with or without
008 * modification, are permitted provided that the following conditions
009 * are met:
010 *
011 * 1. Redistributions of source code must retain the above copyright
012 * notice, this list of conditions and the following disclaimer.
013 *
014 * 2. Redistributions in binary form must reproduce the above copyright
015 * notice, this list of conditions and the following disclaimer in
016 * the documentation and/or other materials provided with the
017 * distribution.
018 *
019 * 3. The end-user documentation included with the redistribution,
020 * if any, must include the following acknowledgment:
021 * "This product includes software developed by the
022 * Apache Software Foundation (http://www.apache.org/)."
023 * Alternately, this acknowledgment may appear in the software itself,
024 * if and wherever such third-party acknowledgments normally appear.
025 *
026 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
027 * Foundation" must not be used to endorse or promote products derived
028 * from this software without prior written permission. For written
029 * permission, please contact apache@apache.org.
030 *
031 * 5. Products derived from this software may not be called "Apache",
032 * nor may "Apache" appear in their name, without prior written
033 * permission of the Apache Software Foundation.
034 *
035 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
036 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
037 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
038 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
039 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
040 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
041 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
042 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
043 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
044 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
045 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
046 * SUCH DAMAGE.
047 * ====================================================================
048 *
049 * This software consists of voluntary contributions made by many
050 * individuals on behalf of the Apache Software Foundation. For more
051 * information on the Apache Software Foundation, please see
052 * <http://www.apache.org/>.
053 *
054 */
055 package org.jpu.patterns.proxy;
056
057 import java.util.Map;
058 import java.util.Set;
059
060 import org.jpu.patterns.common.CopyException;
061 import org.jpu.patterns.common.CopyOptions;
062
063 /**
064 * This interface can <i><b>optionally</b></i> be implemented by a proxy that is backed by {@link ProxyBean}. It
065 * gives the client access to certain information maintained by the underlying {@link ProxyBean}. Use of this interface
066 * is not required, and {@link ProxyBean} can be used with or without it depending on whether you wish to expose this
067 * functionality to clients.
068 * <p>
069 * Note you may also elect to just copy and paste some of these methods into your interface. So long as you leave the signatures
070 * the same, {@link ProxyBean} will supply suitable implementations.
071 */
072 public interface IProxyBean {
073 /**
074 * Returns a <code>Map</code> containing all the attributes managed by the underlying {@link ProxyBean}, keyed by
075 * attribute name.
076 */
077 public Map getAttributes();
078 public Map copyChangesTo(Object dest) throws CopyException;
079 public Map copyChangesTo(Object dest, CopyOptions options) throws CopyException;
080 public Map copyTo(Object dest) throws CopyException;
081 public Map copyTo(Object dest, CopyOptions options) throws CopyException;
082 public Set getChangedAttributes();
083 public boolean areAnyAttributesChanged();
084 public boolean isAttributeChanged(String attributeName);
085 public void setChangedFlag(String attributeName);
086 public void clearChangedFlags();
087 }
088