Package org.cyclos.impl.users

Class RecordServiceImpl

java.lang.Object

org.cyclos.impl.AbstractServerComponent

org.cyclos.impl.AbstractNetworkedServerComponent

org.cyclos.impl.BaseServiceImpl

org.cyclos.impl.CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

org.cyclos.impl.users.RecordServiceImpl

All Implemented Interfaces:

CRUDServiceLocal<Record,RecordDTO,RecordData,RecordDataParams>, RecordServiceLocal, CRUDService<RecordDTO,RecordData,RecordDataParams>, CRUDWithConfirmationPasswordService<RecordDTO,RecordData,RecordDataParams>, Service, RecordService

@Service
public class RecordServiceImpl
extends CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>
implements RecordServiceLocal

implementation for RecordService

Field Summary

Fields

Modifier and Type	Field	Description
protected CustomOperationServiceLocal	customOperationService

Fields inherited from class org.cyclos.impl.CRUDServiceImpl

$, ATTR_CURRENT_COPY, cacheHandler, dtoClass, entityClass, extensionPointService, idPath, internalNamePath, namePath, ownerEntityIdPath, ownerEntityPath, ownerEntityPropertyName, passwordHandler, richTextHandler, withConfirmationPassword

Fields inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

authHandler, conversionHandler, entityManagerHandler, groupsHandler, productsHandler, restBeanPropertyMapping, userLocatorHandler

Fields inherited from class org.cyclos.impl.AbstractServerComponent

accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Fields inherited from interface org.cyclos.impl.users.RecordServiceLocal

ATTR_RECORD_TYPE, ATTR_USER

Constructor Summary

Constructors

Constructor	Description
RecordServiceImpl()

Method Summary

Modifier and Type	Method	Description
boolean	canChangeToSingleForm(RecordType recordType)	Returns true if the record type can be changed to single form layout.
protected void	doRemove(Record record, boolean flush)	May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well
FileInfo	exportRecords(@NotNull ExportFormatVO formatVO, @NotNull RecordQuery query)	Generates a file with the query result
protected RecordData	getData(Record record)	Returns details data for the given entity
int	getRecordsCount(SystemRecordType type)	Returns the count for system records of the given type
int	getRecordsCount(UserRecordType type, User user)	Returns the count for records of the given type and user
List<RecordTypeCountVO>	getRecordTypeCount(User user)	Returns a list with the visible record types by the logged user of the given user
List<RecordTypeCountVO>	getRecordTypeCount(InternalAccountOwner owner)	Returns, for each visible record type, the count and permissions over records of the given owner (either system or user)
RecordSearchData	getSearchData(RecordTypeVO recordTypeVO, UserLocatorVO locator)	Returns data for searching records, if the given locator is null it returns system record data
SharedRecordFieldsSearchData	getSharedFieldsSearchData()	Returns data for searching records with shared record fields
List<UserRecordType>	getSharedSearchableRecordTypes()	Returns the record types that has at least one searchable shared record custom field
SystemRecord	getSingleFormRecord(SystemRecordType rt)	Returns the record for this single form system record type
UserRecord	getSingleFormRecord(UserRecordType rt, User user)	Returns the record for this single form user record type
List<RecordTypeCountVO>	getSystemRecordTypeCount()	Returns a list with the visible system record types by the logged user
TiledRecordsData	getTiledRecordsData(RecordTypeVO recordTypeVO, UserLocatorVO locator)	Returns data for listing tiled records of a given user or system
boolean	hasRecordCustomFieldValue(RecordType type, RecordCustomField field)	Returns true if there is at least one record custom field value for the given type and field. This method accept a shared custom field as parameter.
List<SystemRecord>	listSystem(SystemRecordType recordType)	Lists the system records for the given type
List<UserRecord>	listUser(UserRecordType recordType, User user)	Lists the user records for the given type and user
RecordVO	loadVO(Long id)	Loads a VO, by id
Record	newEntity(RecordDataParams params)	Should be implemented in order to instantiate a new entity based on the given context parameters
protected void	onAfterSave(Record record, Record currentCopy, Object dataFromOnBeforeSave)	May be overridden in order to perform custom logic after saving an entity
protected Object	onBeforeSave(Record record, Record currentCopy)	May be overridden in order to perform custom logic before saving an entity.
protected void	preProcessCurrentCopy(RecordDTO dto, Record currentCopy)	This method is invoked before saving the entity and also, if the log is enabled, before removing.
void	purgeAll(User user)	Removes all user records of the given user whose types are set to remove records when purging users
protected void	registerNetworkMappings(NetworkPathRegistry networkPathRegistry)	Needs to be overridden by subclasses to register the path up to the network
protected ExtensionPointAccessor	resolveExtensionPointAccessor(CRUDOperation operation, Record record)	Should be overridden by subclasses which have extension points
protected Validator	resolveValidator(RecordDTO dto)
Page<RecordVO>	search(RecordQuery params)	Searches for records
protected org.apache.commons.collections4.BidiMap<Class<? extends Record>,Class<? extends RecordDTO>>	subClassMappings()	Should be overridden by subclasses which handle entity / dto hierarchies.
RecordDTO	toDTO(Record record)	Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Methods inherited from class org.cyclos.impl.CRUDServiceImpl

addCustomInternalNameValidations, addCustomNameValidations, checkConfirmationPassword, find, findAll, from, getConfirmationPasswordInput, getConfirmationPasswordInputForRemove, getData, getDataForNew, getDeviceConfirmationParams, getEntityClass, getEntityInternalNameKey, getExcludedPropertiesToDTO, getExcludedPropertiesToEntity, getNameLabel, getUniqueInternalNameQuery, getUniqueNameQuery, isEntityInternalNameRequired, isNameRequired, load, logEntity, onAfterRemove, onBeforeRemove, remove, remove, removeAll, removeAll, removeAllWithConfirmationPassword, removeWithConfirmationPassword, resolveDTOType, resolveEntityType, save, saveOrder, saveSkippingEntityLog, saveWithConfirmationPassword, shouldCheckConfirmationPassword, toEntity, validate

Methods inherited from class org.cyclos.impl.BaseServiceImpl

initializeNetworkMappings

Methods inherited from class org.cyclos.impl.AbstractNetworkedServerComponent

canManage, checkManagesUser, checkPermission, checkRelatesToUser, checkValue, clearAlreadyValidated, getBaseEntityManagerHandler, getConfiguration, getLoggedBasicUser, getLoggedUser, getProducts, getTranslatedName, getTranslatedValue, hasPermission, hasValue, inSameNetwork, inSameNetworkOrGlobal, isAdmin, isAlreadyValidated, isBroker, isGlobalAdmin, isGlobalAdminInNetwork, isGuest, isLoggedIn, isMember, isMemberOnly, isNetworkAdmin, isOperator, isRelatedToUser, isSystem, isUserManager, isUserManagerOf, message, message, permission, permission, permissionOptionalValue, permissionOptionalValue, setAlreadyValidated, toDate, toDateTime, validate

Methods inherited from class org.cyclos.impl.AbstractServerComponent

dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Methods inherited from interface org.cyclos.impl.CRUDServiceLocal

find, findAll, getEntityClass, remove, removeAll, saveEntity, saveSkippingEntityLog, toEntity, validate

Field Detail

customOperationService

@Autowired
protected CustomOperationServiceLocal customOperationService

Constructor Detail

RecordServiceImpl

public RecordServiceImpl()

Method Detail

canChangeToSingleForm

public boolean canChangeToSingleForm(RecordType recordType)

Description copied from interface: RecordServiceLocal

Returns true if the record type can be changed to single form layout.

Specified by:

canChangeToSingleForm in interface RecordServiceLocal

exportRecords

public FileInfo exportRecords(@NotNull
                              @NotNull ExportFormatVO formatVO,
                              @NotNull
                              @NotNull RecordQuery query)

Description copied from interface: RecordService

Generates a file with the query result

Specified by:

exportRecords in interface RecordService

getRecordsCount

public int getRecordsCount(SystemRecordType type)

Description copied from interface: RecordServiceLocal

Returns the count for system records of the given type

Specified by:

getRecordsCount in interface RecordServiceLocal

getRecordsCount

public int getRecordsCount(UserRecordType type,
                           User user)

Description copied from interface: RecordServiceLocal

Returns the count for records of the given type and user

Specified by:

getRecordsCount in interface RecordServiceLocal

getRecordTypeCount

public List<RecordTypeCountVO> getRecordTypeCount(InternalAccountOwner owner)
                                           throws FrameworkException

Description copied from interface: RecordService

Returns, for each visible record type, the count and permissions over records of the given owner (either system or user)

Specified by:

getRecordTypeCount in interface RecordService

Throws:

FrameworkException

getRecordTypeCount

public List<RecordTypeCountVO> getRecordTypeCount(User user)

Description copied from interface: RecordServiceLocal

Returns a list with the visible record types by the logged user of the given user

Specified by:

getRecordTypeCount in interface RecordServiceLocal

getSearchData

public RecordSearchData getSearchData(RecordTypeVO recordTypeVO,
                                      UserLocatorVO locator)

Description copied from interface: RecordService

Returns data for searching records, if the given locator is null it returns system record data

Specified by:

getSearchData in interface RecordService

getSharedFieldsSearchData

public SharedRecordFieldsSearchData getSharedFieldsSearchData()

Description copied from interface: RecordService

Returns data for searching records with shared record fields

Specified by:

getSharedFieldsSearchData in interface RecordService

getSharedSearchableRecordTypes

public List<UserRecordType> getSharedSearchableRecordTypes()

Description copied from interface: RecordServiceLocal

Returns the record types that has at least one searchable shared record custom field

Specified by:

getSharedSearchableRecordTypes in interface RecordServiceLocal

getSingleFormRecord

public SystemRecord getSingleFormRecord(SystemRecordType rt)

Description copied from interface: RecordServiceLocal

Returns the record for this single form system record type

Specified by:

getSingleFormRecord in interface RecordServiceLocal

getSingleFormRecord

public UserRecord getSingleFormRecord(UserRecordType rt,
                                      User user)

Description copied from interface: RecordServiceLocal

Returns the record for this single form user record type

Specified by:

getSingleFormRecord in interface RecordServiceLocal

getSystemRecordTypeCount

public List<RecordTypeCountVO> getSystemRecordTypeCount()

Description copied from interface: RecordServiceLocal

Returns a list with the visible system record types by the logged user

Specified by:

getSystemRecordTypeCount in interface RecordServiceLocal

getTiledRecordsData

public TiledRecordsData getTiledRecordsData(RecordTypeVO recordTypeVO,
                                            UserLocatorVO locator)

Description copied from interface: RecordService

Returns data for listing tiled records of a given user or system

Specified by:

getTiledRecordsData in interface RecordService

hasRecordCustomFieldValue

public boolean hasRecordCustomFieldValue(RecordType type,
                                         RecordCustomField field)

Description copied from interface: RecordServiceLocal

Returns true if there is at least one record custom field value for the given type and field.
This method accept a shared custom field as parameter.

Specified by:

hasRecordCustomFieldValue in interface RecordServiceLocal

listSystem

public List<SystemRecord> listSystem(SystemRecordType recordType)

Description copied from interface: RecordServiceLocal

Lists the system records for the given type

Specified by:

listSystem in interface RecordServiceLocal

listUser

public List<UserRecord> listUser(UserRecordType recordType,
                                 User user)

Description copied from interface: RecordServiceLocal

Lists the user records for the given type and user

Specified by:

listUser in interface RecordServiceLocal

loadVO

public RecordVO loadVO(Long id)
                throws FrameworkException

Description copied from interface: RecordService

Loads a VO, by id

Specified by:

loadVO in interface RecordService

Throws:

FrameworkException

newEntity

public Record newEntity(RecordDataParams params)

Description copied from class: CRUDServiceImpl

Should be implemented in order to instantiate a new entity based on the given context parameters

Specified by:

newEntity in interface CRUDServiceLocal<Record,RecordDTO,RecordData,RecordDataParams>

Specified by:

newEntity in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

purgeAll

public void purgeAll(User user)

Description copied from interface: RecordServiceLocal

Removes all user records of the given user whose types are set to remove records when purging users

Specified by:

purgeAll in interface RecordServiceLocal

search

public Page<RecordVO> search(RecordQuery params)
                      throws QueryParseException

Description copied from interface: RecordService

Searches for records

Specified by:

search in interface RecordService

Throws:

QueryParseException

toDTO

public RecordDTO toDTO(Record record)

Description copied from class: CRUDServiceImpl

Converts the given entity in a DTO, handling the CRUDServiceImpl.subClassMappings() mappings for subclasses

Specified by:

toDTO in interface CRUDServiceLocal<Record,RecordDTO,RecordData,RecordDataParams>

Overrides:

toDTO in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

doRemove

protected void doRemove(Record record,
                        boolean flush)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform logical removing, instead of physical removing, or to remove some extra relationships as well

Overrides:

doRemove in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

getData

protected RecordData getData(Record record)

Description copied from class: CRUDServiceImpl

Returns details data for the given entity

Specified by:

getData in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

onAfterSave

protected void onAfterSave(Record record,
                           Record currentCopy,
                           Object dataFromOnBeforeSave)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic after saving an entity

Overrides:

onAfterSave in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

onBeforeSave

protected Object onBeforeSave(Record record,
                              Record currentCopy)

Description copied from class: CRUDServiceImpl

May be overridden in order to perform custom logic before saving an entity. Any returned value will be passed to the CRUDServiceImpl.onAfterSave(BaseEntity, BaseEntity, Object) method

Overrides:

onBeforeSave in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

preProcessCurrentCopy

protected void preProcessCurrentCopy(RecordDTO dto,
                                     Record currentCopy)

Description copied from class: CRUDServiceImpl

This method is invoked before saving the entity and also, if the log is enabled, before removing. Subclasses can override it to fetch lazy relationships, etc as the current copy will be detached. In case of removing (i.e the log is enabled for this entity) the dto parameter will be null.

Overrides:

preProcessCurrentCopy in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

registerNetworkMappings

protected void registerNetworkMappings(NetworkPathRegistry networkPathRegistry)

Description copied from class: BaseServiceImpl

Needs to be overridden by subclasses to register the path up to the network

Specified by:

registerNetworkMappings in class BaseServiceImpl

resolveExtensionPointAccessor

protected ExtensionPointAccessor resolveExtensionPointAccessor(CRUDOperation operation,
                                                               Record record)

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which have extension points

Overrides:

resolveExtensionPointAccessor in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

resolveValidator

protected Validator resolveValidator(RecordDTO dto)

Specified by:

resolveValidator in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>

subClassMappings

protected org.apache.commons.collections4.BidiMap<Class<? extends Record>,Class<? extends RecordDTO>> subClassMappings()

Description copied from class: CRUDServiceImpl

Should be overridden by subclasses which handle entity / dto hierarchies. The map key should be the entity class, while the map value, the DTO class

Overrides:

subClassMappings in class CRUDServiceImpl<Record,QRecord,RecordDTO,RecordData,RecordDataParams>