org.cyclos.services.users

Interface RecordService

All Superinterfaces:

CRUDService<RecordDTO,RecordData,RecordDataParams>, Service

All Known Subinterfaces:

RecordServiceLocal

All Known Implementing Classes:

RecordServiceSecurity

public interface RecordService
extends CRUDService<RecordDTO,RecordData,RecordDataParams>

Service interface for Records

Author:

anavarro

Method Summary

Modifier and Type	Method and Description
SerializableInputStream	exportToCSV(@NotNull RecordQuery query) Generates a CSV with the query result
java.util.List<RecordTypeCountVO>	getRecordTypeCount(@NotNull AccountOwnerLocator locator) Returns, for each visible record type, the count and permissions over records of the given owner (either system or user)
RecordSearchData	getSearchData(@NotNull RecordTypeVO recordType, UserLocatorVO locator) Returns data for searching records
SharedRecordFieldsSearchData	getSharedFieldsSearchData() Returns data for searching records with shared record fields
TiledRecordsData	getTiledRecordsData(@NotNull RecordTypeVO recordType, UserLocatorVO locator) Returns data for listing tiled records of a given user or system
RecordVO	loadVO(@NotNull java.lang.Long id) Loads a VO, by id
Page<RecordVO>	search(@NotNull RecordQuery query) Searches for records

Methods inherited from interface org.cyclos.services.CRUDService

getData, getDataForNew, load, remove, removeAll, save

Method Detail

exportToCSV

SerializableInputStream exportToCSV(@NotNull
                                    @NotNull RecordQuery query)

Generates a CSV with the query result

getRecordTypeCount

java.util.List<RecordTypeCountVO> getRecordTypeCount(@NotNull
                                                     @NotNull AccountOwnerLocator locator)
                                              throws FrameworkException

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

Throws:

FrameworkException

getSearchData

RecordSearchData getSearchData(@NotNull
                               @NotNull RecordTypeVO recordType,
                               UserLocatorVO locator)
                        throws FrameworkException

Returns data for searching records

Throws:

FrameworkException

getSharedFieldsSearchData

SharedRecordFieldsSearchData getSharedFieldsSearchData()
                                                throws FrameworkException

Returns data for searching records with shared record fields

Throws:

FrameworkException

getTiledRecordsData

TiledRecordsData getTiledRecordsData(@NotNull
                                     @NotNull RecordTypeVO recordType,
                                     UserLocatorVO locator)
                              throws FrameworkException

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

Throws:

FrameworkException

loadVO

RecordVO loadVO(@NotNull
                @NotNull java.lang.Long id)
         throws FrameworkException

Loads a VO, by id

Throws:

FrameworkException

search

Page<RecordVO> search(@NotNull
                      @NotNull RecordQuery query)
               throws FrameworkException,
                      QueryParseException

Searches for records

Throws:

FrameworkException

QueryParseException