Package com.xwiki.macros.confluence

Class ConfluenceDetailsScriptService

java.lang.Object

com.xwiki.macros.confluence.ConfluenceDetailsScriptService

All Implemented Interfaces:

org.xwiki.script.service.ScriptService

@Component
@Singleton
@Named("confluence.details")
@Unstable
public class ConfluenceDetailsScriptService
extends Object
implements org.xwiki.script.service.ScriptService

Confluence details script services. Mostly to implement the detailssummary macro.

Since:

1.19.0

Version:

$Id$

Constructor Summary

Constructors

Constructor	Description
ConfluenceDetailsScriptService()

Method Summary

Modifier and Type	Method	Description
List<List<String>>	getDetails(String id, String headingsParam, List<Map<String,Object>> results)
List<List<String>>	getDetails(String id, String headingsParam, List<Map<String,Object>> results, String sortBy, boolean reverseSort)

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfluenceDetailsScriptService

public ConfluenceDetailsScriptService()

Method Detail

getDetails

public List<List<String>> getDetails(String id,
                                     String headingsParam,
                                     List<Map<String,Object>> results)

Parameters:

id - the id of the details macros to consider

headingsParam - the headings confluence parameter

results - the results of the CQL query of the detailsummary macro

Returns:

the rows to display in the detailssummary macro given the provided details id, the headings parameter and the results

getDetails

public List<List<String>> getDetails(String id,
                                     String headingsParam,
                                     List<Map<String,Object>> results,
                                     String sortBy,
                                     boolean reverseSort)

Parameters:

id - the id of the details macros to consider

headingsParam - the headings confluence parameter

results - the results of the CQL query of the detailsummary macro

sortBy - the column to sort against

reverseSort - whether to reverse the sort

Returns:

the rows to display in the detailssummary macro given the provided details id, the headings parameter and the results