BaseJucasBean.java :  » Web-Framework » jucas » org » jucas » Java Open Source

/*
 * License
 *
 *
 * Copyright (c) 2003 Essl Christian.  All rights 
 * reserved.
 * 
 * 
 * This Licence is based on the Apache Software Licence Version 1.1.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer. 
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:  
 *       "This product includes software developed by Christian Essl 
 *        and others for project Jucas (http://www.jucas.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Jucas" and "Christian Essl" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written 
 *    permission, please contact essl_christian@jucas.org.
 *
 * 5. Products derived from this software may not be called "Jucas"
 *    or "Christian Essl", nor may "Jucas" or "Christian Essl"
 *    appear in their name, without prior written permission
 *    of Christian Essl (jucas@esslchristian.de).
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL CHRISTIAN ESSL OR
 * OTHER CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * 
 */
package org.jucas;

import java.io.Serializable;
import java.net.URI;

/**
 * This is a basic Helper implementation of a JucasBean
 * 
 * @author chris
 *
 */
public class BaseJucasBean implements IJucasBean,Serializable
{
  private JucasServices jucasServices;

  /**
   * Constructor for BaseJucasBean.
   */
  public BaseJucasBean()
  {
    super();
  }


  /**by default returns the requested Scope and if this is
   * {@link IJucasBean#NO_REQUESTED_SCOPE} returns Scopes.REQUEST
   * @see org.jucas.IJucasBean#getAllowedPageBeanScope(int)
   */
  public int getAllowedPageBeanScope(int requestedScope)
  {
    return Scopes.getUserPreferredPageBeanScope(requestedScope, Scopes.REQUEST);
  }

  /**
   * @see org.jucas.IJucasBean#retrievedFromBeanManager()
   */
  public void retrievedFromBeanManager()
  {
  }



  /**
   * Does nothing
   * @see org.jucas.IInitializeable#initializeJucasOnly()
   */
  public void initializeJucasOnly() throws Exception
  {
  }
  

  /**
   * @see org.jucas.IJucasBean#getBeanName()
   */
  final public URI getBeanName()
  {
    URI name = (this.jucasServices == null)?null:this.jucasServices.getBeanName();
    return name;
  }

  /**
   * @see org.jucas.IJucasBean#getJucasParent()
   */
  final public IJucasBean getJucasParent()
  {
    IJucasBean ret = (this.jucasServices == null)? 
              null : this.jucasServices.getJucasParent();
    return ret;
  }

  /**
   * @see org.jucas.IJucasBean#getStaticType()
   */
  public String getStaticType()
  {
    return null;
  }

  /**
   * @see org.jucas.IJucasBean#givenJucasServicesJucasOnly(org.jucas.JucasServices)
   */
  final public void givenJucasServicesJucasOnly(JucasServices jucasServices)
  {
    this.jucasServices = jucasServices;
  }
  
  /**
   * gets the JucasServices instance associated with this IJucasBean
   * @return JucasServices
   */
  protected JucasServices getJucasServices(){
    return this.jucasServices;
  }

  /**
   * @see java.lang.Object#toString()
   */
  public String toString()
  {
    return "IJucasBean class: "+this.getClass().getName() +" BeanName: "+this.getBeanName().toString();
  }



}