Rel (Isis RestfulObjects Viewer AppLib 2.3.0)

java.lang.Object
- java.lang.Enum<Rel>
- - org.apache.isis.viewer.restfulobjects.applib.Rel

All Implemented Interfaces:

Serializable, Comparable<Rel>
```
public enum Rel
extends Enum<Rel>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ACTION`
`ACTION_PARAM`
`ADD_TO`
`ATTACHMENT`
`CHOICE`
`CLEAR`
`COLLECTION`
`CONTRIBUTED_BY`
`DEFAULT`
`DELETE`
`DESCRIBEDBY`
`DETAILS`
`DOMAIN_TYPE`
`DOMAIN_TYPES`
`ELEMENT`
`ELEMENT_TYPE`
`HELP`
`ICON`
`INVOKE`
`MODIFY`
`NEXT`
`PERSIST`
`PREVIOUS`
`PROPERTY`
`REMOVE_FROM`
`RETURN_TYPE`
`SELF`
`SERVICE`
`SERVICES`
`UP`
`UPDATE`
`USER`
`VALUE`
`VERSION`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`andParam(String paramName, String paramValue)` For those `Rel`s that also take a param
`String`	`getName()`
`boolean`	`matches(Rel otherRel)`
`boolean`	`matches(String otherRelStr)`
`static Rel`	`parse(String str)`
`static Rel`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Rel[]`	`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

SELF
```
public static final Rel SELF
```

DESCRIBEDBY
```
public static final Rel DESCRIBEDBY
```

UP
```
public static final Rel UP
```

PREVIOUS
```
public static final Rel PREVIOUS
```

NEXT
```
public static final Rel NEXT
```

HELP
```
public static final Rel HELP
```

ICON
```
public static final Rel ICON
```

ACTION
```
public static final Rel ACTION
```

ACTION_PARAM
```
public static final Rel ACTION_PARAM
```

ADD_TO
```
public static final Rel ADD_TO
```

ATTACHMENT
```
public static final Rel ATTACHMENT
```

CHOICE
```
public static final Rel CHOICE
```

CLEAR
```
public static final Rel CLEAR
```

COLLECTION
```
public static final Rel COLLECTION
```

DEFAULT
```
public static final Rel DEFAULT
```

DELETE
```
public static final Rel DELETE
```

DETAILS
```
public static final Rel DETAILS
```

DOMAIN_TYPE
```
public static final Rel DOMAIN_TYPE
```

DOMAIN_TYPES
```
public static final Rel DOMAIN_TYPES
```

ELEMENT
```
public static final Rel ELEMENT
```

ELEMENT_TYPE
```
public static final Rel ELEMENT_TYPE
```

INVOKE
```
public static final Rel INVOKE
```

MODIFY
```
public static final Rel MODIFY
```

PERSIST
```
public static final Rel PERSIST
```

PROPERTY
```
public static final Rel PROPERTY
```

REMOVE_FROM
```
public static final Rel REMOVE_FROM
```

RETURN_TYPE
```
public static final Rel RETURN_TYPE
```

SERVICE
```
public static final Rel SERVICE
```

SERVICES
```
public static final Rel SERVICES
```

UPDATE
```
public static final Rel UPDATE
```

USER
```
public static final Rel USER
```

VALUE
```
public static final Rel VALUE
```

VERSION
```
public static final Rel VERSION
```

CONTRIBUTED_BY
```
public static final Rel CONTRIBUTED_BY
```

Method Detail
- values
```
public static Rel[] 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 (Rel c : Rel.values())
    System.out.println(c);
```
  Returns:
  an array containing the constants of this enum type, in the order they are declared
- valueOf
```
public static Rel 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
- getName
```
public String getName()
```
- andParam
```
public String andParam(String paramName,
              String paramValue)
```
  For those Rels that also take a param
- matches
```
public boolean matches(Rel otherRel)
```
- matches
```
public boolean matches(String otherRelStr)
```
- parse
```
public static Rel parse(String str)
```

Enum Rel

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

SELF

DESCRIBEDBY

UP

PREVIOUS

NEXT

HELP

ICON

ACTION

ACTION_PARAM

ADD_TO

ATTACHMENT

CHOICE

CLEAR

COLLECTION

DEFAULT

DELETE

DETAILS

DOMAIN_TYPE

DOMAIN_TYPES

ELEMENT

ELEMENT_TYPE

INVOKE

MODIFY

PERSIST

PROPERTY

REMOVE_FROM

RETURN_TYPE

SERVICE

SERVICES

UPDATE

USER

VALUE

VERSION

CONTRIBUTED_BY

Method Detail

values

valueOf

getName

andParam

matches

matches

parse