Package com.boomi.connector.api

Enum OperationType

  • All Implemented Interfaces:
    Serializable, Comparable<OperationType>
    public enum OperationType
extends Enum<OperationType>
    Enumeration which defines the available Operations in the system (not all of which are necessarily supported by every connector implementation).

    • Enum Constant Detail

      • GET

        public static final OperationType GET
        Operation which retrieves a single object from the service given an object id. Since GET, requests are often used to test for the existence of an object, a GET request for an object which does not exist should not return a failure, but should instead return an "empty" success.

      • QUERY

        public static final OperationType QUERY
        Operation which retrieves 0 or more objects from the service given some user defined search criteria.

      • CREATE

        public static final OperationType CREATE
        Operation which creates a new object in the service. Note that OUTPUT definitions are optional.

      • UPDATE

        public static final OperationType UPDATE
        Operation which updates an existing object in the service. Note that OUTPUT definitions are optional.

      • UPSERT

        public static final OperationType UPSERT
        (Combination of UPDATE/INSERT) Operation which updates an object if it already exists, otherwise creates a new instance. Note that OUTPUT definitions are optional.

      • DELETE

        public static final OperationType DELETE
        Operation which deletes objects from the service given object ids. Note that OUTPUT definitions are optional.

      • EXECUTE

        public static final OperationType EXECUTE
        Operation which is not "object" based but executes some sort of action in the service. Note that OUTPUT definitions are optional.

      • LISTEN

        public static final OperationType LISTEN
        Operation which can be used to submit process executions for "real-time" connectivity. This is fundamentally different than other operations which can only be invoked from an already running integration process.

    • Method Detail

      • values

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

      • valueOf

        public static OperationType 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

      • getSupportedDefinitionRoles

        public Set<ObjectDefinitionRole> getSupportedDefinitionRoles()
        The collection of all roles which are supported by this operation type (this may or may not be more than the collection of required roles). The set is ordered with required roles before the optional roles. An optional role means that a connector does not need to provide a definition for the role during browsing.

      • getRequiredDefinitionRoles

        public Set<ObjectDefinitionRole> getRequiredDefinitionRoles()
        The collection of roles which are required by this operation type (i.e. these rules must have a definition after browsing).