|
Oracle Secure Enterprise Search Java API Reference 11g Release 2 (11.2.1.0.0) E17597-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.search.admin.api.ws.client.Status
public class Status
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>
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 |
---|
public Status()
Method Detail |
---|
public ObjectKey getObjectKey()
ObjectKey
of the associated object when the object type is creatable, and null
when the object type is universal.public String getObjectType()
public List getProperties()
getProperties().add( newProperty );NOTE: Not currently used.
List
of AdminProperty
.public String getStatusCode()
|
Oracle Secure Enterprise Search Java API Reference 11g Release 2 (11.2.1.0.0) E17597-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |