org.xmldb.api.base

Interface Service

public interface Service extends Configurable

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: XPathQueryService

Method Summary
StringgetName()
Returns the name associated with the Service instance.
StringgetVersion()
Gets the Version attribute of the Service object
voidsetCollection(Collection col)
Sets the Collection attribute of the Service object

Method Detail

getName

public String 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

public String 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

public void setCollection(Collection col)
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.