org.globus.wsrf
Interface ResourcePropertySet

All Known Implementing Classes:

SimpleResourcePropertySet

public interface ResourcePropertySet

This interface defines the API used to access a collection of resource property contained in a resource.

Method Summary

boolean	add(ResourceProperty property) Adds a resource property to the set and makes it available to queries and subscriptions, etc.
void	clear() Removes all resource properties.
ResourceProperty	create(ResourcePropertyMetaData rpMetaData) Creates a resource property entry with the specified meta data.
ResourceProperty	get(javax.xml.namespace.QName propName) Retrieves a resource property.
javax.xml.namespace.QName	getName() Returns the element name of the entire resource properties document.
boolean	isEmpty() Returns true if the set has at least one resource property.
boolean	isOpenContent() Indicates if the resource property set allows adding of new arbitrary resource property elements.
java.util.Iterator	iterator() Returns an iterator over ResourceProperty entries.
boolean	remove(javax.xml.namespace.QName propName) Removes a resource property.
int	size() Returns the number of resource properties this set contains.
org.w3c.dom.Element	toElement() Returns the entire Resource Property document as a DOM Element.
javax.xml.soap.SOAPElement	toSOAPElement() Returns the entire Resource Property document as a SOAPElement.

Method Detail

add

public boolean add(ResourceProperty property)

Adds a resource property to the set and makes it available to queries and subscriptions, etc.

Parameters:

property - the ResourceProperty to add.

Returns:

true if property was successfully added, false otherwise.

remove

public boolean remove(javax.xml.namespace.QName propName)

Removes a resource property.

Parameters:

propName - the name of the ResourceProperty to remove.

Returns:

true if property was successfully removed, false otherwise.

get

public ResourceProperty get(javax.xml.namespace.QName propName)

Retrieves a resource property.

Parameters:

propName - the name of the ResourceProperty to retrieve.

Returns:

the ResourceProperty that was retrieved. Null if the property does not exist.

create

public ResourceProperty create(ResourcePropertyMetaData rpMetaData)

Creates a resource property entry with the specified meta data. Note the resource property is not added to the set (and thus not target to queries or subscriptions)until the add method is called.

iterator

public java.util.Iterator iterator()

Returns an iterator over ResourceProperty entries.

Returns:

an iterator over ResourceProperty entries.

clear

public void clear()

Removes all resource properties.

size

public int size()

Returns the number of resource properties this set contains.

Returns:

the number of resource properties contained.

isEmpty

public boolean isEmpty()

Returns true if the set has at least one resource property.

Returns:

true if the set has at least one resource property. False, otherwise.

isOpenContent

public boolean isOpenContent()

Indicates if the resource property set allows adding of new arbitrary resource property elements.

Returns:

true if adding new resource property elements is allowed. False otherwise. Please note that isOpenContent might return true but only certain subset of resource properties will be allowed to be added.

getName

public javax.xml.namespace.QName getName()

Returns the element name of the entire resource properties document.

Returns:

the element name of the entire resource properties document.

toSOAPElement

public javax.xml.soap.SOAPElement toSOAPElement()
                                         throws SerializationException

Returns the entire Resource Property document as a SOAPElement.

Throws:

SerializationException

toElement

public org.w3c.dom.Element toElement()
                              throws SerializationException

Returns the entire Resource Property document as a DOM Element.

Throws:

SerializationException