org.exist.xmldb
Interface CollectionManagementServiceImpl

All Superinterfaces:
CollectionManagementService, Configurable, Service
All Known Implementing Classes:
LocalCollectionManagementService, RemoteCollectionManagementService

public interface CollectionManagementServiceImpl
extends CollectionManagementService

Extends the CollectionManagementService interface with extensions specific to eXist, in particular moving and copying collections and resources.

Author:
wolf

Field Summary
 
Fields inherited from interface org.xmldb.api.modules.CollectionManagementService
SERVICE_NAME
 
Method Summary
 void copy(String collection, String destination, String newName)
          Deprecated. Use XmldbURI version instead
 void copy(XmldbURI collection, XmldbURI destination, XmldbURI newName)
           
 void copyResource(String resourcePath, String destinationPath, String newName)
          Deprecated. Use XmldbURI version instead
 void copyResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName)
           
 Collection createCollection(String collName)
          Deprecated. Use XmldbURI version instead
 Collection createCollection(String collName, Date created)
          Deprecated. Use XmldbURI version instead
 Collection createCollection(XmldbURI collName)
           
 Collection createCollection(XmldbURI collName, Date created)
           
 void move(String collection, String destination, String newName)
          Deprecated. Use XmldbURI version instead
 void move(XmldbURI collection, XmldbURI destination, XmldbURI newName)
           
 void moveResource(String resourcePath, String destinationPath, String newName)
          Deprecated. Use XmldbURI version instead
 void moveResource(XmldbURI resourcePath, XmldbURI destinationPath, XmldbURI newName)
           
 void removeCollection(String collName)
          Deprecated. Use XmldbURI version instead
 void removeCollection(XmldbURI collName)
           
 
Methods inherited from interface org.xmldb.api.base.Service
getName, getVersion, setCollection
 
Methods inherited from interface org.xmldb.api.base.Configurable
getProperty, setProperty
 

Method Detail

move

void move(String collection,
          String destination,
          String newName)
          throws XMLDBException
Deprecated. Use XmldbURI version instead

Throws:
XMLDBException

moveResource

void moveResource(String resourcePath,
                  String destinationPath,
                  String newName)
                  throws XMLDBException
Deprecated. Use XmldbURI version instead

Throws:
XMLDBException

copyResource

void copyResource(String resourcePath,
                  String destinationPath,
                  String newName)
                  throws XMLDBException
Deprecated. Use XmldbURI version instead

Throws:
XMLDBException

copy

void copy(String collection,
          String destination,
          String newName)
          throws XMLDBException
Deprecated. Use XmldbURI version instead

Throws:
XMLDBException

createCollection

Collection createCollection(String collName,
                            Date created)
                            throws XMLDBException
Deprecated. Use XmldbURI version instead

Throws:
XMLDBException

move

void move(XmldbURI collection,
          XmldbURI destination,
          XmldbURI newName)
          throws XMLDBException
Throws:
XMLDBException

moveResource

void moveResource(XmldbURI resourcePath,
                  XmldbURI destinationPath,
                  XmldbURI newName)
                  throws XMLDBException
Throws:
XMLDBException

copyResource

void copyResource(XmldbURI resourcePath,
                  XmldbURI destinationPath,
                  XmldbURI newName)
                  throws XMLDBException
Throws:
XMLDBException

copy

void copy(XmldbURI collection,
          XmldbURI destination,
          XmldbURI newName)
          throws XMLDBException
Throws:
XMLDBException

createCollection

Collection createCollection(XmldbURI collName,
                            Date created)
                            throws XMLDBException
Throws:
XMLDBException

createCollection

Collection createCollection(String collName)
                            throws XMLDBException
Deprecated. Use XmldbURI version instead

Description copied from interface: CollectionManagementService
Creates a new Collection in the database. The default configuration of the database is determined by the implementer. The new Collection will be created relative to the Collection from which the CollectionManagementService was retrieved.

Specified by:
createCollection in interface CollectionManagementService
Parameters:
collName - The name of the collection to create.
Returns:
The created Collection instance.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

createCollection

Collection createCollection(XmldbURI collName)
                            throws XMLDBException
Throws:
XMLDBException

removeCollection

void removeCollection(String collName)
                      throws XMLDBException
Deprecated. Use XmldbURI version instead

Description copied from interface: CollectionManagementService
Removes a named Collection from the system. The name for the Collection to remove is relative to the Collection from which the CollectionManagementService was retrieved.

Specified by:
removeCollection in interface CollectionManagementService
Parameters:
collName - The name of the collection to remove.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

removeCollection

void removeCollection(XmldbURI collName)
                      throws XMLDBException
Throws:
XMLDBException


Copyright (C) Wolfgang Meier. All rights reserved.