org.apache.cocoon.components.source
Interface SourceDescriptor

All Superinterfaces:
SourceInspector
All Known Implementing Classes:
AbstractConfigurableSourceDescriptor, SimpleJdbcSourceDescriptor, SourceDescriptorManager

public interface SourceDescriptor
extends SourceInspector

A source descriptor handles modifiable source properties.

Author:
Unico Hommes

Field Summary
static String ROLE
           
 
Method Summary
 void removeSourceProperty(Source source, String namespace, String name)
          Remove a property from a Source.
 void setSourceProperty(Source source, SourceProperty property)
          Set a property on a Source.
 
Methods inherited from interface org.apache.cocoon.components.source.SourceInspector
getSourceProperties, getSourceProperty, getValidity, handlesProperty
 

Field Detail

ROLE

public static final String ROLE
Method Detail

setSourceProperty

public void setSourceProperty(Source source,
                              SourceProperty property)
                       throws SourceException
Set a property on a Source.

Parameters:
source - the Source to set the SourceProperty on
property - the SourceProperty to set
Throws:
SourceException

removeSourceProperty

public void removeSourceProperty(Source source,
                                 String namespace,
                                 String name)
                          throws SourceException
Remove a property from a Source.

Parameters:
source - the Source to remove the property from
namespace - namespace identifier of the property to remove
name - name of the property to remove
Throws:
SourceException


Copyright ? 1999-2005 The Apache Software Foundation. All Rights Reserved.