NAME
Kernel::WebApp::Controller::API::Role::ProvidesBusinessObjects – Role that provides methods to manage business object list content.
PUBLIC INTERFACE
has BusinessObject
This attribute contains the business object.
has BusinessObjectTypeObject
This attribute contains the list of active filters.
has ActiveFilters
This attribute contains the list of active filters.
has AvailableDynamicFieldFilters
This attribute contains the list of dynamic fields which should be possible as a filter.
has AdditionalBusinessObjectParams
This attribute contains the additional business object params for the business type object.
requires BusinessObjectType
Every endpoint that consumes the business object roles, must implement a method BusinessObjectType
, this method provides the business object type name.
around ValidationJSONBodyFields
Injects validators
to the validation schema for needed business object list related fields. For more information, please refer to Kernel::WebApp::Controller::API::Role::ValidatesInputData.
DataValidate()
On 'DataValidate' phase, we check if the active filters are allowed.
SortingByGet()
This method generates the sorting information for the item search.
my %Sorting = $Self->SortingByGet();
Returns:
(
SortBy => [ 'CreateTime' ],
OrderBy => [ 'Up' ],
)
PRIVATE INTERFACE
_BuildActiveFilters()
Initializes the attribute ActiveFilters
.
PRIVATE INTERFACE
_BuildBusinessObjectTypeObject()
Initializes the attribute BusinessObjectTypeObject
.
_BuildBusinessObject()
Initializes the attribute BusinessObject
.
_BuildAvailableDynamicFieldFilters()
Initializes the attribute AvailableDynamicFieldFilters
.
_BuildAdditionalBusinessObjectParams()
Initializes the attribute AdditionalBusinessObjectParams
.