Package org.orcid.jaxb.model.message

Enum Class ScopePathType

java.lang.Object
java.lang.Enum<ScopePathType>
org.orcid.jaxb.model.message.ScopePathType
All Implemented Interfaces:
Serializable, Comparable<ScopePathType>, Constable
public enum ScopePathType extends Enum<ScopePathType> implements Serializable
Java class for scope-path-type. The following schema fragment specifies the expected content contained within this class. 
 <simpleType name="scope-path-type">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="/authorize"/>
     <enumeration value="/authenticate"/>
     <enumeration value="/read-public"/>
     <enumeration value="/webhook"/>
     <enumeration value="/orcid-bio/read-limited"/>
     <enumeration value="/orcid-profile/read-limited"/>
     <enumeration value="/orcid-works/read-limited"/>
     <enumeration value="/funding/read-limited"/>
     <enumeration value="/orcid-patents/read-limited"/>
     <enumeration value="/orcid-works/update"/>
     <enumeration value="/funding/update"/>
     <enumeration value="/orcid-patents/update"/>
     <enumeration value="/orcid-bio/external-identifiers/create"/>
     <enumeration value="/orcid-bio/update"/>
     <enumeration value="/orcid-works/create"/>
     <enumeration value="/funding/create"/>
     <enumeration value="/orcid-patents/create"/>
     <enumeration value="/orcid-profile/create"/>
   </restriction>
 </simpleType>

  • Enum Constant Details

    • READ_PUBLIC

      public static final ScopePathType READ_PUBLIC

    • AUTHENTICATE

      public static final ScopePathType AUTHENTICATE

    • ORCID_BIO_EXTERNAL_IDENTIFIERS_CREATE

      public static final ScopePathType ORCID_BIO_EXTERNAL_IDENTIFIERS_CREATE

    • ORCID_BIO_READ_LIMITED

      public static final ScopePathType ORCID_BIO_READ_LIMITED

    • ORCID_BIO_UPDATE

      public static final ScopePathType ORCID_BIO_UPDATE

    • AFFILIATIONS_CREATE

      public static final ScopePathType AFFILIATIONS_CREATE

    • AFFILIATIONS_READ_LIMITED

      public static final ScopePathType AFFILIATIONS_READ_LIMITED

    • AFFILIATIONS_UPDATE

      public static final ScopePathType AFFILIATIONS_UPDATE

    • FUNDING_CREATE

      public static final ScopePathType FUNDING_CREATE

    • FUNDING_READ_LIMITED

      public static final ScopePathType FUNDING_READ_LIMITED

    • FUNDING_UPDATE

      public static final ScopePathType FUNDING_UPDATE

    • ORCID_PATENTS_CREATE

      public static final ScopePathType ORCID_PATENTS_CREATE

    • ORCID_PATENTS_READ_LIMITED

      public static final ScopePathType ORCID_PATENTS_READ_LIMITED

    • ORCID_PATENTS_UPDATE

      public static final ScopePathType ORCID_PATENTS_UPDATE

    • PEER_REVIEW_CREATE

      public static final ScopePathType PEER_REVIEW_CREATE

    • PEER_REVIEW_READ_LIMITED

      public static final ScopePathType PEER_REVIEW_READ_LIMITED

    • PEER_REVIEW_UPDATE

      public static final ScopePathType PEER_REVIEW_UPDATE

    • ORCID_WORKS_CREATE

      public static final ScopePathType ORCID_WORKS_CREATE

    • ORCID_WORKS_READ_LIMITED

      public static final ScopePathType ORCID_WORKS_READ_LIMITED

    • ORCID_WORKS_UPDATE

      public static final ScopePathType ORCID_WORKS_UPDATE

    • PERSON_READ_LIMITED

      public static final ScopePathType PERSON_READ_LIMITED

    • PERSON_UPDATE

      public static final ScopePathType PERSON_UPDATE

    • ACTIVITIES_READ_LIMITED

      public static final ScopePathType ACTIVITIES_READ_LIMITED

    • ACTIVITIES_UPDATE

      public static final ScopePathType ACTIVITIES_UPDATE

    • READ_LIMITED

      public static final ScopePathType READ_LIMITED

    • ORCID_PROFILE_READ_LIMITED

      public static final ScopePathType ORCID_PROFILE_READ_LIMITED

    • EMAIL_READ_PRIVATE

      public static final ScopePathType EMAIL_READ_PRIVATE

    • WEBHOOK

      public static final ScopePathType WEBHOOK

    • GROUP_ID_RECORD_READ

      public static final ScopePathType GROUP_ID_RECORD_READ

    • GROUP_ID_RECORD_UPDATE

      public static final ScopePathType GROUP_ID_RECORD_UPDATE

    • OPENID

      public static final ScopePathType OPENID

    • ORCID_PROFILE_CREATE

      public static final ScopePathType ORCID_PROFILE_CREATE

    • BASIC_NOTIFICATION

      public static final ScopePathType BASIC_NOTIFICATION

    • PREMIUM_NOTIFICATION

      public static final ScopePathType PREMIUM_NOTIFICATION

    • INTERNAL

      public static final ScopePathType INTERNAL

    • INTERNAL_PERSON_LAST_MODIFIED

      public static final ScopePathType INTERNAL_PERSON_LAST_MODIFIED

    • IDENTIFIER_TYPES_CREATE

      public static final ScopePathType IDENTIFIER_TYPES_CREATE

    • SALESFORCE_MEMBER_LIST_READ

      public static final ScopePathType SALESFORCE_MEMBER_LIST_READ

    • SALESFORCE_MEMBER_LIST_WRITE

      public static final ScopePathType SALESFORCE_MEMBER_LIST_WRITE

    • SALESFORCE_MEMBER_LIST_FULL_ACCESS

      public static final ScopePathType SALESFORCE_MEMBER_LIST_FULL_ACCESS

  • Method Details

    • values

      public static ScopePathType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ScopePathType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • value

      public String value()

    • getContent

      public String getContent()

    • fromValue

      public static ScopePathType fromValue(String scopeString)

    • combined

      public Set<ScopePathType> combined()
      Returns:
      A set containing this scope and all its inherited scopes

    • isReadOnlyScope

      public boolean isReadOnlyScope()

    • isClientCreditalScope

      public boolean isClientCreditalScope()

    • isUserGrantWriteScope

      public boolean isUserGrantWriteScope()

    • isInternalScope

      public boolean isInternalScope()

    • getCombinedAsStrings

      public Set<String> getCombinedAsStrings()
      Returns:
      A set containing the external identifiers for this scope and all its inherited scopes

    • hasScope

      public boolean hasScope(ScopePathType scope)

    • hasScope

      public boolean hasScope(String scope)

    • hasStringScope

      public static boolean hasStringScope(String scope, ScopePathType required)

    • getScopesFromStrings

      public static Set<ScopePathType> getScopesFromStrings(Collection<String> scopes)

    • getCombinedScopesFromStringsAsStrings

      public static Set<String> getCombinedScopesFromStringsAsStrings(Collection<String> scopes)

    • getScopesFromSpaceSeparatedString

      public static Set<ScopePathType> getScopesFromSpaceSeparatedString(String scopesString)

    • getScopesAsStrings

      public static Set<String> getScopesAsStrings(Collection<ScopePathType> scopes)

    • getScopesAsSingleString

      public static String getScopesAsSingleString(Collection<ScopePathType> scopes)

    • getScopesAsStrings

      public static Set<String> getScopesAsStrings(ScopePathType... scopes)