Returned (SCIM SDK Common 1.8.1 API)

java.lang.Object
- java.lang.Enum<Returned>
- - de.captaingoldfish.scim.sdk.common.constants.enums.Returned

All Implemented Interfaces:

Serializable, Comparable<Returned>
```
public enum Returned
extends Enum<Returned>
```
author Pascal Knueppel
created at: 28.09.2019 - 17:57

A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request. Valid keywords are as follows: always The attribute is always returned, regardless of the contents of the "attributes" parameter. For example, "id" is always returned to identify a SCIM resource. never The attribute is never returned. This may occur because the original attribute value (e.g., a hashed value) is not retained by the service provider. A service provider MAY allow attributes to be used in a search filter. default The attribute is returned by default in all SCIM operation responses where attribute values are returned. If the GET request "attributes" parameter is specified, attribute values are only returned if the attribute is named in the "attributes" parameter. DEFAULT. request The attribute is returned in response to any PUT, POST, or PATCH operations if the attribute was specified by the client (for example, the attribute was modified). The attribute is returned in a SCIM query operation only if specified in the "attributes" parameter.

Enum Constant Summary

Enum Constants
Enum Constant Description

ALWAYS

DEFAULT

NEVER

REQUEST

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Returned`	`getByValue(String value)`
`static Returned`	`valueOf(String name)`	Returns the enum constant of this type with the specified name.
`static Returned[]`	`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
  - DEFAULT
```
public static final Returned DEFAULT
```
  - ALWAYS
```
public static final Returned ALWAYS
```
  - NEVER
```
public static final Returned NEVER
```
  - REQUEST
```
public static final Returned REQUEST
```
- Method Detail
  - values
```
public static Returned[] 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 (Returned c : Returned.values()) System.out.println(c);
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Returned 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
  - getByValue
```
public static Returned getByValue(String value)
```