Enum ExtraParameters

    • Enum Constant Detail

      • ENCODE_JSON

        public static final ExtraParameters ENCODE_JSON
        Will encode the request to JSON
      • ENCODE_XML

        public static final ExtraParameters ENCODE_XML
        Will encode the request to XML
      • CACHE_CONTROL_DIRECTIVE

        public static final ExtraParameters CACHE_CONTROL_DIRECTIVE
        Sets the Cache-Control header value, which advises the server (or any cache in front of it) how to behave in terms of cached requests"
      • SUBSET_ELEMENTS

        public static final ExtraParameters SUBSET_ELEMENTS
        Request that the server return subsetted resources, containing only the elements specified in the given parameters. For example: subsetElements("name", "identifier") requests that the server only return the "name" and "identifier" fields in the returned resource, and omit any others.
      • PREFER_RESPONSE_TYPE

        public static final ExtraParameters PREFER_RESPONSE_TYPE
        Explicitly specify a custom structure type to attempt to use when parsing the response. This is useful for invocations where the response is a Bundle/Parameters containing nested resources, and you want to use specific custom structures for those nested resources.

        See Profiles and Extensions for more information on using custom structures

      • PREFER_RESPONSE_TYPES

        public static final ExtraParameters PREFER_RESPONSE_TYPES
        Explicitly specify a custom structure type to attempt to use when parsing the response. This is useful for invocations where the response is a Bundle/Parameters containing nested resources, and you want to use specific custom structures for those nested resources.

        See Profiles and Extensions for more information on using custom structures

      • PRETTY_PRINT

        public static final ExtraParameters PRETTY_PRINT
        Pretty print the request
      • SUMMARY_ENUM

        public static final ExtraParameters SUMMARY_ENUM
        Request that the server modify the response using the _summary param
    • Method Detail

      • values

        public static ExtraParameters[] 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 (ExtraParameters c : ExtraParameters.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static ExtraParameters 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
      • getParam

        public String getParam()
      • getHeaderName

        public String getHeaderName()