Skip navigation links

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

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

public class Status

extends Object

Contains the result of processing a single object. API operations that process more than one object at a time, such as createAll, return a list of Status, one for each object that was processed. For example, when deleting multiple objects, you may want to know if any objects were skipped because they could not be deleted for some reason (e.g., their state was invalid, or they do not support deletion). Each Status has a status code that represents the result of processing the associated object. The possible status codes are summarized below:

Status Code	Meaning
CREATE_NOT_SUPPORTED	The object does not support creation.
CREATE_SUCCEEDED	The object was successfully created.
DELETE_NOT_SUPPORTED	The object does not support deletion.
DELETE_SUCCEEDED	The object was successfully deleted.
DUPLICATE_IGNORED	The object already existed. The pre-existing object was ignored.
DUPLICATE_OVERWRITTEN	The object already existed. The pre-existing object was overwritten.
INVALID_STATE_IGNORED	The object was ignored because it was in an invalid state.
NOT_FOUND_CREATED	The object did not exist. The operation created the object.
NOT_FOUND_IGNORED	The object did not exist. The operation ignored the object.
UPDATE_NOT_SUPPORTED	The object does not support updates.
UPDATE_SUCCEEDED	The object was successfully updated.

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

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

See Also:

AdminPortType

Constructor Summary

Status()

Method Summary

ObjectKey	getObjectKey() Returns the object key of the associated object.
String	getObjectType() Returns the object type of the associated object.
List	getProperties() Returns the list of administration properties.
String	getStatusCode() Returns the status code for the associated object.

Methods inherited from class java.lang.Object

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

Constructor Detail

Status

public Status()

Method Detail

getObjectKey

public ObjectKey getObjectKey()

Returns the object key of the associated object.

Returns:

The ObjectKey of the associated object when the object type is creatable, and null when the object type is universal.

getObjectType

public String getObjectType()

Returns the object type of the associated object.

Returns:

The object type of the associated object.

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.

getStatusCode

public String getStatusCode()

Returns the status code for the associated object.

Returns:

The status code for the associated object. One of: CREATE_NOT_SUPPORTED, CREATE_SUCCEEDED, DELETE_NOT_SUPPORTED, DELETE_SUCCEEDED, DUPLICATE_IGNORED, DUPLICATE_OVERWRITTEN, INVALID_STATE_IGNORED, UPDATE_NOT_SUPPORTED, UPDATE_SUCCEEDED.

Skip navigation links