Package org.cyclos.impl.users

Interface RecordServiceLocal

All Superinterfaces:

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

All Known Implementing Classes:

RecordServiceImpl

public interface RecordServiceLocal
extends CRUDServiceLocal<Record,RecordDTO,RecordData,RecordDataParams>, RecordService

Local interface for RecordService

Field Summary

Fields

Modifier and Type	Field	Description
static String	ATTR_RECORD_TYPE	Attribute name for scripting: The record type being searched
static String	ATTR_USER	Attribute name for scripting: The user in which records are being searched

Method Summary

Modifier and Type	Method	Description
boolean	canChangeToSingleForm(RecordType recordType)	Returns true if the record type can be changed to single form layout.
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<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
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
void	purgeAll(User user)	Removes all user records of the given user whose types are set to remove records when purging users

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, newEntity, remove, removeAll, saveEntity, saveSkippingEntityLog, toDTO, toEntity, validate

Methods inherited from interface org.cyclos.services.users.RecordService

exportRecords, getRecordTypeCount, getSearchData, getSharedFieldsSearchData, getTiledRecordsData, loadVO, search

Field Detail

ATTR_USER

static final String ATTR_USER

Attribute name for scripting: The user in which records are being searched

See Also:

Constant Field Values

ATTR_RECORD_TYPE

static final String ATTR_RECORD_TYPE

Attribute name for scripting: The record type being searched

See Also:

Constant Field Values

Method Detail

canChangeToSingleForm

boolean canChangeToSingleForm(RecordType recordType)

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

getRecordsCount

int getRecordsCount(SystemRecordType type)

Returns the count for system records of the given type

getRecordsCount

int getRecordsCount(UserRecordType type,
                    User user)

Returns the count for records of the given type and user

getRecordTypeCount

List<RecordTypeCountVO> getRecordTypeCount(User user)

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

getSharedSearchableRecordTypes

List<UserRecordType> getSharedSearchableRecordTypes()

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

getSingleFormRecord

SystemRecord getSingleFormRecord(SystemRecordType rt)

Returns the record for this single form system record type

getSingleFormRecord

UserRecord getSingleFormRecord(UserRecordType rt,
                               User user)

Returns the record for this single form user record type

getSystemRecordTypeCount

List<RecordTypeCountVO> getSystemRecordTypeCount()

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

hasRecordCustomFieldValue

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.

listSystem

List<SystemRecord> listSystem(SystemRecordType recordType)

Lists the system records for the given type

listUser

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

Lists the user records for the given type and user

purgeAll

void purgeAll(User user)

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