org.exist.xmldb.EXistCollection Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation

eXist-db NoSQL Database Core

There is a newer version: 6.3.0

/*
 * eXist Open Source Native XML Database
 *   
 * Copyright (C) 2001-04 Wolfgang M. Meier [email protected]
 * 
 * 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 * 
 * $Id$
 */
package org.exist.xmldb;

import java.util.Date;

import org.xmldb.api.base.Collection;
import org.xmldb.api.base.Resource;
import org.xmldb.api.base.XMLDBException;

/**
 * This interface extends org.xmldb.api.base.Collection with extensions specific to eXist.
 */
public interface EXistCollection extends Collection {

    boolean isRemoteCollection() throws XMLDBException;

    /**
     * Returns the time of creation of the collection.
     *
     * @return the creation time
     *
     * @throws XMLDBException if an error occurs whilst retrieving the creation time.
     */
    Date getCreationTime() throws XMLDBException;

    /**
     * Alternative methods, especially to be used from JSP.
     *
     * @return the child collections.
     *
     * @throws XMLDBException if an error occurs whilst retrieving the child collections.
     */
    String[] getChildCollections() throws XMLDBException;

    String[] getResources() throws XMLDBException;

    void storeResource(Resource res, Date a, Date b) throws XMLDBException;

    XmldbURI getPathURI();

}