NAME

Kernel::WebApp::Controller::API::Role::ProvidesBusinessObjectCount – Role that provides methods to manage business object count content.

PUBLIC INTERFACE

Provides methods to manage business object list content. The role consumer has to provide the method ValidationJSONBodyFields of role Kernel::WebApp::Controller::API::Role::ValidatesInputData, that will be extended with needed parameters to be validated.

has ItemCount

This attribute contains the count of items, that are provided via the ItemSearchCount method by the related endpoint.

requires ItemSearchCount

Every endpoint that consumes this role, must implement a method ItemSearchCount, provides the count of items to be displayed in the related business object list.

BusinessObjectCount()

This method builds the return hash of an business object count.

Returns:

    {
        Count => 5,
    }