Package org.xmldb.api.modules
Interface CollectionManagementService
- All Superinterfaces:
Configurable
,Service
- All Known Implementing Classes:
CollectionManagementServiceImpl
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.-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptioncreateCollection
(String name) Creates a newCollection
in the database.void
removeCollection
(String name) Removes a namedCollection
from the system.Methods inherited from interface org.xmldb.api.base.Configurable
getProperty, setProperty
Methods inherited from interface org.xmldb.api.base.Service
getName, getVersion, setCollection
-
Field Details
-
SERVICE_NAME
- See Also:
-
-
Method Details
-
createCollection
Creates a newCollection
in the database. The default configuration of the database is determined by the implementer. The newCollection
will be created relative to theCollection
from which theCollectionManagementService
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
Removes a namedCollection
from the system. The name for theCollection
to remove is relative to theCollection
from which theCollectionManagementService
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.
-