org.xmldb.api.base
Interface Configurable

All Known Subinterfaces:
Collection, CollectionManagementService, Database, Service, TransactionService, XPathQueryService
All Known Implementing Classes:
AbstractConfigurable, CollectionImpl, CollectionManagementServiceImpl, DatabaseImpl

public interface Configurable

Provides the ability to configure properties about an object.


Method Summary
 java.lang.String getName()
          Returns the name associated with the Configurable object.
 java.lang.String getProperty(java.lang.String name)
          Returns the value of the property identified by name.
 void setProperty(java.lang.String name, java.lang.String value)
          Sets the property name to have the value provided in value.
 

Method Detail

getName

public java.lang.String getName()
                         throws XMLDBException
Returns the name associated with the Configurable object.

Returns:
the name of the object.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

getProperty

public java.lang.String getProperty(java.lang.String name)
                             throws XMLDBException
Returns the value of the property identified by name.

Parameters:
name - the name of the property to retrieve.
Returns:
the property value or null if no property exists.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.String value)
                 throws XMLDBException
Sets the property name to have the value provided in value.

Parameters:
name - the name of the property to set.
value - the value to set for the property.
Throws:
XMLDBException - with expected error codes.
ErrorCodes.VENDOR_ERROR for any vendor specific errors that occur.


Copyright © 2002 The Ozone Database Project - www.ozone-db.org. All Rights Reserved.