Package com.xwiki.task

Interface TaskMissingDataManager

@Role
public interface TaskMissingDataManager

Handles operations on task macros that have missing data.

Since:

3.3

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
List<org.xwiki.model.reference.DocumentReference>	getMissingDataTaskOwners()
default List<org.xwiki.model.reference.DocumentReference>	getMissingDataTaskOwners(int offset, int limit)
default PaginatedReferences	getPaginatedMissingDataTaskOwners(int offset, int limit)
void	inferMissingTaskData()	Some task macros, such as the ones resulted from a migration, can have some data missing.
void	inferMissingTaskData(org.xwiki.model.reference.DocumentReference documentReference)	Similar to inferMissingTaskData() only that the process is run on a given document reference.
void	relativizeReferences()	Finds any task macros that have the reference parameter as absolute values and makes them relative to the current page.

Method Detail

inferMissingTaskData

void inferMissingTaskData()
                   throws TaskException

Some task macros, such as the ones resulted from a migration, can have some data missing. This method tries to infer the missing data from the history of the page.

Throws:

TaskException - if the query to retrieve the pages has failed.

inferMissingTaskData

void inferMissingTaskData(org.xwiki.model.reference.DocumentReference documentReference)
                   throws TaskException

Similar to inferMissingTaskData() only that the process is run on a given document reference.

Parameters:

documentReference - the reference of the document that will be analyzed

Throws:

TaskException - if the retrieval of the document has failed.

getMissingDataTaskOwners

List<org.xwiki.model.reference.DocumentReference> getMissingDataTaskOwners()
                                                                    throws TaskException

Returns:

a list of pages that contain task macros with missing data.

Throws:

TaskException

getMissingDataTaskOwners

default List<org.xwiki.model.reference.DocumentReference> getMissingDataTaskOwners(int offset,
                                                                                   int limit)
                                                                            throws TaskException

Parameters:

offset - the offset of the returned list.

limit - the limit of the returned list.

Returns:

the list of pages that contain tasks macros with missing data.

Throws:

TaskException - if the retrieval of the documents failed.

getPaginatedMissingDataTaskOwners

default PaginatedReferences getPaginatedMissingDataTaskOwners(int offset,
                                                              int limit)
                                                       throws TaskException

Parameters:

offset - the offset of the returned list.

limit - the limit of the returned list.

Returns:

the paginated list of pages that contain tasks macros with missing data.

Throws:

TaskException - if the retrieval of the documents failed.

Since:

3.11.0

relativizeReferences

void relativizeReferences()
                   throws TaskException

Finds any task macros that have the reference parameter as absolute values and makes them relative to the current page. This makes the reference easier to read and allows the copying and moving of pages run smoother.

Throws:

TaskException - sad.

Since:

3.10.2