Creatable.java

/*
 *  Weblounge: Web Content Management System
 *  Copyright (c) 2003 - 2011 The Weblounge Team
 *  http://entwinemedia.com/weblounge
 *
 *  This program is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public License
 *  as published by the Free Software Foundation; either version 2
 *  of the License, or (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public License
 *  along with this program; if not, write to the Free Software Foundation
 *  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */

package ch.entwine.weblounge.common.content;

import ch.entwine.weblounge.common.security.User;

import java.util.Date;

/**
 * A <code>Creatable</code> describes objects that have a creator and a creation
 * date.
 * <p>
 * Prominent examples of such an object are pages or binary resources.
 */
public interface Creatable {

  /**
   * Sets the creation date.
   * 
   * @param date
   *          the creation date
   */
  void setCreationDate(Date date);

  /**
   * Sets the user that created the object.
   * 
   * @param user
   *          the creator
   */
  void setCreator(User user);
  
  /**
   * Returns the object's creation date.
   * 
   * @return the creation date
   */
  Date getCreationDate();

  /**
   * Returns <code>true</code> if this context was created after the given date.
   * 
   * @param date
   *          the date to compare to
   * @return <code>true</code> is this context was created after the given date
   */
  boolean isCreatedAfter(Date date);

  /**
   * Returns the user that created the object.
   * 
   * @return the creator
   */
  User getCreator();

}