RightsOption (Europeana Core Library Definitions 2.6.5 API)

java.lang.Object
- java.lang.Enum<RightsOption>
- - eu.europeana.corelib.definitions.model.RightsOption

All Implemented Interfaces:

Serializable, Comparable<RightsOption>
```
public enum RightsOption
extends Enum<RightsOption>
```
Class represents a set of rights that can be attached to an item in the Europeana website.

Author:

kevinparkings, Andy MacLean

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CC_BY` open http://creativecommons.org/licenses/by/
`CC_BY_NC` restricted http://creativecommons.org/licenses/by-nc/
`CC_BY_NC_ND` restricted http://creativecommons.org/licenses/by-nc-nd/
`CC_BY_NC_SA` restricted http://creativecommons.org/licenses/by-nc-sa/
`CC_BY_ND` restricted http://creativecommons.org/licenses/by-nd/
`CC_BY_SA` open http://creativecommons.org/licenses/by-sa/
`CC_NOC` open http://creativecommons.org/publicdomain/mark/
`CC_ZERO` open http://creativecommons.org/publicdomain/zero
`EU_OOC_NC` restricted http://www.europeana.eu/rights/out-of-copyright-non-commercial/
`EU_ORPHAN` permission http://www.europeana.eu/rights/test-orphan-work-test/
`EU_RR_F` permission http://www.europeana.eu/rights/rr-f/
`EU_RR_P` permission http://www.europeana.eu/rights/rr-p/
`EU_RR_R` permission http://www.europeana.eu/rights/rr-r/
`EU_U` permission http://www.europeana.eu/rights/unknown/
`RS_CNE` permission http://rightsstatements.org/vocab/CNE/1.0/
`RS_INC` permission http://rightsstatements.org/vocab/InC/1.0/
`RS_INC_EDU` restricted http://rightsstatements.org/vocab/InC-EDU/1.0/
`RS_INC_OW_EU` permission http://rightsstatements.org/vocab/InC-OW-EU/1.0/
`RS_NOC_NC` restricted http://rightsstatements.org/vocab/NoC-NC/1.0/
`RS_NOC_OKLR` restricted http://rightsstatements.org/vocab/NoC-OKLR/1.0/

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getRelativeUrl(String portalUrl)`
`String`	`getRightsIcon()` Returns the url of the icon associated with the results
`String`	`getRightsText()` Return text associated with the rights
`boolean`	`getShowExternalIcon()` Returns the url of the icon associated with the results
`String`	`getUrl()` Returns the full Url associated with the rights
`boolean`	`isRelativeUrl()`
`static RightsOption`	`safeValueByUrl(String url)`
`static RightsOption`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static RightsOption[]`	`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
  - CC_NOC
```
public static final RightsOption CC_NOC
```
    open http://creativecommons.org/publicdomain/mark/
  - CC_ZERO
```
public static final RightsOption CC_ZERO
```
    open http://creativecommons.org/publicdomain/zero
  - CC_BY
```
public static final RightsOption CC_BY
```
    open http://creativecommons.org/licenses/by/
  - CC_BY_SA
```
public static final RightsOption CC_BY_SA
```
    open http://creativecommons.org/licenses/by-sa/
  - CC_BY_NC
```
public static final RightsOption CC_BY_NC
```
    restricted http://creativecommons.org/licenses/by-nc/
  - CC_BY_NC_SA
```
public static final RightsOption CC_BY_NC_SA
```
    restricted http://creativecommons.org/licenses/by-nc-sa/
  - CC_BY_NC_ND
```
public static final RightsOption CC_BY_NC_ND
```
    restricted http://creativecommons.org/licenses/by-nc-nd/
  - CC_BY_ND
```
public static final RightsOption CC_BY_ND
```
    restricted http://creativecommons.org/licenses/by-nd/
  - EU_OOC_NC
```
public static final RightsOption EU_OOC_NC
```
    restricted http://www.europeana.eu/rights/out-of-copyright-non-commercial/
  - RS_INC_EDU
```
public static final RightsOption RS_INC_EDU
```
    restricted http://rightsstatements.org/vocab/InC-EDU/1.0/
  - RS_NOC_NC
```
public static final RightsOption RS_NOC_NC
```
    restricted http://rightsstatements.org/vocab/NoC-NC/1.0/
  - RS_NOC_OKLR
```
public static final RightsOption RS_NOC_OKLR
```
    restricted http://rightsstatements.org/vocab/NoC-OKLR/1.0/
  - EU_RR_F
```
public static final RightsOption EU_RR_F
```
    permission http://www.europeana.eu/rights/rr-f/
  - EU_RR_P
```
public static final RightsOption EU_RR_P
```
    permission http://www.europeana.eu/rights/rr-p/
  - EU_RR_R
```
public static final RightsOption EU_RR_R
```
    permission http://www.europeana.eu/rights/rr-r/
  - EU_U
```
public static final RightsOption EU_U
```
    permission http://www.europeana.eu/rights/unknown/
  - EU_ORPHAN
```
public static final RightsOption EU_ORPHAN
```
    permission http://www.europeana.eu/rights/test-orphan-work-test/
  - RS_INC
```
public static final RightsOption RS_INC
```
    permission http://rightsstatements.org/vocab/InC/1.0/
  - RS_INC_OW_EU
```
public static final RightsOption RS_INC_OW_EU
```
    permission http://rightsstatements.org/vocab/InC-OW-EU/1.0/
  - RS_CNE
```
public static final RightsOption RS_CNE
```
    permission http://rightsstatements.org/vocab/CNE/1.0/
- Method Detail
  - values
```
public static RightsOption[] 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 (RightsOption c : RightsOption.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static RightsOption 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
  - getUrl
```
public String getUrl()
```
    Returns the full Url associated with the rights
    
    Returns:
    
    Full url associated with the rights
  - getRelativeUrl
```
public String getRelativeUrl(String portalUrl)
```
  - getRightsText
```
public String getRightsText()
```
    Return text associated with the rights
    
    Returns:
    
    text associated with the results
  - getRightsIcon
```
public String getRightsIcon()
```
    Returns the url of the icon associated with the results
    
    Returns:
    
    url of icon associated with the results
  - getShowExternalIcon
```
public boolean getShowExternalIcon()
```
    Returns the url of the icon associated with the results
    
    Returns:
    
    url of icon associated with the results
  - safeValueByUrl
```
public static RightsOption safeValueByUrl(String url)
```
  - isRelativeUrl
```
public boolean isRelativeUrl()
```

Enum RightsOption

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CC_NOC

CC_ZERO

CC_BY

CC_BY_SA

CC_BY_NC

CC_BY_NC_SA

CC_BY_NC_ND

CC_BY_ND

EU_OOC_NC

RS_INC_EDU

RS_NOC_NC

RS_NOC_OKLR

EU_RR_F

EU_RR_P

EU_RR_R

EU_U

EU_ORPHAN

RS_INC

RS_INC_OW_EU

RS_CNE

Method Detail

values

valueOf

getUrl

getRelativeUrl

getRightsText

getRightsIcon

getShowExternalIcon

safeValueByUrl

isRelativeUrl