Module: ApplicationSet

Classes

ApplicationSetProvider

ketaApplicationSet

ketaApplicationSetInstance

Methods

• <inner> create(eventBus) → {ApplicationSetInstance}
• <inner> filter(filter) → {ApplicationSetInstance}
• <inner> get(set, index) → {ApplicationInstance}
• <inner> getAll(set) → {Array}
• <inner> indexOf(set, application) → {number}
• <inner> length(set) → {number}
• <inner> paginate(pagination) → {ApplicationSetInstance}
• <inner> project(projection) → {ApplicationSetInstance}
• <inner> query() → {promise}
• <inner> sort(sorting) → {ApplicationSetInstance}

<inner> create(eventBus) → {ApplicationSetInstance}

Creates an ApplicationSetInstance with given EventBus instance.

Parameters:

Name	Type	Description
eventBus	EventBus	EventBus instance to use for communication

Source:

• services/application-set.js, line 263

Returns:

ApplicationSetInstance ApplicationSetInstance created

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        var applicationSet = ketaApplicationSet.create(eventBus);
    });

<inner> filter(filter) → {ApplicationSetInstance}

Adds a filter before ApplicationSet query is sent to EventBus.

Parameters:

Name	Type	Description
filter	Object	filter to use

Source:

• services/application-set.js, line 46

Returns:

ApplicationSetInstance ApplicationSetInstance to chain

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus)
            .filter({
                userId: 'login'
            })
            .query()
            .then(function(reply) {
                // success handler
                // ...
            }, function(reply) {
                // error handler
                // ...
            });
    });

<inner> get(set, index) → {ApplicationInstance}

Returns application in given ApplicationSet by specified index.

Parameters:

Name	Type	Description
set	ApplicationSetInstance	ApplicationSetInstance to search in
index	number	Index of application to return

Source:

• services/application-set.js, line 342

Returns:

ApplicationInstance ApplicationInstance retrieved from set

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus).query()
            .then(function(reply) {
                // application equals first item after the call
                var application = ketaApplicationSet.get(reply, 0);
            });
    });

<inner> getAll(set) → {Array}

Returns all applications in given ApplicationSet.

Parameters:

Name	Type	Description
set	ApplicationSetInstance	ApplicationSetInstance to search in

Source:

• services/application-set.js, line 370

Returns:

Array All ApplicationInstances retrieved from set

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus).query()
            .then(function(reply) {
                var applications = ketaApplicationSet.getAll(reply);
            });
    });

<inner> indexOf(set, application) → {number}

Returns index of given Application in ApplicationSet by comparing app IDs.

Parameters:

Name	Type	Description
set	ApplicationSetInstance	ApplicationSetInstance to search in
application	ApplicationInstance	ApplicationInstance to search for

Source:

• services/application-set.js, line 282

Returns:

number index

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus).query()
            .then(function(reply) {
                // index equals 0 after the call
                var index = ketaApplicationSet.indexOf(reply, reply.result.items[0]);
            });
    });

<inner> length(set) → {number}

Returns number of applications in given ApplicationSet.

Parameters:

Name	Type	Description
set	ApplicationSetInstance	ApplicationSetInstance to search in

Source:

• services/application-set.js, line 315

Returns:

number number of applications

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus).query()
            .then(function(reply) {
                // length equals number of applications in ApplicationSet
                var length = ketaApplicationSet.length(reply);
            });
    });

<inner> paginate(pagination) → {ApplicationSetInstance}

Adds a pagination before ApplicationSet query is sent to EventBus.

Parameters:

Name	Type	Description
pagination	Object	pagination to use

Source:

• services/application-set.js, line 145

Returns:

ApplicationSetInstance ApplicationSetInstance to chain

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus)
            .filter({
                userId: 'login'
            })
            .paginate({
                offset: 0,
                limit: 50
            })
            .query()
            .then(function(reply) {
                // success handler
                // ...
            }, function(reply) {
                // error handler
                // ...
            });
    });

<inner> project(projection) → {ApplicationSetInstance}

Adds a projection before ApplicationSet query is sent to EventBus.

Parameters:

Name	Type	Description
projection	Object	projection to use

Source:

• services/application-set.js, line 77

Returns:

ApplicationSetInstance ApplicationSetInstance to chain

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus)
            .filter({
                userId: 'login'
            })
            .project({
                appId: 1
            })
            .query()
            .then(function(reply) {
                // success handler
                // ...
            }, function(reply) {
                // error handler
                // ...
            });
    });

<inner> query() → {promise}

Finally executes ApplicationSet query by sending it to the associated EventBus instance.

Source:

• services/application-set.js, line 186

Returns:

promise Promise which is resolved when query is returned

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus)
            .filter({
                userId: 'login'
            })
            .query()
            .then(function(reply) {
                // success handler
                // ...
            }, function(reply) {
                // error handler
                // ...
            });
    });

<inner> sort(sorting) → {ApplicationSetInstance}

Adds a sorting before ApplicationSet query is sent to EventBus.

Parameters:

Name	Type	Description
sorting	Object	sorting to use

Source:

• services/application-set.js, line 111

Returns:

ApplicationSetInstance ApplicationSetInstance to chain

Example

angular.module('exampleApp', ['keta.services.ApplicationSet'])
    .controller('ExampleController', function(ketaApplicationSet) {
        ketaApplicationSet.create(eventBus)
            .filter({
                userId: 'login'
            })
            .sort({
                'appId': 1
            })
            .query()
            .then(function(reply) {
                // success handler
                // ...
            }, function(reply) {
                // error handler
                // ...
            });
    });