ReviewHelperBean.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/rwiki/trunk/rwiki-tool/tool/src/java/uk/ac/cam/caret/sakai/rwiki/tool/bean/helper/ReviewHelperBean.java $
 * $Id: ReviewHelperBean.java 20354 2007-01-17 10:30:57Z ian@caret.cam.ac.uk $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
 *
 * Licensed under the Educational Community License, Version 1.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.opensource.org/licenses/ecl1.php
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 **********************************************************************************/

package uk.ac.cam.caret.sakai.rwiki.tool.bean.helper;

import javax.servlet.ServletRequest;

import uk.ac.cam.caret.sakai.rwiki.service.api.RWikiObjectService;
import uk.ac.cam.caret.sakai.rwiki.service.api.model.RWikiObject;
import uk.ac.cam.caret.sakai.rwiki.tool.bean.HistoryBean;

/**
 * Bean which will create a mock RWikiObject with the content set to the content
 * of a requested revision
 * 
 * @author andrew
 */
public class ReviewHelperBean
{

	/**
	 * SerlvetRequest to get revision details from
	 */
	private ServletRequest request;

	/**
	 * the real rwikiObject
	 */
	private RWikiObject rwikiObject;

	private RWikiObjectService rwikiObjectService;

	/**
	 * the mock rwikiObject
	 */
	private RWikiObject mock;

	/**
	 * the revision number of the mock
	 */
	private int interestedRevision;

	/**
	 * Initialize the bean by setting the interested revision from the request
	 * and creating the mock.
	 */
	public void init()
	{
		if (request != null)
		{
			interestedRevision = Integer.parseInt(request
					.getParameter(HistoryBean.REVISION_PARAM));
		}

		if (interestedRevision == rwikiObject.getRevision().intValue())
		{
			mock = rwikiObject;
		}
		else
		{
			mock = rwikiObjectService.getRWikiHistoryObject(rwikiObject,
					interestedRevision);
		}
	}

	/**
	 * Set the current request
	 * 
	 * @param servletRequest
	 */
	public void setServletRequest(ServletRequest servletRequest)
	{
		this.request = servletRequest;
	}

	/**
	 * Get the associated real rwikiObject
	 * 
	 * @return the associated real rwikiObject
	 */
	public RWikiObject getRwikiObject()
	{
		return rwikiObject;
	}

	/**
	 * Set the real rwikiObject
	 * 
	 * @param rwikiObject
	 *        the real object
	 */
	public void setRwikiObject(RWikiObject rwikiObject)
	{
		this.rwikiObject = rwikiObject;
	}

	/**
	 * Get the requested interestedRevision
	 * 
	 * @return revision number of the mock
	 */
	public int getInterestedRevision()
	{
		return interestedRevision;
	}

	/**
	 * Set the interestedRevision of the mock
	 * 
	 * @param interestedRevision
	 *        the interestedRevision to set
	 */
	public void setInterestedRevision(int interestedRevision)
	{
		this.interestedRevision = interestedRevision;
	}

	/**
	 * Get the mock rwikiObject
	 * 
	 * @return the mock rwikiObject
	 */
	public RWikiObject getMock()
	{
		return mock;
	}

	/**
	 * Set the mock rwikiObject
	 * 
	 * @param mock
	 *        object to set
	 */
	public void setMock(RWikiObject mock)
	{
		this.mock = mock;
	}

	public RWikiObjectService getRwikiObjectService()
	{
		return rwikiObjectService;
	}

	public void setRwikiObjectService(RWikiObjectService rwikiObjectService)
	{
		this.rwikiObjectService = rwikiObjectService;
	}
}