Constructor and Description |
---|
TaskQueryImpl() |
Modifier and Type | Method and Description |
---|---|
long |
createTaskQuery(curam.core.sl.struct.TaskQueryDetails details)
Creates a task query.
|
long |
modifyTaskQuery(curam.core.sl.struct.TaskQueryDetails details)
Modifies a task query's criteria.
|
curam.core.sl.struct.TaskQueryResult |
runTaskQuery(curam.core.sl.entity.struct.QueryKey key,
curam.core.sl.struct.ReadMultiOperationDetails readMultiDetails)
Runs a task query that has been previously saved.
|
curam.core.sl.struct.TaskQueryResult |
runTaskQuery(curam.core.sl.struct.TaskQueryDetails details,
curam.core.sl.struct.ReadMultiOperationDetails readMultiDetails)
Runs a task query using the criteria details as entered by the user.
|
void |
validateTaskQuery(curam.core.sl.struct.TaskQueryDetails details)
Validates the task query criteria before performing a search.
|
public long createTaskQuery(curam.core.sl.struct.TaskQueryDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
createTaskQuery
in interface TaskQuery
details
- The task query criteria for a query.curam.util.exception.AppException
curam.util.exception.InformationalException
validateTaskQuery(TaskQueryDetails)
public long modifyTaskQuery(curam.core.sl.struct.TaskQueryDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
modifyTaskQuery
in interface TaskQuery
details
- The task query criteria to replace the existing criteria.curam.util.exception.AppException
curam.util.exception.InformationalException
validateTaskQuery(TaskQueryDetails)
public curam.core.sl.struct.TaskQueryResult runTaskQuery(curam.core.sl.entity.struct.QueryKey key, curam.core.sl.struct.ReadMultiOperationDetails readMultiDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
The number of tasks that returned may be limited. This may be changed by
altering the ENV_INBOX_MAX_TASK_LIST_SIZE
application property. The default is 100. If
the number of records exceeds the specified maximum value then an
informational message is returned (
INF_READMULTI_MAX_EXCEEDED
) informing the user that more records exist.
By default the returned tasks are ordered deadline time in ascending order
using the sort class TaskSortByDeadlineAscending
. The sort order can be changed by using Guice
to bind TaskSort
to another sort class.
runTaskQuery
in interface TaskQuery
key
- The identifier of the task query.readMultiDetails
- Specifies the maximum size of the return list.curam.util.exception.AppException
curam.util.exception.InformationalException
public curam.core.sl.struct.TaskQueryResult runTaskQuery(curam.core.sl.struct.TaskQueryDetails details, curam.core.sl.struct.ReadMultiOperationDetails readMultiDetails) throws curam.util.exception.AppException, curam.util.exception.InformationalException
The number of tasks that returned may be limited. This may be changed by
altering the ENV_INBOX_MAX_TASK_LIST_SIZE
application property. The default is 100. If
the number of records exceeds the specified maximum value then an
informational message is returned (
INF_READMULTI_MAX_EXCEEDED
) informing the user that more records exist.
By default the returned tasks are ordered deadline time in ascending order
using the sort class TaskSortByDeadlineAscending
. The sort order can be changed by using Guice
to bind TaskSort
to another sort class.
runTaskQuery
in interface TaskQuery
details
- The identifier of the task query.readMultiDetails
- Specifies the maximum size of the return list.curam.util.exception.AppException
curam.util.exception.InformationalException
public void validateTaskQuery(curam.core.sl.struct.TaskQueryDetails details) throws curam.util.exception.AppException, curam.util.exception.InformationalException
The validations executed are:
validateTaskQuery
in interface TaskQuery
details
- The task query criteria.curam.util.exception.AppException
curam.util.exception.InformationalException
modifyTaskQuery(TaskQueryDetails)
,
createTaskQuery(TaskQueryDetails)