de.hybris.platform.auditreport.service

Class CreateAuditReportParams

java.lang.Object

de.hybris.platform.auditreport.service.CreateAuditReportParams

public class CreateAuditReportParams
extends java.lang.Object

Parameter object to pass all data necessary to create audit report instance.

Constructor Summary

Constructors

Constructor and Description
CreateAuditReportParams(ItemModel rootItem, java.lang.String configName, java.lang.String reportId, boolean audit, java.util.Collection<LanguageModel> includedLanguages, AuditReportTemplateModel template)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConfigName()
java.util.Collection<LanguageModel>	getIncludedLanguages()
java.lang.String	getReportId()
ItemModel	getRootItem()
AuditReportTemplateModel	getTemplate()
boolean	isAudit()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateAuditReportParams

public CreateAuditReportParams(ItemModel rootItem,
                               java.lang.String configName,
                               java.lang.String reportId,
                               boolean audit,
                               java.util.Collection<LanguageModel> includedLanguages,
                               AuditReportTemplateModel template)

Parameters:

rootItem - the rootItem for which report will be generated.

configName - the configuration name used to create a new report.

reportId - the new report identifier.

audit - if set to true the generated report will contain audit data. Otherwise data snapshot will be taken.

includedLanguages - all mentioned languages will be included in the report. Other languages will be omitted. In case no language is set all available languages will be exported.

template - template used to generate the report view.

Method Detail

getRootItem

public ItemModel getRootItem()

getConfigName

public java.lang.String getConfigName()

getReportId

public java.lang.String getReportId()

isAudit

public boolean isAudit()

getIncludedLanguages

public java.util.Collection<LanguageModel> getIncludedLanguages()

getTemplate

public AuditReportTemplateModel getTemplate()