Outcome.Status (ks 1.7.1 API)

java.lang.Object
- java.lang.Enum<Outcome.Status>
- - eu.fbk.knowledgestore.Outcome.Status

All Implemented Interfaces:

Serializable, Comparable<Outcome.Status>

Enclosing class:

Outcome
```
public static enum Outcome.Status
extends Enum<Outcome.Status>
```
Enumeration of Outcome status codes.
This enumeration lists the possible status codes for Outcome objects. A status code is identified by an URI (see getURI()), is briefly explained through a comment string (see getComment()) and may be mapped to an HTTP status code (see getHTTPStatus()). Methods isOK(), isError() determine, respectively, if the status code denotes a success or error situation. Lookup of status codes based on URI is supported by method valueOf(URI).

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ERROR_BULK` Error status specifying that a bulk operation invocation failed for one or more of the involved objects.
`ERROR_DEPENDENCY_NOT_FOUND` Error status specifying that an object indirectly referenced by the operation invocation does not exist.
`ERROR_FORBIDDEN` Error status specifying that the invoked operation has not been executed because the requester has not enough privileges.
`ERROR_INTERRUPTED` Error status specifying that the invoked operation was forcedly interrupted by the client, server or due to a connectivity problem.
`ERROR_INVALID_INPUT` Error status specifying that input arguments are missing or wrong.
`ERROR_NOT_ACCEPTABLE` Error status specifying that an operation invocation failed as its result would not be acceptable to the client.
`ERROR_OBJECT_ALREADY_EXISTS` Error status specifying that the referenced object already exists.
`ERROR_OBJECT_NOT_FOUND` Error status specifying that the referenced object does not exist.
`ERROR_UNEXPECTED` Error status specifying that the invocation failed due to an unexpected error.
`OK_BULK` Success status specifying successful completion of a bulk operation invocation for all the objects involved.
`OK_CREATED` Success status specifying that an object has been created.
`OK_DELETED` Success status specifying that an object has been deleted.
`OK_MODIFIED` Success status specifying that an object has been modified.
`OK_UNMODIFIED` Success status specifying that it was not necessary to modify an object.
`UNKNOWN` Error status specifying that the outcome of the invoked operation is unknown.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getComment()` Returns a constant comment string describing this status code.
`int`	`getHTTPStatus()` Returns the HTTP status code corresponding to this `Outcome` status code.
`org.openrdf.model.URI`	`getURI()` Returns the URI univocally identifying this status code.
`boolean`	`isError()` Helper method to determine whether the status code denotes error.
`boolean`	`isOK()` Helper method to determine whether the status code denotes success.
`static Outcome.Status`	`valueOf(int httpStatus)` Return the `Status` that more closely matches the HTTP status code specified.
`static Outcome.Status`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Outcome.Status`	`valueOf(org.openrdf.model.URI uri)` Lookups the status code with the URI specified.
`static Outcome.Status[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - OK_BULK
```
public static final Outcome.Status OK_BULK
```
    Success status specifying successful completion of a bulk operation invocation for all the objects involved.
    
    See Also:
    
    KSR.OK_BULK
  - OK_CREATED
```
public static final Outcome.Status OK_CREATED
```
    Success status specifying that an object has been created.
    
    See Also:
    
    KSR.OK_CREATED
  - OK_MODIFIED
```
public static final Outcome.Status OK_MODIFIED
```
    Success status specifying that an object has been modified.
    
    See Also:
    
    KSR.OK_MODIFIED
  - OK_UNMODIFIED
```
public static final Outcome.Status OK_UNMODIFIED
```
    Success status specifying that it was not necessary to modify an object.
    
    See Also:
    
    KSR.OK_UNMODIFIED
  - OK_DELETED
```
public static final Outcome.Status OK_DELETED
```
    Success status specifying that an object has been deleted.
    
    See Also:
    
    KSR.OK_DELETED
  - ERROR_BULK
```
public static final Outcome.Status ERROR_BULK
```
    Error status specifying that a bulk operation invocation failed for one or more of the involved objects.
    
    See Also:
    
    KSR.ERROR_BULK
  - ERROR_NOT_ACCEPTABLE
```
public static final Outcome.Status ERROR_NOT_ACCEPTABLE
```
    Error status specifying that an operation invocation failed as its result would not be acceptable to the client.
    
    See Also:
    
    KSR#ERROR_PRECONDITION_FAILED
  - ERROR_OBJECT_NOT_FOUND
```
public static final Outcome.Status ERROR_OBJECT_NOT_FOUND
```
    Error status specifying that the referenced object does not exist.
    
    See Also:
    
    KSR.ERROR_OBJECT_NOT_FOUND
  - ERROR_OBJECT_ALREADY_EXISTS
```
public static final Outcome.Status ERROR_OBJECT_ALREADY_EXISTS
```
    Error status specifying that the referenced object already exists.
    
    See Also:
    
    KSR.ERROR_OBJECT_ALREADY_EXISTS
  - ERROR_DEPENDENCY_NOT_FOUND
```
public static final Outcome.Status ERROR_DEPENDENCY_NOT_FOUND
```
    Error status specifying that an object indirectly referenced by the operation invocation does not exist.
    
    See Also:
    
    KSR.ERROR_DEPENDENCY_NOT_FOUND
  - ERROR_INVALID_INPUT
```
public static final Outcome.Status ERROR_INVALID_INPUT
```
    Error status specifying that input arguments are missing or wrong.
    
    See Also:
    
    KSR.ERROR_INVALID_INPUT
  - ERROR_FORBIDDEN
```
public static final Outcome.Status ERROR_FORBIDDEN
```
    Error status specifying that the invoked operation has not been executed because the requester has not enough privileges.
    
    See Also:
    
    KSR.ERROR_FORBIDDEN
  - ERROR_INTERRUPTED
```
public static final Outcome.Status ERROR_INTERRUPTED
```
    Error status specifying that the invoked operation was forcedly interrupted by the client, server or due to a connectivity problem.
    
    See Also:
    
    KSR.ERROR_INTERRUPTED
  - ERROR_UNEXPECTED
```
public static final Outcome.Status ERROR_UNEXPECTED
```
    Error status specifying that the invocation failed due to an unexpected error.
    
    See Also:
    
    KSR.ERROR_UNEXPECTED
  - UNKNOWN
```
public static final Outcome.Status UNKNOWN
```
    Error status specifying that the outcome of the invoked operation is unknown.
    
    See Also:
    
    KSR.UNKNOWN
- Method Detail
  - values
```
public static Outcome.Status[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Outcome.Status c : Outcome.Status.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Outcome.Status valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getURI
```
public org.openrdf.model.URI getURI()
```
    Returns the URI univocally identifying this status code. The URI can be used for serializing / deserializing this Status object.
    
    Returns:
    
    the URI for this status code
  - getComment
```
public String getComment()
```
    Returns a constant comment string describing this status code.
    
    Returns:
    
    a comment string
  - getHTTPStatus
```
public int getHTTPStatus()
```
    Returns the HTTP status code corresponding to this Outcome status code. Note that multiple Outcome status codes may map to the same HTTP status code.
    
    Returns:
    
    the corresponding HTTP status code
  - isOK
```
public boolean isOK()
```
    Helper method to determine whether the status code denotes success.
    
    Returns:
    
    true, if this status code denotes success
  - isError
```
public boolean isError()
```
    Helper method to determine whether the status code denotes error.
    
    Returns:
    
    true, if this status code denotes error
  - valueOf
```
public static Outcome.Status valueOf(org.openrdf.model.URI uri)
                              throws IllegalArgumentException
```
    Lookups the status code with the URI specified.
    
    Parameters:
    
    uri - the URI of the status code to lookup
    
    Returns:
    
    the corresponding status code, on success
    
    Throws:
    
    IllegalArgumentException - if there is no status for the URI specified
  - valueOf
```
public static Outcome.Status valueOf(int httpStatus)
```
    Return the Status that more closely matches the HTTP status code specified. Note that only part of the statuses of this enuemration are returned, as the mapping from Status to HTTP statuses is N:1.
    
    Parameters:
    
    httpStatus - the HTTP status
    
    Returns:
    
    the corresponding Status, defaulting to ERROR_UNEXPECTED

Enum Outcome.Status

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

OK_BULK

OK_CREATED

OK_MODIFIED

OK_UNMODIFIED

OK_DELETED

ERROR_BULK

ERROR_NOT_ACCEPTABLE

ERROR_OBJECT_NOT_FOUND

ERROR_OBJECT_ALREADY_EXISTS

ERROR_DEPENDENCY_NOT_FOUND

ERROR_INVALID_INPUT

ERROR_FORBIDDEN

ERROR_INTERRUPTED

ERROR_UNEXPECTED

UNKNOWN

Method Detail

values

valueOf

getURI

getComment

getHTTPStatus

isOK

isError

valueOf

valueOf