Version:

• 17.1.1

Source:

• bop/js/spi/operation/OperationProvider.js, line 302

See:

• BOP
• EntityProvider
• OperationInput to create description of the Operation input (e.g. which parameters are available, which of them are required, which Operators are supported etc.)
• OperationOutput to create description of the Operation output (e.g. which Properties are returned by the REST call)
• OperationBuilder to create general description of the resulted Operation (defines for example name, description or Type of the Operation).
• Operation to check how resulted Operations produced by this OperationProvider look like.

Examples

Example of typical implementation of custom OperationProvider used inside of the custom BOP.

define([
    'operation/js/api/Operation',
    'operation/js/api/Operator',
    'bop/js/api/operation/OperationBuilder',
    'bop/js/api/operation/OperationInput',
    'bop/js/api/operation/OperationOutput',
    '{{package}}/js/Employee'
], function (
    Operation,
    Operator,
    OperationBuilder,
    OperationInput,
    OperationOutput,
    Employee
) {

    var CustomOperationProvider = function () {
        this._operations = [];

        var employee = Abcs.Entities().findById('my.custom.bop.Employee');
        var id = employee.getProperty('my.custom.bop.Employee.ID');
        var firstname = employee.getProperty('my.custom.bop.Employee.Firstname');
        var lastname = employee.getProperty('my.custom.bop.Employee.Lastname');
        var age = employee.getProperty('my.custom.bop.Employee.Age');

        var partialOutput = new OperationOutput({
            entity: employee
        }).property(firstname).
            property(lastname);

        var idInput = new OperationInput({
            entity: employee
        }).parameter({
            property: id,
            required: true
        });

        var firstnameLastnameInput = new OperationInput({
            entity: employee
        }).parameter(firstname).
            parameter(lastname).
            operators([
                Operator.EQUALS,
                Operator.NOT_EQUALS,
                Operator.STARTS_WITH,
                Operator.ENDS_WITH,
                Operator.CONTAINS,
                Operator.NOT_CONTAINS
            ]);

        var getAllEmployees = new OperationBuilder({
            name: 'Find all Employees',
            type: Operation.Type.READ_MANY,
            performs: function() {
                // Assume there is an Employee object as part of our BOP extension implementation which builds the URL based
                // on the "operationInputData" values, makes the real REST call and returns relevant OperationResult instance
                return Promise.resolve(Employee.getAll());
            }
        }).description('Longer description of what this Operation does').
            returns(partialOutput).
            takes(firstnameLastnameInput).
            build();

        var getEmployeeByID = new OperationBuilder({
            name: 'Find Employee by ID',
            type: Operation.Type.READ_ONE,
            performs: function(operationInputData) {
                // Assume there is an Employee object as part of our BOP extension implementation which builds the URL based
                // on the "operationInputData" values, makes the real REST call and returns relevant OperationResult instance
                return Promise.resolve(Employee.findByID(operationInputData));
            }
        }).specialType(Operation.SpecialType.QUERY_BY_ID).
            takes(idInput).
            returns(employee).
            build();

        // Register all relevant operations
        this._operations.push(getAllEmployees);
        this._operations.push(getEmployeeByID);

        // ..include the same for all other REST calls
    };

    CustomOperationProvider.prototype.getOperations = function() {
        return this._operations;
    };

    return CustomOperationProvider;
});

Example of typical implementation of custom OperationProvider used inside of the custom BOP that defines a ResourceProvider so that it can make use of the default authenticator

define([
    'bop/js/api/operation/BOPAuthenticators',
    'bop/js/api/operation/OperationBuilder',
    'bop/js/api/operation/OperationInput',
    'bop/js/api/operation/OperationOutput',
    'operation/js/api/Operation',
    'operation/js/api/Operator'
], function (
    BOPAuthenticators,
    OperationBuilder,
    OperationInput,
    OperationOutput,
    Operation,
    Operator
) {

    var CustomOperationProvider = function (dependencies) {
        var self = this;
        this._dependencies = dependencies;
        this._operations = [];

        var employee = Abcs.Entities().findById('my.custom.bop.Employee');
        var id = employee.getProperty('my.custom.bop.Employee.ID');
        var firstname = employee.getProperty('my.custom.bop.Employee.Firstname');
        var lastname = employee.getProperty('my.custom.bop.Employee.Lastname');
        var age = employee.getProperty('my.custom.bop.Employee.Age');

        var employeeCollectionResouce = 'my.custom.bop.Employee[]'
        var employeeResouce = 'my.custom.bop.Employee'

        var partialOutput = new OperationOutput({
            entity: employee
        }).property(firstname).
            property(lastname);

        var idInput = new OperationInput({
            entity: employee
        }).parameter({
            property: id,
            required: true
        });

        var firstnameLastnameInput = new OperationInput({
            entity: employee
        }).parameter(firstname).
            parameter(lastname).
            operators([
                Operator.EQUALS,
                Operator.NOT_EQUALS,
                Operator.STARTS_WITH,
                Operator.ENDS_WITH,
                Operator.CONTAINS,
                Operator.NOT_CONTAINS
            ]);

        var getAllEmployees = new OperationBuilder({
            name: 'Find all Employees',
            type: Operation.Type.READ_MANY,
            performs: function() {
                // Make an AJAX request to get hold of the list of employees
                return self.getAuthenticator({
                   url : ....
                   method : ....
                });
            }
        }).description('Longer description of what this Operation does').
            returns(partialOutput).
            takes(firstnameLastnameInput).
            build();

        var getEmployeeByID = new OperationBuilder({
            name: 'Find Employee by ID',
            type: Operation.Type.READ_ONE,
            performs: function(operationInputData) {
                // Make an AJAX request to get hold of the detauls of an
                // employee
                return self.getAuthenticator({
                   url : ....
                   method : ....
                });
            }
        }).specialType(Operation.SpecialType.QUERY_BY_ID).
            takes(idInput).
            returns(employee).
            build();

        // Register all relevant operations
        this._operations.push(getAllEmployees);
        this._operations.push(getEmployeeByID);

        // ..include the same for all other REST calls
    };

    CustomOperationProvider.prototype.getOperations = function() {
        return this._operations;
    };

    // Required if using the built in authenticator
    CustomOperationProvider.prototype.getAuthenticator = function() {
        return BOPAuthenticators.getDefault(
            this._dependencies,
            new CustomResourceProvider());
    };

    return CustomOperationProvider;
});

define([
    'bop/js/api/resource/Resource',
    'bop/js/spi/resource/ResourceProvider'
], function (
    Resource,
    ResourceProvider
) {

    var CustomResourceProvider = function () {
        var parent = Resource.create({
            id : 'employee_collection',
            template : '/employee',
            entity : 'my.custom.bop.Employee'
        });
        var child = Resource.createChild(parent, {
            id : 'employee_instance',
            template : '{id}',
        });

        this._resources = [parent, child];
    };

    CustomResourceProvider.prototype.getResources = function() {
        return this._resources;
    };

    return CustomResourceProvider;
});