Package ch.tocco.nice2.reporting.api.description

Class ReportContribution

java.lang.Object

ch.tocco.nice2.reporting.api.description.ReportContribution

All Implemented Interfaces:

ReportDescription, SynchronisationDescription

public class ReportContribution
extends Object
implements ReportDescription, SynchronisationDescription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ReportContribution.VfsResourceWrapper

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

ReportDescription.PlacementConfig, ReportDescription.RecipientConfig

Constructor Summary

Constructors

Constructor	Description
ReportContribution()

Method Summary

Modifier and Type	Method	Description
void	addPlacementConfig(ReportDescription.PlacementConfig placementConfig)
void	addRecipientConfig(ReportDescription.RecipientConfig recipientConfig)
boolean	getActive()
@Nullable AfterReportFunction	getAfterReportFunction(AfterReportFunctionService afterReportFunctionService)
String	getAfterReportFunctionId()
String	getBusinessUnit()
String	getConfirmMessage(TextResources textResources)
String	getConfirmMessageKey()
@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	getOutputTemplate()
String	getPathToDefaultOutputLanguage()
Map<String,ReportDescription.PlacementConfig>	getPlacementConfig()
Map<String,ReportDescription.RecipientConfig>	getRecipientConfig()
@Nullable String	getReportDataModifierId()
Optional<ReportLayout>	getReportLayout()
ReportResourceWrapper	getReportResourceWrapper()
String	getRoles()
Integer	getSorting()
String	getUniqueId()
boolean	hasPermission(ReportPermissionService reportPermissionService)
boolean	ignoreSelection()
boolean	isEnableLogoCheckbox()
boolean	isEntityReport()
boolean	isHideLogoCheckbox()
boolean	isPersonalizedOnly()
boolean	isPublic()
boolean	isSkippable()
boolean	isSplitBaseData()
boolean	isSynchronize()
void	reload(Context context)
void	setActive(boolean active)
void	setAfterReportFunction(@Nullable AfterReportFunction afterReportFunction)
void	setAfterReportFunctionId(@Nullable String afterReportFunctionId)
void	setBusinessUnit(@Nullable String businessUnit)
void	setConfirmMessageKey(@Nullable String confirmMessageKey)
void	setDefaultArchiveType(@Nullable String defaultArchiveType)
void	setDefaultValue(boolean defaultValue)
void	setDescription(@Nullable String description)
void	setEntityReport(boolean entityReport)
void	setFileFormat(@Nullable String fileFormat)
void	setGroupingPath(@Nullable String groupingPath)
void	setGroupOrderBy(@Nullable String groupOrderBy)
void	setId(String id)
void	setIgnoreSelection(boolean ignoreSelection)
void	setLabel(String label)
void	setModule(AppModule module)
void	setOrderBy(@Nullable String orderBy)
void	setOutputLanguagePath(@Nullable String outputLanguagePath)
void	setOutputTemplate(String outputTemplate)
void	setPersonalizedOnly(boolean personalizedOnly)
void	setPublic(boolean isPublic)
void	setReportDataModifierId(String reportDataModifierId)
void	setRoles(@Nullable String roles)
void	setSkippable(boolean skippable)
void	setSorting(Integer sorting)
void	setSource(ModelResource source)
void	setSplitBaseData(boolean splitBaseData)
void	setSynchronize(boolean synchronize)

Methods inherited from class java.lang.Object

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

Constructor Details

ReportContribution

public ReportContribution()

Method Details

getId

public String getId()

Specified by:

getId in interface ReportDescription

setId

public void setId(String id)

getDescription

public String getDescription()

Specified by:

getDescription in interface ReportDescription

setDescription

public void setDescription(@Nullable
 @Nullable String description)

getLabel

public String getLabel()

Specified by:

getLabel in interface ReportDescription

setLabel

public void setLabel(String label)

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

setSource

public void setSource(ModelResource source)

getOutputTemplate

public String getOutputTemplate()

setOutputTemplate

public void setOutputTemplate(String outputTemplate)

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

setFileFormat

public void setFileFormat(@Nullable
 @Nullable String fileFormat)

setModule

public void setModule(AppModule module)

getAfterReportFunction

@Nullable
public @Nullable 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(TextResources)
• isSkippable()
• getDefaultValue()

getReportDataModifierId

@Nullable
public @Nullable String getReportDataModifierId()

Specified by:

getReportDataModifierId in interface ReportDescription

setReportDataModifierId

public void setReportDataModifierId(String reportDataModifierId)

setAfterReportFunction

public void setAfterReportFunction(@Nullable
 @Nullable AfterReportFunction afterReportFunction)

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()

setSkippable

public void setSkippable(boolean skippable)

getConfirmMessageKey

public String getConfirmMessageKey()

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()

setConfirmMessageKey

public void setConfirmMessageKey(@Nullable
 @Nullable String confirmMessageKey)

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()

setDefaultValue

public void setDefaultValue(boolean defaultValue)

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

setOutputLanguagePath

public void setOutputLanguagePath(@Nullable
 @Nullable String outputLanguagePath)

getDefaultArchiveType

@Nullable
public @Nullable String getDefaultArchiveType()

Specified by:

getDefaultArchiveType in interface ReportDescription

setDefaultArchiveType

public void setDefaultArchiveType(@Nullable
 @Nullable String defaultArchiveType)

getRecipientConfig

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

Specified by:

getRecipientConfig in interface ReportDescription

getPlacementConfig

public Map<String,ReportDescription.PlacementConfig> getPlacementConfig()

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

getReportLayout

public Optional<ReportLayout> getReportLayout()

Specified by:

getReportLayout in interface ReportDescription

Returns:

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

getActive

public boolean getActive()

isSynchronize

public boolean isSynchronize()

getSorting

public Integer getSorting()

getBusinessUnit

public String getBusinessUnit()

getRoles

public String getRoles()

isEntityReport

public boolean isEntityReport()

setSplitBaseData

public void setSplitBaseData(boolean splitBaseData)

setPersonalizedOnly

public void setPersonalizedOnly(boolean personalizedOnly)

setGroupingPath

public void setGroupingPath(@Nullable
 @Nullable String groupingPath)

getOrderBy

public String getOrderBy()

Specified by:

getOrderBy in interface ReportDescription

setOrderBy

public void setOrderBy(@Nullable
 @Nullable String orderBy)

getGroupOrderBy

public String getGroupOrderBy()

Specified by:

getGroupOrderBy in interface ReportDescription

setActive

public void setActive(boolean active)

setSynchronize

public void setSynchronize(boolean synchronize)

ignoreSelection

public boolean ignoreSelection()

Specified by:

ignoreSelection in interface ReportDescription

setIgnoreSelection

public void setIgnoreSelection(boolean ignoreSelection)

setEntityReport

public void setEntityReport(boolean entityReport)

setBusinessUnit

public void setBusinessUnit(@Nullable
 @Nullable String businessUnit)

setRoles

public void setRoles(@Nullable
 @Nullable String roles)

setSorting

public void setSorting(Integer sorting)

getAfterReportFunctionId

public String getAfterReportFunctionId()

setAfterReportFunctionId

public void setAfterReportFunctionId(@Nullable
 @Nullable String afterReportFunctionId)

setGroupOrderBy

public void setGroupOrderBy(@Nullable
 @Nullable String groupOrderBy)

addRecipientConfig

public void addRecipientConfig(ReportDescription.RecipientConfig recipientConfig)

addPlacementConfig

public void addPlacementConfig(ReportDescription.PlacementConfig placementConfig)

getUniqueId

public String getUniqueId()

isPublic

public boolean isPublic()

Specified by:

isPublic in interface ReportDescription

setPublic

public void setPublic(boolean isPublic)

reload

public void reload(Context context)

Specified by:

reload in interface ReportDescription