Class GrouperReportConfigurationBean
java.lang.Object
edu.internet2.middleware.grouper.app.reports.GrouperReportConfigurationBean
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionattribute assignment id of the marker attribute on the group/folderdescription about the reportoptional, will be generated by a grouper default if blanksubject for email (optional, will be generated from report name if blank)e.g.format of report e.g.Quartz cron-like schedule to generate the reportreportConfigValueDef SQL for the report.reportConfigScript Script e.g.if reportConfigSendEmail is true, and reportConfigSendEmailToViewers is false), this is the groupId where members are retrieved fromreport type e.g.GroupId of people who can view this report.boolean
can given subject read this report configboolean
should the config be enabledboolean
true/false if email should be sentboolean
true/false if report viewers should get email (if reportConfigSendEmail is true)boolean
true/false if email should be sent when the report has no databoolean
true/false if report should be stored when non data is foundvoid
setAttributeAssignmentMarkerId
(String attributeAssignmentMarkerId1) attribute assignment id of the marker attribute on the group/foldervoid
setReportConfigDescription
(String reportConfigDescription) description about the reportvoid
setReportConfigEmailBody
(String reportConfigEmailBody) optional, will be generated by a grouper default if blankvoid
setReportConfigEmailSubject
(String reportConfigEmailSubject) subject for email (optional, will be generated from report name if blank)void
setReportConfigEnabled
(boolean reportConfigEnabled) should the config be enabledvoid
setReportConfigFilename
(String reportConfigFilename1) void
setReportConfigFormat
(ReportConfigFormat reportConfigFormat1) format of report e.g.void
setReportConfigName
(String reportConfigName) void
setReportConfigQuartzCron
(String reportConfigQuartzCron) Quartz cron-like schedule to generate the reportvoid
setReportConfigQuery
(String reportConfigQuery) reportConfigValueDef SQL for the report.void
setReportConfigScript
(String reportConfigScript1) reportConfigScript Script e.g.void
setReportConfigSendEmail
(boolean reportConfigSendEmail) true/false if email should be sentvoid
setReportConfigSendEmailToGroupId
(String reportConfigSendEmailToGroupId) if reportConfigSendEmail is true, and reportConfigSendEmailToViewers is false), this is the groupId where members are retrieved fromvoid
setReportConfigSendEmailToViewers
(boolean reportConfigSendEmailToViewers) true/false if report viewers should get email (if reportConfigSendEmail is true)void
setReportConfigSendEmailWithNoData
(boolean reportConfigSendEmailWithNoData) true/false if email should be sentvoid
setReportConfigStoreWithNoData
(boolean reportConfigStoreWithNoData1) true/false if report should be stored when non data is foundvoid
setReportConfigType
(ReportConfigType reportConfigType1) report type e.g.void
setReportConfigViewersGroupId
(String reportConfigViewersGroupId) GroupId of people who can view this report.void
setSqlConfig
(String sqlConfig)
-
Constructor Details
-
GrouperReportConfigurationBean
public GrouperReportConfigurationBean()
-
-
Method Details
-
setReportConfigSendEmailWithNoData
public void setReportConfigSendEmailWithNoData(boolean reportConfigSendEmailWithNoData) true/false if email should be sent- Parameters:
reportConfigSendEmail
-
-
isReportConfigSendEmailWithNoData
public boolean isReportConfigSendEmailWithNoData()true/false if email should be sent when the report has no data- Returns:
- reportConfigSendEmailWithNoData
-
isReportConfigStoreWithNoData
public boolean isReportConfigStoreWithNoData()true/false if report should be stored when non data is found- Returns:
- stored when no data found
-
setReportConfigStoreWithNoData
public void setReportConfigStoreWithNoData(boolean reportConfigStoreWithNoData1) true/false if report should be stored when non data is found- Parameters:
reportConfigStoreWithNoData1
-
-
getSqlConfig
-
setSqlConfig
-
getReportConfigType
report type e.g. SQL- Returns:
- the reportConfigType
-
setReportConfigType
report type e.g. SQL- Parameters:
reportConfigType1
- the reportConfigType to set
-
getReportConfigFormat
format of report e.g. CSV- Returns:
- the reportConfigFormat
-
setReportConfigFormat
format of report e.g. CSV- Parameters:
reportConfigFormat1
- the reportConfigFormat to set
-
getAttributeAssignmentMarkerId
attribute assignment id of the marker attribute on the group/folder- Returns:
- the attributeAssignmentMarkerId
-
setAttributeAssignmentMarkerId
attribute assignment id of the marker attribute on the group/folder- Parameters:
attributeAssignmentMarkerId1
- the attributeAssignmentMarkerId to set
-
getReportConfigName
- Returns:
- the reportConfigName
-
setReportConfigName
- Parameters:
reportConfigName
- the reportConfigName to set
-
getReportConfigFilename
e.g. usersOfMyService_$$timestamp$$.csv $$timestamp$$ translates to current time in this format: yyyy_mm_dd_hh24_mi_ss- Returns:
- the reportConfigFilename
-
setReportConfigFilename
- Parameters:
reportConfigFilename1
- the reportConfigFilename to set
-
getReportConfigScript
reportConfigScript Script e.g. GSH- Returns:
- script
-
setReportConfigScript
reportConfigScript Script e.g. GSH- Parameters:
reportConfigScript1
-
-
getReportConfigQuery
reportConfigValueDef SQL for the report. The columns must be named in the SQL (e.g. not select *) and generally this comes from a view- Returns:
- the reportConfigQuery
-
setReportConfigQuery
reportConfigValueDef SQL for the report. The columns must be named in the SQL (e.g. not select *) and generally this comes from a view- Parameters:
reportConfigQuery
- the reportConfigQuery to set
-
getReportConfigDescription
description about the report- Returns:
- reportConfigDescription
-
setReportConfigDescription
description about the report- Parameters:
reportConfigDescription
-
-
getReportConfigViewersGroupId
GroupId of people who can view this report. Grouper admins can view any report (blank means admin only)- Returns:
- reportConfigViewersGroupId
-
setReportConfigViewersGroupId
GroupId of people who can view this report. Grouper admins can view any report (blank means admin only)- Parameters:
reportConfigViewersGroupId
-
-
getReportConfigQuartzCron
Quartz cron-like schedule to generate the report- Returns:
- reportConfigQuartzCron
-
setReportConfigQuartzCron
Quartz cron-like schedule to generate the report- Parameters:
reportConfigQuartzCron
-
-
isReportConfigSendEmail
public boolean isReportConfigSendEmail()true/false if email should be sent- Returns:
- reportConfigSendEmail
-
setReportConfigSendEmail
public void setReportConfigSendEmail(boolean reportConfigSendEmail) true/false if email should be sent- Parameters:
reportConfigSendEmail
-
-
getReportConfigEmailSubject
subject for email (optional, will be generated from report name if blank)- Returns:
- reportConfigEmailSubject
-
setReportConfigEmailSubject
subject for email (optional, will be generated from report name if blank)- Parameters:
reportConfigEmailSubject
-
-
getReportConfigEmailBody
optional, will be generated by a grouper default if blank- Returns:
- reportConfigEmailBody
-
setReportConfigEmailBody
optional, will be generated by a grouper default if blank- Parameters:
reportConfigEmailBody
-
-
isReportConfigSendEmailToViewers
public boolean isReportConfigSendEmailToViewers()true/false if report viewers should get email (if reportConfigSendEmail is true)- Returns:
- reportConfigSendEmailToViewers
-
setReportConfigSendEmailToViewers
public void setReportConfigSendEmailToViewers(boolean reportConfigSendEmailToViewers) true/false if report viewers should get email (if reportConfigSendEmail is true)- Parameters:
reportConfigSendEmailToViewers
-
-
getReportConfigSendEmailToGroupId
if reportConfigSendEmail is true, and reportConfigSendEmailToViewers is false), this is the groupId where members are retrieved from- Returns:
- reportConfigSendEmailToGroupId
-
setReportConfigSendEmailToGroupId
if reportConfigSendEmail is true, and reportConfigSendEmailToViewers is false), this is the groupId where members are retrieved from- Parameters:
reportConfigSendEmailToGroupId
-
-
isReportConfigEnabled
public boolean isReportConfigEnabled()should the config be enabled- Returns:
- reportConfigEnabled
-
setReportConfigEnabled
public void setReportConfigEnabled(boolean reportConfigEnabled) should the config be enabled- Parameters:
reportConfigEnabled
-
-
isCanRead
can given subject read this report config- Parameters:
subject
-- Returns:
-