ozoneinterface.java

Java的面向对象数据库系统的源代码

// You can redistribute this software and/or modify it under the terms of
// the Ozone Library License version 1 published by ozone-db.org.
//
// The original code and portions created by SMB are
// Copyright (C) 1997-@year@ by SMB GmbH. All rights reserved.
//
// $Id: OzoneInterface.java,v 1.12 2003/04/06 13:57:32 mediumnet Exp $

package org.ozoneDB;

import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.xml.sax.ContentHandler;


/**
 * Together with {@link ExternalTransaction} and {@link OzoneCompatible} this
 * interface represents the basic API of the ozone database system.
 *
 *
 * @author <a href="http://www.softwarebuero.de/">SMB</a>
 * @author <a href="http://www.medium.net/">Medium.net</a>
 * @version $Revision: 1.12 $Date: 2003/04/06 13:57:32 $
 */
public interface OzoneInterface {

    /** Object access right. */
    public final static int Private = 0;

    /** Object access right. */
    public final static int AllRead = 1;

    /** Object access right. */
    public final static int AllLock = 2;

    /** Object access right. */
    public final static int GroupRead = 4;

    /** Object access right. */
    public final static int GroupLock = 8;

    /** Object access right. Combines {@link #AllRead} and {@link #AllLock}. */
    public final static int Public = AllRead | AllLock;


    /**
     * Creates a database object of the specified class without a name and with
     * default permissions.
     *
     *
     * @param className The fully qualified name of the class.
     * @return A proxy object for the newly created object.
     * @throws org.ozoneDB.OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(String className) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates a database object of the specified class without a name and with
     * the specified access rights.
     *
     *
     * @param className The fully qualified name of the class.
     * @param access The access rights (ORed).
     * @return proxy A proxy object for the newly created database object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(String className,int access) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates a database object of the specified class with the specified name
     * and the specified access rights.
     *
     *
     * @param className The fully qualified name of the class.
     * @param access The access right. (ORed)
     * @param objName The name of the object. (optional)
     * @return A proxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(String className,int access,String objName) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates an object by calling the constructor with the specified
     * signature with the specified parameters. Generated proxy objects use
     * this method.<p>
     *
     *
     * @param className fully qualified name of the class
     * @param access access right (ORed)
     * @param objName name of the object (optional
     * @param sig The signature string of the constructor.
     * @param args The parameter that are passed to the constructor.
     * @return proxy A OzoneProxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(String className,int access,String objName,String sig,Object[] args) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates an object by calling the constructor with the specified
     * signature with the specified parameters and default permissions.
     *
     *
     * @param className fully qualified name of the class
     * @param sig The signature string of the constructor.
     * @param args The parameter that are passed to the constructor.
     * @return proxy A OzoneProxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject( String className, String sig, Object[] args) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates a database object of the specified class without a name and with
     * default permissions.
     *
     *
     * @param type the type of the object to be created
     * @return A proxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(Class type) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates a database object of the specified class without a name and with
     * the specified access rights.
     *
     *
     * @param type the type of the object to be created
     * @param access The access rights (ORed).
     * @return proxy A proxy object for the newly created database object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(Class type, int access ) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates a database object of the specified class with the specified name
     * and the specified access rights.
     *
     *
     * @param type the type of the object to be created
     * @param access The access right. (ORed)
     * @param objName The name of the object. (optional)
     * @return A proxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(Class type, int access, String objName ) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates an object by calling the constructor with the specified
     * signature with the specified parameters. Generated proxy objects use
     * this method.<p>
     *
     *
     * @param type the type of the object to be created
     * @param access access right (ORed)
     * @param objName name of the object (optional
     * @param sig An array of signature params for the constructor in question.
     * @param args The parameter that are passed to the constructor.
     * @return proxy A OzoneProxy object for the newly created object.
     * @throws OzoneRemoteException (or one of its sub-classes) to signal a
     * ozone related problem.
     * @throws RuntimeException To signal an implementation specific problem,
     * such as {@link java.io.IOException}
     */
    public OzoneProxy createObject(Class type, int access, String objName, Class[] sig, Object[] args) throws RuntimeException, OzoneRemoteException;


    /**
     * Creates an object by calling the constructor with the specified
     * signature with the specified parameters and default permissions.
     *
     *
     * @param type the type of the object to be created
     * @param sig An array of signature params for the constructor in question.