/* ======================================================================
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.events;

import java.io.PrintWriter;
import java.text.MessageFormat;
import java.util.ResourceBundle;

import org.bodington.server.BuildingServerException;
import org.bodington.server.resources.Resource;
import org.bodington.util.IntStringEnum;

/**
 * Class to track changes to a resource.
 * Although it doesn't define any new intance variables we subclass event to
 * keep Event clean of constants.
 * @author buckett
 */
public class ResourceEvent extends Event
{
    private static ResourceBundle resourceBundle = ResourceBundle
    .getBundle(ResourceEvent.class.getName());
    
    public static final ResourceEventType EVENT_CREATE = new ResourceEventType("event.create");
    public static final ResourceEventType EVENT_EDIT = new ResourceEventType("event.edit");
    public static final ResourceEventType EVENT_DELETE = new ResourceEventType("event.delete");
    public static final ResourceEventType EVENT_RESTORE = new ResourceEventType("event.restore");
    
    public static class ResourceEventType extends IntStringEnum
    {
        protected ResourceEventType(String name)
        {
            super(name, ResourceEventType.class);
        }
        
        public static ResourceEventType getMapping(int index)
        {
            return (ResourceEventType)getConst(index,ResourceEventType.class);
        }
        
        public static ResourceEventType getMapping(String name)
        {
            return (ResourceEventType)getConst(name, ResourceEventType.class);
        }
        
    }
    
    /**
     * Empty constructor used by the database layer.
     */
    public ResourceEvent()
    {
        super();
    }
    
    /**
     * Create an event about a resource.
     * @param type The type of event.
     * @param resource The resource to which the event pertains.
     */
    public ResourceEvent(ResourceEventType type, Resource resource)
    {
        setEventCode(type.getId());
        setResource(resource);
        setImportance(Event.IMPORTANCE_USER_MIN);
    }
    
    public String messageTitle()
    {
        String params[] = { "Someone" };
        return MessageFormat.format(resourceBundle
            .getString(ResourceEventType.getMapping(event_code).getName()),
            params);
    }
    
    public void printMessage(PrintWriter out, boolean html)
    {
        Object params[] = { "Someone" };
        try
        {
            params[0] = getActiveUser();
        }
        catch (BuildingServerException bse)
        {}
        out.write(MessageFormat.format(resourceBundle
            .getString(ResourceEventType.getMapping(event_code).getName()),
            params));
    }
}