Parameters:

Version:

• 17.1.1

Source:

• bop/js/api/operation/OperationBuilder.js, line 308

See:

• OperationInput

Returns:

Type

bop/js/api/operation/OperationBuilder

Examples

Using OperationBuilder.takes(..) method to specify what input parameters the build Operation accepts. In this case, input Entity is defined with two explicit parameters specified.

var employee = Abcs.Entities().findById('my.custom.bop.Employee');
var firstname = employee.getProperty('Firstname');
var lastname = employee.getProperty('Lastname');
var functionToRun = function(operationData) {
    // Include REST call here which performs the real operation retrieving your Employee data
    // In this case your REST call:
    //  --> Has to be capable to manage Firstname and Lastname input parameters with EQUALS operator only
    var baseURL = 'http://example.com/employees';
    var resultURL = new MyConditionVisitor(baseURL).visit(operationData.getCondition());

    // Include REST call here which performs the real operation retrieving your Employee data
    return new Promise(function(fulfil, reject) {
        $.ajax({
            url: resultURL,
            type: 'GET'
        }).done(function(response) {
            fulfil(OperationResult.success(response));
        }).fail(function(error) {
            reject(OperationResult.failure(error.message, error.code));
        });
    });
};
var inputBuilder = new OperationInput({
    entity: employee
}).parameter(firstname).
           parameter(lastname);
var operation = new OperationBuilder({
    name: 'Read Employees',
    type: Operation.Type.READ_MANY,
    performs: functionToRun
}).returns(employee).
    takes(inputBuilder).
    build();

Using OperationBuilder.takes(..) method to specify what input parameters the build Operation accepts. In this case, input Entity is defined with three explicit parameters specified. And also supported Operators are configured based on the actual PropertyType.

var textOperators = [
    Operator.EQUALS,
    Operator.NOT_EQUALS,
    Operator.CONTAINS,
    Operator.NOT_CONTAINS,
    Operator.STARTS_WITH,
    Operator.ENDS_WITH
];
var numberOperators = [
    Operator.EQUALS,
    Operator.NOT_EQUALS,
    Operator.LESS,
    Operator.LESS_OR_EQUAL,
    Operator.MORE,
    Operator.MORE_OR_EQUAL
];
var employee = Abcs.Entities().findById('my.custom.bop.Employee');
var firstname = employee.getProperty('Firstname');   // Let's assume this is PropertyType.TEXT
var lastname = employee.getProperty('Lastname');     // Let's assume this is PropertyType.TEXT
var age = employee.getProperty('Age');               // Let's assume this is PropertyType.NUMBER
var functionToRun = function(operationData) {
    // Include REST call here which performs the real operation retrieving your Employee data
    // In this case your REST call:
    //  --> Has to be capable to manage Firstname, Lastname and Age input parameters
    //  --> Has to be capable to manage all "textOperators" for Firstname and Lastname input parameters
    //  --> Has to be capable to manage all "numberOperators" for Age input parameter
    var baseURL = 'http://example.com/employees';
    var resultURL = new MyConditionVisitor(baseURL).visit(operationData.getCondition());

    // Include REST call here which performs the real operation retrieving your Employee data
    return new Promise(function(fulfil, reject) {
        $.ajax({
            url: resultURL,
            type: 'GET'
        }).done(function(response) {
            fulfil(OperationResult.success(response));
        }).fail(function(error) {
            reject(OperationResult.failure(error.message, error.code));
        });
    });
};
var inputBuilder = new OperationInput({
    entity: employee
}).parameter(age).
    parameter(firstname).
    parameter(lastname).
    operatorsForType(PropertyType.TEXT, textOperators).
    operatorsForType(PropertyType.NUMBER, numberOperators);
var operation = new OperationBuilder({
    name: 'Read Employees',
    type: Operation.Type.READ_MANY,
    performs: functionToRun
}).returns(employee).
    takes(inputBuilder).
    build();