Package ch.tocco.nice2.reporting.impl.description

Class EntityReportDescription

java.lang.Object

ch.tocco.nice2.reporting.impl.description.EntityReportDescription

All Implemented Interfaces:

ReportDescription

Direct Known Subclasses:

LabelReportDescription

public class EntityReportDescription
extends Object
implements ReportDescription

Nested Class Summary

Nested classes/interfaces inherited from interface ch.tocco.nice2.reporting.api.ReportDescription

ReportDescription.PlacementConfig, ReportDescription.RecipientConfig

Constructor Summary

Constructors

Constructor	Description
EntityReportDescription(Entity delegate)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

EntityReportDescription

public EntityReportDescription(Entity delegate)

Method Details

getReportEntity

public Entity getReportEntity()

getId

public String getId()

Specified by:

getId in interface ReportDescription

getLabel

public String getLabel()

Specified by:

getLabel in interface ReportDescription

getDescription

public String getDescription()

Specified by:

getDescription in interface ReportDescription

getAfterReportFunction

public AfterReportFunction getAfterReportFunction(AfterReportFunctionService afterReportFunctionService)

Specified by:

getAfterReportFunction in interface ReportDescription

Returns:

an optional function to be executed after the report was generated

See Also:

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

getReportDataModifierId

public String getReportDataModifierId()

Specified by:

getReportDataModifierId in interface ReportDescription

getConfirmMessage

public String getConfirmMessage(TextResources textResources)

Specified by:

getConfirmMessage in interface ReportDescription

Parameters:

textResources - TextResources

Returns:

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

See Also:

• ReportDescription.getAfterReportFunction(AfterReportFunctionService)
• ReportDescription.isSkippable()
• ReportDescription.getDefaultValue()

isSkippable

public boolean isSkippable()

Specified by:

isSkippable in interface ReportDescription

Returns:

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

See Also:

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

getDefaultValue

public boolean getDefaultValue()

Specified by:

getDefaultValue in interface ReportDescription

Returns:

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

See Also:

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

isHideLogoCheckbox

public boolean isHideLogoCheckbox()

Specified by:

isHideLogoCheckbox in interface ReportDescription

Returns:

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

See Also:

• ReportDescription.isEnableLogoCheckbox()

isEnableLogoCheckbox

public boolean isEnableLogoCheckbox()

Specified by:

isEnableLogoCheckbox in interface ReportDescription

Returns:

true to initialize the logo checkbox checked (GUI)

See Also:

• ReportDescription.isHideLogoCheckbox()

getPathToDefaultOutputLanguage

public String getPathToDefaultOutputLanguage()

Specified by:

getPathToDefaultOutputLanguage in interface ReportDescription

Returns:

the optional path to default output language or null

getDefaultArchiveType

@Nullable
public @Nullable String getDefaultArchiveType()

Specified by:

getDefaultArchiveType in interface ReportDescription

getReportResourceWrapper

public ReportResourceWrapper getReportResourceWrapper()

Specified by:

getReportResourceWrapper in interface ReportDescription

Returns:

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

getModule

public AppModule getModule()

Specified by:

getModule in interface ReportDescription

getFilenameSuggestion

public String getFilenameSuggestion(TextResources textResources)

Specified by:

getFilenameSuggestion in interface ReportDescription

Parameters:

textResources - TextResources

Returns:

a filename suggestion for the GUI

getFileFormat

public String getFileFormat()

Specified by:

getFileFormat in interface ReportDescription

hasPermission

public boolean hasPermission(ReportPermissionService reportPermissionService)

Specified by:

hasPermission in interface ReportDescription

getRecipientConfig

public Map<String,ReportDescription.RecipientConfig> getRecipientConfig()

Specified by:

getRecipientConfig in interface ReportDescription

isPersonalizedOnly

public boolean isPersonalizedOnly()

Specified by:

isPersonalizedOnly in interface ReportDescription

isSplitBaseData

public boolean isSplitBaseData()

Specified by:

isSplitBaseData in interface ReportDescription

getGroupingPath

@Nullable
public @Nullable String getGroupingPath()

Specified by:

getGroupingPath in interface ReportDescription

getOrderBy

public String getOrderBy()

Specified by:

getOrderBy in interface ReportDescription

getGroupOrderBy

public String getGroupOrderBy()

Specified by:

getGroupOrderBy in interface ReportDescription

ignoreSelection

public boolean ignoreSelection()

Specified by:

ignoreSelection in interface ReportDescription

getReportLayout

public Optional<ReportLayout> getReportLayout()

Specified by:

getReportLayout in interface ReportDescription

Returns:

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

isPublic

public boolean isPublic()

Specified by:

isPublic in interface ReportDescription

getSettingsEntityName

@Nullable
public @Nullable String getSettingsEntityName()

reload

public void reload(Context context)

Specified by:

reload in interface ReportDescription