Package ch.tocco.nice2.reporting.api

Interface ReportDescription

All Known Implementing Classes:

EntityReportDescription, LabelReportDescription, ReportContribution

public interface ReportDescription

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReportDescription.PlacementConfig
static class	ReportDescription.RecipientConfig

Method Summary

Modifier and Type	Method	Description
@Nullable AfterReportFunction	getAfterReportFunction(AfterReportFunctionService afterReportFunctionService)
String	getConfirmMessage(TextResources textResources)
@Nullable String	getDefaultArchiveType()
boolean	getDefaultValue()
String	getDescription()
String	getFileFormat()
String	getFilenameSuggestion(TextResources textResources)
@Nullable String	getGroupingPath()
@Nullable String	getGroupOrderBy()
String	getId()
String	getLabel()
@Nullable AppModule	getModule()
@Nullable String	getOrderBy()
@Nullable String	getPathToDefaultOutputLanguage()
Map<String,ReportDescription.RecipientConfig>	getRecipientConfig()
@Nullable String	getReportDataModifierId()
Optional<ReportLayout>	getReportLayout()
ReportResourceWrapper	getReportResourceWrapper()
boolean	hasPermission(ReportPermissionService reportPermissionService)
boolean	ignoreSelection()
boolean	isEnableLogoCheckbox()
boolean	isHideLogoCheckbox()
boolean	isPersonalizedOnly()
boolean	isPublic()
boolean	isSkippable()
boolean	isSplitBaseData()
void	reload(Context context)

Method Details

getId

String getId()

getLabel

String getLabel()

getDescription

String getDescription()

getAfterReportFunction

@Nullable
@Nullable AfterReportFunction getAfterReportFunction(AfterReportFunctionService afterReportFunctionService)

Returns:

an optional function to be executed after the report was generated

See Also:

• getConfirmMessage(ch.tocco.nice2.textresources.api.TextResources)
• isSkippable()
• getDefaultValue()

getReportDataModifierId

@Nullable
@Nullable String getReportDataModifierId()

getConfirmMessage

String getConfirmMessage(TextResources textResources)

Parameters:

textResources - TextResources

Returns:

an optional confirm message textresource key to be displayed (only applies if an AfterReportFunction is defined)

See Also:

• getAfterReportFunction(AfterReportFunctionService)
• isSkippable()
• getDefaultValue()

isSkippable

boolean isSkippable()

Returns:

is the AfterReportFunction skippable (only applies if an AfterReportFunction is defined)

See Also:

• getAfterReportFunction(AfterReportFunctionService)
• getConfirmMessage(ch.tocco.nice2.textresources.api.TextResources)
• getDefaultValue()

getDefaultValue

boolean getDefaultValue()

Returns:

should the AfterReportFunction be executed silently, i.e. without notifying the user (only applies if an AfterReportFunction is defined)

See Also:

• getAfterReportFunction(AfterReportFunctionService)
• getConfirmMessage(ch.tocco.nice2.textresources.api.TextResources)
• isSkippable()

isHideLogoCheckbox

boolean isHideLogoCheckbox()

Returns:

true to hide the logo checkbox in the report action (GUI)

See Also:

• isEnableLogoCheckbox()

isEnableLogoCheckbox

boolean isEnableLogoCheckbox()

Returns:

true to initialize the logo checkbox checked (GUI)

See Also:

• isHideLogoCheckbox()

getPathToDefaultOutputLanguage

@Nullable
@Nullable String getPathToDefaultOutputLanguage()

Returns:

the optional path to default output language or null

getDefaultArchiveType

@Nullable
@Nullable String getDefaultArchiveType()

getReportResourceWrapper

ReportResourceWrapper getReportResourceWrapper()

Returns:

a ReportResourceWrapper providing a basic API to the ReportManager to work on the template resource

getModule

@Nullable
@Nullable AppModule getModule()

getFilenameSuggestion

String getFilenameSuggestion(TextResources textResources)

Parameters:

textResources - TextResources

Returns:

a filename suggestion for the GUI

getFileFormat

String getFileFormat()

hasPermission

boolean hasPermission(ReportPermissionService reportPermissionService)

getRecipientConfig

Map<String,ReportDescription.RecipientConfig> getRecipientConfig()

isPersonalizedOnly

boolean isPersonalizedOnly()

isSplitBaseData

boolean isSplitBaseData()

getReportLayout

Optional<ReportLayout> getReportLayout()

Returns:

a ReportLayout config object (or Optional.empty())

getGroupingPath

@Nullable
@Nullable String getGroupingPath()

getOrderBy

@Nullable
@Nullable String getOrderBy()

getGroupOrderBy

@Nullable
@Nullable String getGroupOrderBy()

ignoreSelection

boolean ignoreSelection()

isPublic

boolean isPublic()

reload

void reload(Context context)