DoubleStorageUser.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/kernel/trunk/kernel-util/src/main/java/org/sakaiproject/util/StorageUser.java $
 * $Id: StorageUser.java 74692 2010-03-16 13:58:08Z david.horwitz@uct.ac.za $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2008 Sakai Foundation
 *
 * Licensed under the Educational Community License, Version 2.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/ECL-2.0
 *
 * 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 org.sakaiproject.util;

import org.sakaiproject.entity.api.Edit;
import org.sakaiproject.entity.api.Entity;
import org.sakaiproject.time.api.Time;
import org.w3c.dom.Element;

/**
 * This interface extends SingleStorageUser but adds the methods to do with 
 * containers for the resources. It is basically the same as 
 * StorageUser, but putting this in a new interface makes it easier to 
 * refactor existing code.
 *
 */
public interface DoubleStorageUser extends SingleStorageUser {

	/**
	 * Construct a new container given just ids.
	 * 
	 * @param ref
	 *        The container reference.
	 * @return The new container Resource.
	 */
	Entity newContainer(String ref);

	/**
	 * Construct a new container resource, from an XML element.
	 * 
	 * @param element
	 *        The XML.
	 * @return The new container resource.
	 */
	Entity newContainer(Element element);

	/**
	 * Construct a new container resource, as a copy of another
	 * 
	 * @param other
	 *        The other container to copy.
	 * @return The new container resource.
	 */
	Entity newContainer(Entity other);

	/**
	 * Construct a new container given just ids.
	 * 
	 * @param ref
	 *        The container reference.
	 * @return The new container Resource.
	 */
	Edit newContainerEdit(String ref);

	/**
	 * Construct a new container resource, from an XML element.
	 * 
	 * @param element
	 *        The XML.
	 * @return The new container resource.
	 */
	Edit newContainerEdit(Element element);

	/**
	 * Construct a new container resource, as a copy of another
	 * 
	 * @param other
	 *        The other container to copy.
	 * @return The new container resource.
	 */
	Edit newContainerEdit(Entity other);

	/**
	 * Access the resource owner user id.
	 * 
	 * @param r
	 *        The resource.
	 * @return The resource owner user id.
	 */
	String getOwnerId(Entity r);

	/**
	 * Check if this resource is in draft mode.
	 * 
	 * @param r
	 *        The resource.
	 * @return true if the resource is in draft mode, false if not.
	 */
	boolean isDraft(Entity r);

	/**
	 * Access the resource date.
	 * 
	 * @param r
	 *        The resource.
	 * @return The resource date.
	 */
	Time getDate(Entity r);
}