Class OAuthScopeSelectionFieldDescriptor

All Implemented Interfaces:
Serializable

public class OAuthScopeSelectionFieldDescriptor extends FilterableSelectionFieldDescriptor
A filterable dropdown control that enables the selection of OAuth scopes in a way that's user-friendly and scalable.
Since:
12.1
See Also:
  • Field Details

  • Constructor Details

    • OAuthScopeSelectionFieldDescriptor

      public OAuthScopeSelectionFieldDescriptor(String name, String description)
      Creates a new OAuthScopeSelectionFieldDescriptor.
      Parameters:
      name - the field name
      description - a helpful description of the field
  • Method Details

    • getSearchableTypes

      Description copied from class: FilterableSelectionFieldDescriptor
      Gets the list of search type configurations of a FilterableSelectionFieldDescriptor instance.
      Specified by:
      getSearchableTypes in class FilterableSelectionFieldDescriptor
      Returns:
      a list of search type configuration supported by this filterable selection field descriptor
    • getSelectedDisplayName

      public String getSelectedDisplayName(String valueForStorage)
      Description copied from class: FilterableSelectionFieldDescriptor
      Gets the display string value of a stored value returned by parseSelectedValueForStorage.
           For example, when a unique OAuth client ID is returned by parseSelectedValueForStorage, instead of using the
           client ID as the display string, a FilterableSelectionFieldDescriptor implementation may opt to display the
           corresponding client name of client ID instead, possibly obtained through data store query.
       
      Overrides:
      getSelectedDisplayName in class FilterableSelectionFieldDescriptor
      Parameters:
      valueForStorage - typically an unique ID of a data object, e.g. a connection (system) ID, an adapter ID, or an OAuth client ID etc.
      Returns:
      drop-down box display value for the selected item
    • storageKeyToScopeName

      public static String storageKeyToScopeName(String storageKey)
      Returns the scope name from the storage key value.
      Parameters:
      storageKey - the value stored.
      Returns:
      the scope name.