Resource.java

/*
 * This is a common dao with basic CRUD operations and is not limited to any 
 * persistent layer implementation
 * 
 * Copyright (C) 2008  Imran M Yousuf (imyousuf@smartitengineering.com)
 * 
 * This library 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 3 of the License, or (at your option) any later version.
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package com.smartitengineering.version.api;

/**
 * Resource represents an object intended to versioned.
 * @author imyousuf
 */
public interface Resource extends Content {

    /**
     * Retrieves the id of the resource using which the resource can be uniquely
     * identified.
     * @return Unique identifier of the resource
     */
    public String getId();

    /**
     * Returns whether the resource is deleted or not
     * @return True iff deleted
     */
    public boolean isDeleted();

    /**
     * Returns the MIME type of the resource.
     * @return MIME type - could be NULL if user does not set one
     */
    public String getMimeType();
}