org.xmldb.api.modules
Interface CollectionManagementService
- All Superinterfaces:
- Configurable, Service
public interface CollectionManagementService
- extends Service
CollectionManagementService is a Service
that enables the basic
management of collections within a database. The functionality provided is
very basic because collection management varies widely among databases. This
service simply provides functionality for those databases that are able
to implement this basic functionality.
SERVICE_NAME
static final java.lang.String SERVICE_NAME
- See Also:
- Constant Field Values
createCollection
Collection createCollection(java.lang.String name)
throws XMLDBException
- 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.
- Parameters:
name
- 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.
removeCollection
void removeCollection(java.lang.String name)
throws XMLDBException
- 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.
- Parameters:
name
- The name of the collection to remove.
- Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor
specific errors that occur.