org.cyclos.services

Interface CRUDService<DTO extends EntityDTO,D extends EntityData<DTO>,DP>

Type Parameters:

DTO - The EntityDTO this service operates

All Superinterfaces:

Service

All Known Subinterfaces:

AccessClientService, AccountFeeService, AccountTypeService, AdAddressService, AdCategoryService, AdCustomFieldPossibleValueCategoryService, AdCustomFieldPossibleValueService, AdCustomFieldService, AdDeliveryMethodService, AdInterestService, AdService, AgreementService, AuthorizationLevelService, AuthorizationRoleService, BannerService, BaseCustomFieldPossibleValueCategoryService, BaseCustomFieldPossibleValueService, BaseCustomFieldService<DTO,D,DP>, ChannelConfigurationService, ChannelService, ConfigurationService, CRUDWithConfirmationPasswordService<DTO,D,DP>, CurrencyService, CustomOperationFieldPossibleValueCategoryService, CustomOperationFieldPossibleValueService, CustomOperationFieldService, CustomOperationService, CustomScheduledTaskService, CustomScriptService, CustomWebServiceService, DocumentCategoryService, DocumentCustomFieldPossibleValueCategoryService, DocumentCustomFieldPossibleValueService, DocumentCustomFieldService, DocumentService, ExtensionPointService, GeneralReferenceService, GroupService, ImportService, LanguageService, MenuEntryService, MessageCategoryService, MobilePageService, NetworkService, OperatorGroupService, OperatorService, OrderService, PasswordTypeService, PhoneService, PrincipalTypeService, ProductService, RecordCustomFieldPossibleValueCategoryService, RecordCustomFieldPossibleValueService, RecordCustomFieldService, RecordService, RecordTypeService, SmsOperationConfigurationService, StaticContentService, SystemImageCategoryService, SystemReportPreferencesService, ThemeService, TokenService, TransactionCustomFieldPossibleValueCategoryService, TransactionCustomFieldPossibleValueService, TransactionCustomFieldService, TransactionFeedbackService, TransferFeeService, TransferFilterService, TransferStatusFlowService, TransferStatusService, TransferTypeService, UserAddressService, UserCustomFieldPossibleValueCategoryService, UserCustomFieldPossibleValueService, UserCustomFieldService, UserService, VoucherConfigurationService, VoucherTypeService

public interface CRUDService<DTO extends EntityDTO,D extends EntityData<DTO>,DP>
extends Service

A CRUD service is capable of performing basic data access operations

Author:

luis

Method Summary

Modifier and Type	Method and Description
D	getData(java.lang.Long id) Returns data for details of the given entity
D	getDataForNew(DP params) Returns data for a new entity with the given context parameters
DTO	load(java.lang.Long id) Loads a DTO for the entity with the given id, ensuring that the logged user can see the record
void	remove(java.lang.Long id) Removes the entity associated with the given identifier
void	removeAll(java.util.Collection<java.lang.Long> ids) Removes the entities associated with the given identifiers
java.lang.Long	save(DTO object) Saves the given object, returning the generated identifier

Method Detail

getData

D getData(java.lang.Long id)
   throws FrameworkException

Returns data for details of the given entity

Throws:

EntityNotFoundException - When the given id is not valid (or represents a not visible entity)

FrameworkException

getDataForNew

D getDataForNew(DP params)
         throws FrameworkException

Returns data for a new entity with the given context parameters

Throws:

FrameworkException

load

DTO load(java.lang.Long id)
  throws FrameworkException

Loads a DTO for the entity with the given id, ensuring that the logged user can see the record

Throws:

EntityNotFoundException - When the entity with the given id was not found (or not visible)

FrameworkException

remove

void remove(java.lang.Long id)
     throws FrameworkException

Removes the entity associated with the given identifier

Throws:

EntityNotFoundException - When the given id is not valid (or represents a not visible entity)

ConstraintViolatedOnRemoveException - When the given id represents an entity which is referenced by other entities, and the delete is not cascaded to them

FrameworkException

removeAll

void removeAll(java.util.Collection<java.lang.Long> ids)
        throws FrameworkException

Removes the entities associated with the given identifiers

Throws:

EntityNotFoundException - When any of the given ids are not valid (or represents not visible entities)

ConstraintViolatedOnRemoveException - When any of the given ids represents an entity which is referenced by other entities, and the delete is not cascaded to them

FrameworkException

save

java.lang.Long save(DTO object)
             throws FrameworkException

Saves the given object, returning the generated identifier

Throws:

EntityNotFoundException - When the given id is not valid (or represents a not visible entity)

ValidationException - When the given object has invalid fields

DataAccessException - When a data access error prevented the object of being saved

FrameworkException