Xindice API
version 1.1b4

org.apache.xindice.server.rpc.messages
Class SetDocumentMeta

java.lang.Object
  |
  +--org.apache.xindice.server.rpc.RPCDefaultMessage
        |
        +--org.apache.xindice.server.rpc.messages.SetDocumentMeta
All Implemented Interfaces:
RPCMessage

public class SetDocumentMeta
extends RPCDefaultMessage

XML-RPC message to set the meta data associated with a document

Version:
CVS $Revision: 1.6 $, $Date: 2004/02/08 02:54:17 $
Author:
Dave Viner

Fields inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage
API_NAME, API_VERSION, COLLECTION, COMPRESSED, CONFIGURATION, DOCUMENT, MAXKEYSIZE, META, MISSING_COLLECTION_PARAM, MISSING_CONFIGURATION_PARAM, MISSING_DOCUMENT_PARAM, MISSING_META_CONFIGURATION, MISSING_META_PARAM, MISSING_NAME_PARAM, MISSING_PATTERN_PARAM, MISSING_QUERY_PARAM, MISSING_TIMESTAMP_PARAM, MISSING_TYPE_PARAM, NAME, NAMESPACES, PAGESIZE, PATTERN, QUERY, RESULT, TIMESTAMP, TYPE
 
Constructor Summary
SetDocumentMeta()
           
 
Method Summary
 java.util.Hashtable execute(java.util.Hashtable message)
          Set the MetaData object for the requested document.
 
Methods inherited from class org.apache.xindice.server.rpc.RPCDefaultMessage
getCollection
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SetDocumentMeta

public SetDocumentMeta()
Method Detail

execute

public java.util.Hashtable execute(java.util.Hashtable message)
                            throws java.lang.Exception
Set the MetaData object for the requested document. This method expects the Hashtable to contain the name of the collection in the RPCDefaultMessage.COLLECTION key, the name of the document in the RPCDefaultMessage.NAME key, and the XML for the new MetaData object in the RPCDefaultMessage.META key. It will return an XML representation of the newly created MetaData object associated with this document. The XML will be stored in the RPCDefaultMessage.RESULT key.
Parameters:
message - the parameters passed to the xmlrpc method.
Returns:
Hashtable containing XML of the newly created MetaData object.

Xindice API
version 1.1b4

Copyright (c) 1999-2004 The Apache Software Foundation. All Rights Reserved.