Package org.cxbox.core.service

Interface ResponseService<T extends org.cxbox.api.data.dto.DataResponseDTO,E extends BaseEntity>

All Known Implementing Classes:

AbstractResponseService, HistoricityResponseService, VersionAwareResponseService

public interface ResponseService<T extends org.cxbox.api.data.dto.DataResponseDTO,E extends BaseEntity>

Method Summary

Modifier and Type	Method	Description
AssociateResultDTO	associate(List<org.cxbox.api.data.dto.AssociateDTO> data, BusinessComponent bc)	Сreates links between entities
long	count(BusinessComponent bc)	Returns the number of matching entities
CreateResult<T>	createEntity(BusinessComponent bc)	Creates an entity based on a business component
ActionResultDTO<T>	deleteEntity(BusinessComponent bc)	Deletes an entity based on a business component
Actions<T>	getActions()	Returns actions for entity with conditions of their availability invoked by method getAvailableActions
ActionsDTO	getAvailableActions(RowMetaType metaType, org.cxbox.api.data.dto.DataResponseDTO data, BusinessComponent bc)	Returns actions for entity with conditions of their availability invoke method getActions
Class<? extends FieldMetaBuilder<T>>	getFieldMetaBuilder()	Returns FieldMetaBuilder for class
org.cxbox.api.data.ResultPage<T>	getList(BusinessComponent bc)	Returns a list of matched objects based on a business component
T	getOne(BusinessComponent bc)	Returns object based on a business component
BaseEntity	getOneAsEntity(BusinessComponent bc)	Returns an entity based on a business component
Class<T>	getTypeOfDTO()	Returns the number of matching entities
Class<E>	getTypeOfEntity()	Returns the number of matching entities
boolean	hasPersister()	Determines whether the service interacts with an entity from the database
ActionResultDTO<T>	invokeAction(BusinessComponent bc, String actionName, org.cxbox.api.data.dto.DataResponseDTO data)	Invokes action with given name, add preactions, loads or updates entity if necessary
boolean	isDeferredCreationSupported(BusinessComponent bc)	Determines is deferred saving of new objects supported
ActionResultDTO	onCancel(BusinessComponent bc)	Returns actions invoked with cancel
ActionResultDTO<T>	preview(BusinessComponent bc, org.cxbox.api.data.dto.DataResponseDTO data)	Updates an entity based on a business component by DTO Used in forceactive fields
<V> V	unwrap(Class<V> cls)	Deprecated.
ActionResultDTO<T>	updateEntity(BusinessComponent bc, org.cxbox.api.data.dto.DataResponseDTO data)	Updates an entity based on a business component by DTO
void	validate(BusinessComponent bc, org.cxbox.api.data.dto.DataResponseDTO data)	Validates the entry on save

Method Detail

getOneAsEntity

BaseEntity getOneAsEntity(BusinessComponent bc)

Returns an entity based on a business component

Parameters:

bc - businessComponent

Returns:

BaseEntity entity

getOne

T getOne(BusinessComponent bc)

Returns object based on a business component

Parameters:

bc - businessComponent

Returns:

object

hasPersister

boolean hasPersister()

Determines whether the service interacts with an entity from the database

Returns:

true/false

getList

org.cxbox.api.data.ResultPage<T> getList(BusinessComponent bc)

Returns a list of matched objects based on a business component

Parameters:

bc - businessComponent

Returns:

list of matched objects

createEntity

CreateResult<T> createEntity(BusinessComponent bc)

Creates an entity based on a business component

Parameters:

bc - businessComponent

Returns:

CreateResult class with DataResponseDTO and postactions

updateEntity

ActionResultDTO<T> updateEntity(BusinessComponent bc,
                                org.cxbox.api.data.dto.DataResponseDTO data)

Updates an entity based on a business component by DTO

Parameters:

bc - businessComponent

data - information about entity, it's changed fields, errors

Returns:

ActionResultDTO class with DataResponseDTO and postactions

preview

ActionResultDTO<T> preview(BusinessComponent bc,
                           org.cxbox.api.data.dto.DataResponseDTO data)

Updates an entity based on a business component by DTO Used in forceactive fields

Parameters:

bc - businessComponent

data - information about entity, it's changed fields, errors

Returns:

ActionResultDTO class with DataResponseDTO and postactions

deleteEntity

ActionResultDTO<T> deleteEntity(BusinessComponent bc)

Deletes an entity based on a business component

Parameters:

bc - businessComponent

Returns:

ActionResultDTO class with DataResponseDTO and postactions

invokeAction

ActionResultDTO<T> invokeAction(BusinessComponent bc,
                                String actionName,
                                org.cxbox.api.data.dto.DataResponseDTO data)

Invokes action with given name, add preactions, loads or updates entity if necessary

Parameters:

bc - businessComponent

actionName - name of action

data - information about entity, it's changed fields, errors

Returns:

ActionResultDTO class with DataResponseDTO and postactions

associate

AssociateResultDTO associate(List<org.cxbox.api.data.dto.AssociateDTO> data,
                             BusinessComponent bc)

Сreates links between entities

Parameters:

data - information about an entity, whether the entity was associated

bc - businessComponent

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

getAvailableActions

ActionsDTO getAvailableActions(RowMetaType metaType,
                               org.cxbox.api.data.dto.DataResponseDTO data,
                               BusinessComponent bc)

Returns actions for entity with conditions of their availability invoke method getActions

Parameters:

metaType - type of meta

data - information about entity, it's changed fields, errors

bc - businessComponent

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

getActions

Actions<T> getActions()

Returns actions for entity with conditions of their availability invoked by method getAvailableActions

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

onCancel

ActionResultDTO onCancel(BusinessComponent bc)

Returns actions invoked with cancel

Parameters:

bc - businessComponent

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

getFieldMetaBuilder

Class<? extends FieldMetaBuilder<T>> getFieldMetaBuilder()

Returns FieldMetaBuilder for class

Returns:

FieldMetaBuilder class for building field meta

count

long count(BusinessComponent bc)

Returns the number of matching entities

Parameters:

bc - businessComponent

Returns:

count

getTypeOfDTO

Class<T> getTypeOfDTO()

Returns the number of matching entities

Returns:

count

getTypeOfEntity

Class<E> getTypeOfEntity()

Returns the number of matching entities

Returns:

count

validate

void validate(BusinessComponent bc,
              org.cxbox.api.data.dto.DataResponseDTO data)

Validates the entry on save

Parameters:

bc - businessComponent

data - information about entity, it's changed fields, errors

unwrap

@Deprecated
<V> V unwrap(Class<V> cls)

Deprecated.

isDeferredCreationSupported

boolean isDeferredCreationSupported(BusinessComponent bc)

Determines is deferred saving of new objects supported

Parameters:

bc - businessComponent