Package org.cxbox.core.crudma.impl.inner

Class AnySourceCrudmaService

java.lang.Object

org.cxbox.core.crudma.impl.AbstractCrudmaService

org.cxbox.core.crudma.impl.inner.AnySourceCrudmaService

All Implemented Interfaces:

Crudma

@Service
public class AnySourceCrudmaService
extends AbstractCrudmaService

Constructor Summary

Constructors

Constructor	Description
AnySourceCrudmaService()

Method Summary

Modifier and Type	Method	Description
AssociateResultDTO	associate(BusinessComponent bc, List<org.cxbox.api.data.dto.AssociateDTO> data)	Creates links between entities
long	count(BusinessComponent bc)	Returns the number of matching entities
CreateResult	create(BusinessComponent bc)	Creates an entity based on a business component
ActionResultDTO	delete(BusinessComponent bc)	Deletes an entity based on a business component
org.cxbox.api.data.dto.DataResponseDTO	get(BusinessComponent bc)	Returns object based on a business component
Actions	getActions(BcDescription bcDescription)	Recommended way to build actions.
org.cxbox.api.data.ResultPage<? extends org.cxbox.api.data.dto.DataResponseDTO>	getAll(BusinessComponent bc)	Returns all matched objects based on a business component
MetaDTO	getMeta(BusinessComponent bc)	Returns meta for entity based on a business component
MetaDTO	getMetaEmpty(BusinessComponent bc)	Returns empty meta for entity based on a business component
MetaDTO	getMetaNew(BusinessComponent bc, CreateResult createResult)	Returns new meta for entity based on a business component
MetaDTO	getOnFieldUpdateMeta(BusinessComponent bc, org.cxbox.api.data.dto.DataResponseDTO dto)	Returns on-field-update meta for entity based on a business component
ActionResultDTO	invokeAction(BusinessComponent bc, String actionName, Map<String,Object> data)	Invokes action with given name, add preactions, loads or updates entity if necessary
org.cxbox.api.data.dto.rowmeta.PreviewResult	preview(BusinessComponent bc, Map<String,Object> data)	Updates an entity based on a business component by map Used in forceactive fields
ActionResultDTO	update(BusinessComponent bc, Map<String,Object> data)	Updates an entity based on a business component by map

Methods inherited from class org.cxbox.core.crudma.impl.AbstractCrudmaService

buildMeta, buildMeta

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AnySourceCrudmaService

public AnySourceCrudmaService()

Method Details

create

public CreateResult create(BusinessComponent bc)

Description copied from interface: Crudma

Creates an entity based on a business component

Specified by:

create in interface Crudma

Overrides:

create in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

CreateResult class with DataResponseDTO and postactions

get

public org.cxbox.api.data.dto.DataResponseDTO get(BusinessComponent bc)

Description copied from interface: Crudma

Returns object based on a business component

Specified by:

get in interface Crudma

Overrides:

get in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

DataResponseDTO information about entity, it's changed fields, errors

getAll

public org.cxbox.api.data.ResultPage<? extends org.cxbox.api.data.dto.DataResponseDTO> getAll(BusinessComponent bc)

Description copied from interface: Crudma

Returns all matched objects based on a business component

Specified by:

getAll in interface Crudma

Overrides:

getAll in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

ResultPage class with list of objects

preview

public org.cxbox.api.data.dto.rowmeta.PreviewResult preview(BusinessComponent bc,
 Map<String,Object> data)

Description copied from interface: Crudma

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

Specified by:

preview in interface Crudma

Overrides:

preview in class AbstractCrudmaService

Parameters:

bc - businessComponent

data - information about entity

Returns:

PreviewResult class with DataResponseDTO

update

public ActionResultDTO update(BusinessComponent bc,
 Map<String,Object> data)

Description copied from interface: Crudma

Updates an entity based on a business component by map

Specified by:

update in interface Crudma

Overrides:

update in class AbstractCrudmaService

Parameters:

bc - businessComponent

data - information about entity

Returns:

ActionResultDTO class with DataResponseDTO and postactions

delete

public ActionResultDTO delete(BusinessComponent bc)

Description copied from interface: Crudma

Deletes an entity based on a business component

Specified by:

delete in interface Crudma

Overrides:

delete in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

ActionResultDTO class with DataResponseDTO and postactions

associate

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

Description copied from interface: Crudma

Creates links between entities

Specified by:

associate in interface Crudma

Overrides:

associate in class AbstractCrudmaService

Parameters:

bc - businessComponent

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

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

invokeAction

public ActionResultDTO invokeAction(BusinessComponent bc,
 String actionName,
 Map<String,Object> data)

Description copied from interface: Crudma

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

Specified by:

invokeAction in interface Crudma

Overrides:

invokeAction in class AbstractCrudmaService

Parameters:

bc - businessComponent

actionName - name of action

data - information about entity

Returns:

ActionResultDTO class with DataResponseDTO and postactions

getMetaNew

public MetaDTO getMetaNew(BusinessComponent bc,
 CreateResult createResult)

Description copied from interface: Crudma

Returns new meta for entity based on a business component

Specified by:

getMetaNew in interface Crudma

Overrides:

getMetaNew in class AbstractCrudmaService

Parameters:

bc - businessComponent

createResult - class with DataResponseDTO and postactions

Returns:

MetaDTO class with meta DTO and postactions

getMeta

public MetaDTO getMeta(BusinessComponent bc)

Description copied from interface: Crudma

Returns meta for entity based on a business component

Specified by:

getMeta in interface Crudma

Overrides:

getMeta in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

MetaDTO class with meta DTO and postactions

getMetaEmpty

public MetaDTO getMetaEmpty(BusinessComponent bc)

Description copied from interface: Crudma

Returns empty meta for entity based on a business component

Specified by:

getMetaEmpty in interface Crudma

Overrides:

getMetaEmpty in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

MetaDTO class with meta DTO and postactions

getOnFieldUpdateMeta

public MetaDTO getOnFieldUpdateMeta(BusinessComponent bc,
 org.cxbox.api.data.dto.DataResponseDTO dto)

Description copied from interface: Crudma

Returns on-field-update meta for entity based on a business component

Specified by:

getOnFieldUpdateMeta in interface Crudma

Overrides:

getOnFieldUpdateMeta in class AbstractCrudmaService

Parameters:

bc - businessComponent

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

Returns:

MetaDTO class with meta DTO and postactions

count

public long count(BusinessComponent bc)

Description copied from interface: Crudma

Returns the number of matching entities

Specified by:

count in interface Crudma

Overrides:

count in class AbstractCrudmaService

Parameters:

bc - businessComponent

Returns:

count

getActions

public Actions getActions(BcDescription bcDescription)

Description copied from interface: Crudma

Recommended way to build actions. Usually used in getMeta, getMetaNew, getMetaEmpty implicitly (but can be enriched with other actions not listed in getActions (from external systems for example), so potentially getActions does not return FULL list of actions)

Specified by:

getActions in interface Crudma

Overrides:

getActions in class AbstractCrudmaService

Returns: