Package org.cxbox.core.crudma.impl

Class AbstractCrudmaService

java.lang.Object

org.cxbox.core.crudma.impl.AbstractCrudmaService

All Implemented Interfaces:

Crudma

Direct Known Subclasses:

BcCrudmaService, InnerCrudmaService, UniversalCrudmaService

public abstract class AbstractCrudmaService
extends Object
implements Crudma

Constructor Summary

Constructors

Constructor	Description
AbstractCrudmaService()

Method Summary

Modifier and Type	Method	Description
AssociateResultDTO	associate(BusinessComponent bc, List<org.cxbox.api.data.dto.AssociateDTO> data)	Creates links between entities
protected MetaDTO	buildMeta(List<org.cxbox.api.data.dto.rowmeta.FieldDTO> fields)
protected MetaDTO	buildMeta(List<org.cxbox.api.data.dto.rowmeta.FieldDTO> fields, ActionsDTO actions)
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
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 data)	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 java.lang.Object

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

Constructor Detail

AbstractCrudmaService

public AbstractCrudmaService()

Method Detail

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

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

Parameters:

bc - businessComponent

Returns:

ResultPage class with list of objects

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

Parameters:

bc - businessComponent

Returns:

CreateResult class with DataResponseDTO and postactions

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

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

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

Parameters:

bc - businessComponent

Returns:

ActionResultDTO 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

Parameters:

bc - businessComponent

actionName - name of action

data - information about entity

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

Parameters:

bc - businessComponent

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

Returns:

AssociateResultDTO class with DataResponseDTO and postactions

getMetaNew

public MetaDTO getMetaNew(BusinessComponent bc,
                          CreateResult data)

Description copied from interface: Crudma

Returns new meta for entity based on a business component

Specified by:

getMetaNew in interface Crudma

Parameters:

bc - businessComponent

data - 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

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

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

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

Parameters:

bc - businessComponent

Returns:

count

buildMeta

protected MetaDTO buildMeta(List<org.cxbox.api.data.dto.rowmeta.FieldDTO> fields)

buildMeta

protected MetaDTO buildMeta(List<org.cxbox.api.data.dto.rowmeta.FieldDTO> fields,
                            ActionsDTO actions)