OrderBy (Subject Area OMAS api 0.2 API)

java.lang.Object
- java.lang.Enum<OrderBy>
- - org.odpi.openmetadata.accessservices.subjectarea.properties.enums.OrderBy

All Implemented Interfaces:

Serializable, Comparable<OrderBy>
```
public enum OrderBy
extends Enum<OrderBy>
implements Serializable
```
Defines the sequencing for a collection.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DateAdded` Order by date added to the metadata collection.
`DateCreated` Order by date that the asset was created.
`DateUpdated` Order by date that the asset was updated.
`Name` Order by name property.
`Other` Order by another property.
`Owner` Order by owner property.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDescription()` Return the description for the enum.
`String`	`getName()` Return the descriptive name for the OrderBy enum instance
`int`	`getOrdinal()` Return the numerical value for the enum.
`static OrderBy`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static OrderBy[]`	`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
  - Name
```
public static final OrderBy Name
```
    Order by name property.
  - Owner
```
public static final OrderBy Owner
```
    Order by owner property.
  - DateAdded
```
public static final OrderBy DateAdded
```
    Order by date added to the metadata collection.
  - DateUpdated
```
public static final OrderBy DateUpdated
```
    Order by date that the asset was updated.
  - DateCreated
```
public static final OrderBy DateCreated
```
    Order by date that the asset was created.
  - Other
```
public static final OrderBy Other
```
    Order by another property.
- Method Detail
  - values
```
public static OrderBy[] 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 (OrderBy c : OrderBy.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OrderBy 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
  - getOrdinal
```
public int getOrdinal()
```
    Return the numerical value for the enum.
    
    Returns:
    
    int enum value ordinal
  - getDescription
```
public String getDescription()
```
    Return the description for the enum.
    
    Returns:
    
    String description
  - getName
```
public String getName()
```
    Return the descriptive name for the OrderBy enum instance
    
    Returns:
    
    String name

Enum OrderBy

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Name

Owner

DateAdded

DateUpdated

DateCreated

Other

Method Detail

values

valueOf

getOrdinal

getDescription

getName