org.exoplatform.timetracker.service

Class ActivityRecordService

java.lang.Object

org.exoplatform.timetracker.service.ActivityRecordService

public class ActivityRecordService
extends java.lang.Object

A Service to access and store ActivityRecords

Version:

$Id: $Id

Author:

medamine

Constructor Summary

Constructors

Constructor and Description
ActivityRecordService(ActivityRecordStorage activityRecordstorage) Constructor for ActivityRecordService.

Method Summary

Modifier and Type	Method and Description
long	countActivityRecords(java.lang.String search, java.lang.Long activity, java.lang.Long type, java.lang.Long subType, java.lang.Long activityCode, java.lang.Long subActivityCode, java.lang.Long client, java.lang.Long project, java.lang.Long feature, java.lang.String fromDate, java.lang.String toDate, java.lang.String userName, java.lang.String location, java.lang.String office) Retrieves the list of ActivityRecordsListAccess with offset, limit and a keyword that can be empty
ActivityRecord	createActivityRecord(ActivityRecord activityRecord) Create new ActivityRecord
void	deleteActivityRecord(java.lang.Long activityRecordId, java.lang.String username) Delete ActivityRecord identified by its id and check if username has permission to delete it.
java.util.List<ActivityRecord>	getActivityRecords() Retrieves the list of ActivityRecords with offset, limit and a keyword that can be empty
RecordsAccessList	getActivityRecordsList(java.lang.String search, java.lang.Long activity, java.lang.Long type, java.lang.Long subType, java.lang.Long activityCode, java.lang.Long subActivityCode, java.lang.Long client, java.lang.Long project, java.lang.Long feature, java.lang.String fromDate, java.lang.String toDate, java.lang.String userName, java.lang.String location, java.lang.String office, int offset, int limit, java.lang.String sortBy, boolean sortDesc) Retrieves the list of ActivityRecordsListAccess with offset, limit and a keyword that can be empty
java.util.List<ActivityRecord>	getUserActivityRecordsList(java.lang.String day, java.lang.String userName) Retrieves the list of ActivityRecords wby day
ActivityRecord	updateActivityRecord(ActivityRecord activityRecord, java.lang.String username) Update an existing ActivityRecord on datasource.

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivityRecordService

public ActivityRecordService(ActivityRecordStorage activityRecordstorage)

Constructor for ActivityRecordService.

Parameters:

activityRecordstorage - a ActivityRecordStorage object.

Method Detail

createActivityRecord

public ActivityRecord createActivityRecord(ActivityRecord activityRecord)
                                    throws java.lang.Exception

Create new ActivityRecord

Parameters:

activityRecord - ActivityRecord to create

Returns:

stored ActivityRecord in datasource

Throws:

java.lang.Exception - when ActivityRecord already exists or an error occurs while creating ActivityRecord or its attached image

updateActivityRecord

public ActivityRecord updateActivityRecord(ActivityRecord activityRecord,
                                           java.lang.String username)
                                    throws java.lang.Exception

Update an existing ActivityRecord on datasource. If the ActivityRecord doesn't exit an EntityNotFoundException will be thrown.

Parameters:

activityRecord - dto to update on store

username - username storing ActivityRecord

Returns:

stored ActivityRecord in datasource

Throws:

java.lang.Exception - when Exception is thrown or an error occurs while saving ActivityRecord

deleteActivityRecord

public void deleteActivityRecord(java.lang.Long activityRecordId,
                                 java.lang.String username)
                          throws javax.persistence.EntityNotFoundException,
                                 java.lang.IllegalAccessException

Delete ActivityRecord identified by its id and check if username has permission to delete it.

Parameters:

activityRecordId - technical identifier of ActivityRecord

username - user currently deleting ActivityRecord

Throws:

javax.persistence.EntityNotFoundException - if ActivityRecord wasn't found

java.lang.IllegalAccessException - if user is not allowed to delete ActivityRecord

getActivityRecords

public java.util.List<ActivityRecord> getActivityRecords()

Retrieves the list of ActivityRecords with offset, limit and a keyword that can be empty

Returns:

List of ActivityRecord that contains the list of ActivityRecords

getActivityRecordsList

public RecordsAccessList getActivityRecordsList(java.lang.String search,
                                                java.lang.Long activity,
                                                java.lang.Long type,
                                                java.lang.Long subType,
                                                java.lang.Long activityCode,
                                                java.lang.Long subActivityCode,
                                                java.lang.Long client,
                                                java.lang.Long project,
                                                java.lang.Long feature,
                                                java.lang.String fromDate,
                                                java.lang.String toDate,
                                                java.lang.String userName,
                                                java.lang.String location,
                                                java.lang.String office,
                                                int offset,
                                                int limit,
                                                java.lang.String sortBy,
                                                boolean sortDesc)

Retrieves the list of ActivityRecordsListAccess with offset, limit and a keyword that can be empty

Parameters:

search - a String object.

activity - a Long object.

type - a Long object.

subType - a Long object.

activityCode - a Long object.

subActivityCode - a Long object.

client - a Long object.

project - a Long object.

feature - a Long object.

fromDate - a String object.

toDate - a String object.

userName - a String object.

location - a String object.

office - a String object.

offset - a int.

limit - a int.

sortBy - a String object.

sortDesc - a boolean.

Returns:

List of ActivityRecord that contains the list of ActivityRecords

countActivityRecords

public long countActivityRecords(java.lang.String search,
                                 java.lang.Long activity,
                                 java.lang.Long type,
                                 java.lang.Long subType,
                                 java.lang.Long activityCode,
                                 java.lang.Long subActivityCode,
                                 java.lang.Long client,
                                 java.lang.Long project,
                                 java.lang.Long feature,
                                 java.lang.String fromDate,
                                 java.lang.String toDate,
                                 java.lang.String userName,
                                 java.lang.String location,
                                 java.lang.String office)

Retrieves the list of ActivityRecordsListAccess with offset, limit and a keyword that can be empty

Parameters:

search - a String object.

activity - a Long object.

type - a Long object.

subType - a Long object.

activityCode - a Long object.

subActivityCode - a Long object.

client - a Long object.

project - a Long object.

feature - a Long object.

fromDate - a String object.

toDate - a String object.

userName - a String object.

location - a String object.

office - a String object.

Returns:

List of ActivityRecord that contains the list of ActivityRecords

getUserActivityRecordsList

public java.util.List<ActivityRecord> getUserActivityRecordsList(java.lang.String day,
                                                                 java.lang.String userName)

Retrieves the list of ActivityRecords wby day

Parameters:

day - day of activity

userName - a String object.

Returns:

List of ActivityRecord that contains the list of ActivityRecords