au.edu.archer.services.icat
Interface ExtendedData

All Known Implementing Classes:

ExistExtendedDataImpl, ExtendedDataWsClientImpl

public interface ExtendedData

This interface allows access to the extended data on objects (XML documents). Not all object types allow extended data.

Author:

Nigel Sim

Method Summary

org.w3c.dom.Document	getExtendedData(BaseDomain object, java.lang.String documentName) Gets the extended data document for the given object with the given document name.
java.util.List<java.lang.String>	listExtendedData(BaseDomain object) List the documents available (by name) for the given object.
void	removeExtendedData(BaseDomain object, java.lang.String documentName) Remove the document stored under the given object and document name.
void	updateExtendedData(BaseDomain object, java.lang.String documentName, org.w3c.dom.Document data) Update the document stored under the given object and name.

Method Detail

getExtendedData

org.w3c.dom.Document getExtendedData(BaseDomain object,
                                     java.lang.String documentName)
                                     throws ICATServiceException

Gets the extended data document for the given object with the given document name.

Parameters:

object -

name -

Returns:

Throws:

ICATServiceException

listExtendedData

java.util.List<java.lang.String> listExtendedData(BaseDomain object)
                                                  throws ICATServiceException

List the documents available (by name) for the given object.

Parameters:

object -

Returns:

Throws:

ICATServiceException

updateExtendedData

void updateExtendedData(BaseDomain object,
                        java.lang.String documentName,
                        org.w3c.dom.Document data)
                        throws ICATServiceException

Update the document stored under the given object and name.

Parameters:

object -

name -

data -

Throws:

ICATServiceException

removeExtendedData

void removeExtendedData(BaseDomain object,
                        java.lang.String documentName)
                        throws ICATServiceException

Remove the document stored under the given object and document name.

Parameters:

object -

name -

Throws:

ICATServiceException