java.fedora.server.storage.DOWriter Maven / Gradle / Ivy

Go to download
/*
 * -----------------------------------------------------------------------------
 *
 * License and Copyright: The contents of this file are subject to the
 * Apache 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.fedora-commons.org/licenses.
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
 * the specific language governing rights and limitations under the License.
 *
 * The entire file consists of original code.
 * Copyright © 2008 Fedora Commons, Inc.

 * 
Copyright © 2002-2007 The Rector and Visitors of the University of 
 * Virginia and Cornell University
 
 * All rights reserved.
 *
 * -----------------------------------------------------------------------------
 */
package fedora.server.storage;

import java.util.Date;

import fedora.server.errors.ServerException;
import fedora.server.storage.types.Datastream;
import fedora.server.storage.types.Disseminator;

/**
 *
 * Title: DOWriter.java
 * Description: The standard interface for write operations on a
 * digital object.
 *
 * A DOWriter instance is a handle on a Fedora digital object,
 * and is obtained via a getWriter(String) call on a
 * DOManager.
 *
 * Call save() to save changes while working with a DOWriter, where the
 * DOWriter handle may be lost but the changes need to be remembered.
 *
 * Work with a DOWriter ends with either commit() or cancel().
 *
 * @author [email protected]
 * @version $Id: DOWriter.java 5351 2006-12-07 13:04:02Z rlw $
 */
public interface DOWriter
        extends DOReader {

    /**
     * Sets the state of the entire digital object.
     *
     * @param state The state.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void setState(String state) throws ServerException;

    /**
     * Sets the ownerId for the digital object.
     *
     * @param ownerId The ownerId.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void setOwnerId(String ownerId) throws ServerException;    
    
    /**
     * Sets the state for all versions of the specified datastream.
     *
     * @param id The datastream id.
     * @param state The state.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void setDatastreamState(String id, String state) throws ServerException;

	/**
	 * Sets the indicator as to whether the datastream is subject to versioning.
	 * In Fedora 2.0, the system will not operate on this indicator and all
	 * datastreams will be versioned by default.  
	 *
	 * @param id The datastream id.
	 * @param versionable a boolean indicating if versionable
	 * @throws ServerException If any type of error occurred fulfilling the
	 *         request.
	 */    
    public void setDatastreamVersionable(String id, boolean versionable) throws ServerException;    

    /**
     * Sets the state for all versions of the specified disseminator.
     *
     * @param id The disseminator id.
     * @param state The state.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void setDisseminatorState(String id, String state) throws ServerException;

    /**
     * Sets the label of the digital object.
     *
     * @param label The label.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void setLabel(String label) throws ServerException;

    /**
     * Removes the entire digital object.
     *
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void remove() throws ServerException;

    /**
     * Adds a datastream to the object.
     *
     * @param datastream The datastream.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void addDatastream(Datastream datastream, boolean addNewVersion) throws ServerException;

    /**
     * Adds a disseminator to the object.
     *
     * @param disseminator The disseminator.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void addDisseminator(Disseminator disseminator)
            throws ServerException;

    /**
     * Removes a range of datastream versions from an object without leaving
     * anything behind.  If any integrity checks need to be done, they should
     * be done outside of this code.
     *
     * @param id The id of the datastream.
     * @param start The start date (inclusive) of versions to remove.  If
     *        null, this is taken to be the smallest possible
     *        value.
     * @param end The end date (inclusive) of versions to remove.  If
     *        null, this is taken to be the greatest possible
     *        value.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public Date[] removeDatastream(String id, Date start, Date end)
            throws ServerException;

    /**
     * Removes a range of disseminator versions from an object without leaving
     * anything behind.  If any integrity checks need to be done, they should
     * be done outside of this code.
     *
     * @param id The id of the datastream.
     * @param start The start date (inclusive) of versions to remove.  If
     *        null, this is taken to be the smallest possible
     *        value.
     * @param end The end date (inclusive) of versions to remove.  If
     *        null, this is taken to be the greatest possible
     *        value.
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public Date[] removeDisseminator(String id, Date start, Date end)
            throws ServerException;

    /**
     * Saves the changes thus far to the permanent copy of the digital object.
     *
     * @param logMessage An explanation of the change(s).
     * @throws ServerException If any type of error occurred fulfilling the
     *         request.
     */
    public void commit(String logMessage) throws ServerException;

    /**
     * Marks this DOWriter handle invalid (unusable).
     */
    public void invalidate();

    /**
     * Generate a unique id for a datastream.
     */
    public String newDatastreamID();

    /**
     * Generate a unique id for a datastream version.
     */
    public String newDatastreamID(String dsID);

    /**
     * Generate a unique id for a disseminator.
     */
    public String newDisseminatorID();

    /**
     * Generate a unique id for a disseminator version.
     */
    public String newDisseminatorID(String dissID);

    /**
     * Generate a unique id for a datastreamBindingMap.
     */
    public String newDatastreamBindingMapID();

    /**
     * Generate a unique id for an audit record.
     */
    public String newAuditRecordID();
    
    /**
     * Marks whether the object has been successfully committed.
     */
    public boolean isCommitted();
    
    /**
     * Marks whether the object is new.
     */
    public boolean isNew();

}