Package ru.bitel.bgbilling.modules.reports.common.service

# Interface ReportService

public interface ReportService

- ## Method Summary

  Modifier and Type
  Method
  Description
  `boolean`
  `checkAccessAllowByReport(String reportId)`
  Проверка возможности просмотра отчета для пользователя
  `boolean`
  `checkReportExists(String reportFileName)`
  `ReportAccessRule`
  `getAccessRulesByReportId(String reportId)`
  `List<ru.bitel.bgbilling.common.model.KeyValue>`
  `getModuleReportList(String reportModule)`
  `String`
  `getReportData(String reportModule, String reportId)`
  `List<ru.bitel.bgbilling.modules.reports.common.dto.ReportModule>`
  `reportModules()`
  `void`
  `resetReportCache()`
  `void`
  `saveReport(String reportFileName, String xmlData)`
  Сохранение xml описания отчета на сервере в папке reports после редактирования в конструкторе
  `void`
  `updateAccessRulesByReport(ReportAccessRule reportAccessRule)`
  Обновление/добавление правила доступа видимости отчета

- ## Method Details

  - ### saveReport

    void saveReport(String reportFileName, String xmlData) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Сохранение xml описания отчета на сервере в папке reports после редактирования в конструкторе
    Parameters:
      `xmlData` -
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`

  - ### checkReportExists

    boolean checkReportExists(String reportFileName) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`

  - ### getAccessRulesByReportId

    ReportAccessRule getAccessRulesByReportId(String reportId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Parameters:
      `reportId` - ID отчета(строковое название файла отчета без расширения)
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`

  - ### reportModules

    List<ru.bitel.bgbilling.modules.reports.common.dto.ReportModule> reportModules() throws Exception
    Returns:
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`
      `Exception`

  - ### updateAccessRulesByReport

    void updateAccessRulesByReport(ReportAccessRule reportAccessRule) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Обновление/добавление правила доступа видимости отчета
    Parameters:
      `reportAccessRule` - правила доступа видимости отчета
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`

  - ### checkAccessAllowByReport

    boolean checkAccessAllowByReport(String reportId) throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Проверка возможности просмотра отчета для пользователя
    Parameters:
      `reportId` - ID отчета(строковое название файла отчета без расширения)
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`

  - ### getModuleReportList

    List<ru.bitel.bgbilling.common.model.KeyValue> getModuleReportList(String reportModule) throws Exception
    Parameters:
      `reportModule` -
    Returns:
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`
      `Exception`

  - ### getReportData

    String getReportData(String reportModule, String reportId) throws Exception
    Parameters:
      `reportId` -
    Returns:
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`
      `Exception`

  - ### resetReportCache

    void resetReportCache() throws ru.bitel.bgbilling.common.BGException, ru.bitel.bgbilling.common.BGMessageException
    Throws:
      `ru.bitel.bgbilling.common.BGException`
      `ru.bitel.bgbilling.common.BGMessageException`