/* ======================================================================
The Bodington System Software License, Version 1.0

Copyright (c) 2001 The University of Leeds.  All rights reserved.

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 acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO
EVENT SHALL THE UNIVERSITY OF LEEDS OR ITS 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.
=========================================================

This software was originally created by the University of Leeds and may contain voluntary
contributions from others.  For more information on the Bodington Open Source Project, please
see http://bodington.org/

====================================================================== */

package org.bodington.server.resources;

import java.util.Enumeration;
import org.bodington.database.PrimaryKey;
import org.bodington.server.BuildingServerException;
import org.bodington.server.BuildingServer;
import org.bodington.server.resources.Resource;

/**
 * Class that encapsulates a quicklink. This is a tool that allows a user to
 * create a link to external websites and internal Bodington resources. In the
 * latter case the <code>resourceId</code> property is stored and converted
 * back to a URL so that the link can be maintained when the resource is moved.
 * If the resource is deleted (i.e. put in the recycling building) a warning is
 * given.
 * @author Antony Corfield
 */
public class QuickLink extends Resource
{
    private PrimaryKey quick_link_id, resource_id_link;
    private String url;
    private byte link_flags;

    public Class sessionClass()
    {
        return org.bodington.server.resources.QuickLinkSessionImpl.class;
    }

    public int getResourceType()
    {
        return RESOURCE_QUICKLINK;
    }

    public static QuickLink findQuickLink( PrimaryKey key )
        throws BuildingServerException
    {
        return (QuickLink)findPersistentObject( key,
            "org.bodington.server.resources.QuickLink" );
    }

    public static Enumeration findQuickLinks( String where )
        throws BuildingServerException
    {
        return findPersistentObjects( where,
            "org.bodington.server.resources.QuickLink" );
    }

    public static Enumeration findQuickLinks( String where, String order )
        throws BuildingServerException
    {
        return findPersistentObjects( where, order,
            "org.bodington.server.resources.QuickLink" );
    }

    public PrimaryKey getPrimaryKey()
    {
        return getQuickLinkId();
    }

    public void setPrimaryKey( PrimaryKey key )
    {
        setQuickLinkId( key );
    }

    public PrimaryKey getQuickLinkId()
    {
        return quick_link_id;
    }

    public void setQuickLinkId( PrimaryKey key )
    {
        quick_link_id = key;
        setResourceId( key );
        setUnsaved();
    }

    /**
     * Indicates whether or not this is a Bodington URL. A Bodington URL is one
     * that links to an internal resource. A useful feature of these is that if
     * the resource moves, the link is still valid.
     * @return <code>true</code> if this is a Bodington URL, otherwise
     *         <code>false</code>.
     */
    public boolean isBodURL()
    {
        return resource_id_link != null;
    }

    /**
     * Get the URL. This is the URL which is encapsulated by instances of this
     * class.
     * @return the URL.
     */
    public String getURL()
    {
        return url;
    }

    /**
     * Set the URL. This is the URL which is encapsulated by instances of this
     * class.
     * @param s the URL.
     */
    public void setURL( String s )
    {
        if ( s == null && url == null ) return;
        if ( s != null && url != null && s.equals( url ) ) return;

        url = s;
        setUnsaved();
    }
    
    /**
     * Get the URL. This is the URL which is encapsulated by instances of this
     * class.
     * @return the URL.
     * @deprecated Use {@link #getURL()} instead.
     */
    public String getUrl()
    {
        return getURL();
    }

    /**
     * Set the URL. This is the URL which is encapsulated by instances of this
     * class.
     * @param s the URL.
     * @deprecated Use {@link #setURL(String)} instead.
     */
    public void setUrl( String s )
    {
        setURL( s );
    }
    
    public PrimaryKey getResourceIdLink()
    {
        return resource_id_link;
    }

    public void setResourceIdLink( PrimaryKey resId )
    {
        if ( resId == null && resource_id_link == null ) return;
        if ( resId != null && resource_id_link != null
            && resId.equals( resource_id_link ) ) return;

        resource_id_link = resId;
        setUnsaved();
    }

    public void setNewWindow( boolean newWindow )
    {
        setLinkFlags( newWindow ? (byte)1 : (byte)0 );
    }

    /**
     * Indicates whether the target of the URL will open in a new browser
     * window.
     * @return <code>true</code> if the target of the URL will open in a new
     *         browser window, otherwise <code>false</code>.
     */
    public boolean isNewWindow()
    {
        return getLinkFlags() == (byte)1;
    }

    public byte getLinkFlags()
    {
        return link_flags;
    }

    public void setLinkFlags( byte f )
    {
        if ( f == link_flags ) return;
        link_flags = f;
        setUnsaved();
    }
}