org.apache.cocoon.components.repository.helpers
Interface RepositoryPropertyHelper

All Known Implementing Classes:
WebDAVRepositoryPropertyHelper

public interface RepositoryPropertyHelper

A property helper interface intended to be used by flowscripts or corresponding wrapper components.


Method Summary
 List getAllProperties(String uri)
          get all properties
 Map getProperties(String uri, Set propNames)
          get multiple properties
 SourceProperty getProperty(String uri, String name, String namespace)
          get a single property
 boolean setProperties(String uri, Map properties)
          set multiple properties
 boolean setProperty(String uri, String name, String namespace, Node value)
          set a single property to a W3C Node value
 boolean setProperty(String uri, String name, String namespace, String value)
          set a single property to a String value
 

Method Detail

getProperty

SourceProperty getProperty(String uri,
                           String name,
                           String namespace)
                           throws ProcessingException
get a single property

Parameters:
uri - the uri of the resource.
name - the name of the property.
namespace - the namespace of the property.
Returns:
the property.
Throws:
ProcessingException

getProperties

Map getProperties(String uri,
                  Set propNames)
                  throws ProcessingException
get multiple properties

Parameters:
uri - the uri of the resource.
propNames - a Set containing the property names.
Returns:
a Map containing the property values.
Throws:
ProcessingException

getAllProperties

List getAllProperties(String uri)
                      throws ProcessingException
get all properties

Parameters:
uri - the uri of the resource.
Returns:
a List containing the property values.
Throws:
ProcessingException

setProperty

boolean setProperty(String uri,
                    String name,
                    String namespace,
                    String value)
                    throws ProcessingException
set a single property to a String value

Parameters:
uri - the uri of the resource.
name - the name of the property.
namespace - the namespace of the property.
value - the String value to set the property to.
Returns:
a boolean indicating success.
Throws:
ProcessingException

setProperty

boolean setProperty(String uri,
                    String name,
                    String namespace,
                    Node value)
                    throws ProcessingException
set a single property to a W3C Node value

Parameters:
uri - the uri of the resource.
name - the name of the property.
namespace - the namespace of the property.
value - the DOM value to set the property to.
Returns:
a boolean indicating success.
Throws:
ProcessingException

setProperties

boolean setProperties(String uri,
                      Map properties)
                      throws ProcessingException
set multiple properties

Parameters:
uri - the uri of the resource.
properties - a Map containing the properties to set.
Returns:
a boolean indicating success.
Throws:
ProcessingException


Copyright © 1999-2010 The Apache Software Foundation. All Rights Reserved.