Package org.xmldb.api.base
Interface Service
- All Superinterfaces:
Configurable
- All Known Subinterfaces:
CollectionManagementService
,TransactionService
,XPathQueryService
,XQueryService
,XUpdateQueryService
- All Known Implementing Classes:
CollectionManagementServiceImpl
,SimpleTransactionService
,SimpleXPathQueryService
,TransactionServiceImpl
,XPathQueryServiceImpl
The
Service
interface provides an extension mechanism for
Collection
implementations. It is to be implented by Service
instances that define their own set of methods to perform the necessary
action. For an example of what a functional Service
interface
should look like look at XPathQueryService.- See Also:
-
Method Summary
Modifier and TypeMethodDescriptiongetName()
Returns the name associated with the Service instance.Gets the Version attribute of the Service objectvoid
setCollection
(Collection col) Sets the Collection attribute of the Service objectMethods inherited from interface org.xmldb.api.base.Configurable
getProperty, setProperty
-
Method Details
-
getName
Returns the name associated with the Service instance.- Returns:
- the name of the object.
- Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor specific errors that occur.
-
getVersion
Gets the Version attribute of the Service object- Returns:
- The Version value
- Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor specific errors that occur.
-
setCollection
Sets the Collection attribute of the Service object- Parameters:
col
- The new Collection value- Throws:
XMLDBException
- with expected error codes.
ErrorCodes.VENDOR_ERROR
for any vendor specific errors that occur.
-