Skip navigation links

oracle.search.admin.api.ws.client
Class ObjectOutput

java.lang.Object
oracle.search.admin.api.ws.client.ObjectOutput

public class ObjectOutput

extends Object

Contains the configuration or state of one or more objects.

An object's configuration is composed of object XML, which describes the object's properties, and a list of attachments, which contains binary data that is associated with the object (such as a file). An ObjectOutput contains configuration information when it is returned by a configuration operation, such as export.

An object's state is composed of object XML describing its state properties, such as the status of a schedule. An ObjectOutput contains state information when it is returned by a state operation, such as getState.

The following schema fragment specifies the expected SOAP XML for this class:

 <complexType name="objectOutput">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="attachments" type="{http://search.oracle.com/Admin}attachment" maxOccurs="unbounded" minOccurs="0"/>
         <element name="objectXML" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="properties" type="{http://search.oracle.com/Admin}adminProperty" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

AdminPortType, Attachment

Constructor Summary

ObjectOutput()

Method Summary

List	getAttachments() Returns the list of attachments for the objects contained in the object XML.
String	getObjectXML() Returns the object XML describing the configuration or state of one or more objects.
List	getProperties() Returns the list of administration properties.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObjectOutput

public ObjectOutput()

Method Detail

getAttachments

public List getAttachments()

Returns the list of attachments for the objects contained in the object XML.

Returns:

A non-null List of Attachment. An empty List if this ObjectOutput represents state information or there are no attachments for the objects in the object XML.

getObjectXML

public String getObjectXML()

Returns the object XML describing the configuration or state of one or more objects.

Returns:

A non-null String containing the object XML.

getProperties

public List getProperties()

Returns the list of administration properties. To add a new property:

   getProperties().add( newProperty );
 

NOTE: Not currently used.

Returns:

A non-null List of AdminProperty.

Skip navigation links