com.sage.orion.sdata.servlet.accpac
Class AdvancedReportService

java.lang.Object
  com.sage.orion.sdata.servlet.BaseServiceOperation
      com.sage.orion.sdata.servlet.accpac.BaseService
          com.sage.orion.sdata.servlet.accpac.ReportService
              com.sage.orion.sdata.servlet.accpac.FormlessReportService
                  com.sage.orion.sdata.servlet.accpac.AdvancedReportService

All Implemented Interfaces:

ServiceOperation

public class AdvancedReportService
extends FormlessReportService

This class is designed to handle the SData $service operation that generates an Accpac report.

In addition, this service will populate the report file field with a list of reports installed in the system for the application related to the report.

The service's request fields will be created from the report's input parameters. Three fields, reportFile, reportName and reportOutput, will be added to the list of request fields. These three fields are optional and, if not provided by the client, the reportFile will be defaulted to the file defined in the xxRpt.ini, the reportName will be defaulted to the section name defined in the xxRpt.ini and the reportOutput will be defaulted to "PREVIEW".

The service's response is an Atom entry containing an element responseURL that tells the client where to get the report.

Nested Class Summary

Nested classes/interfaces inherited from class com.sage.orion.sdata.servlet.accpac.ReportService

ReportService.ReportParamValues

Nested classes/interfaces inherited from class com.sage.orion.sdata.servlet.BaseServiceOperation

BaseServiceOperation.FieldData, BaseServiceOperation.FieldNames

Constructor Summary

AdvancedReportService(ApplicationContext applicationContext, ResourceContextImpl resourceContext, Resource resource, Service service, SDataViewSet viewSet)
Constructor which uses the report object created from the report name defined for this service operation

Method Summary

protected ServiceField

getReportFileField() Create a service field for the report file.

Methods inherited from class com.sage.orion.sdata.servlet.accpac.FormlessReportService

createTemplateFields

Methods inherited from class com.sage.orion.sdata.servlet.accpac.ReportService

createRequestFields, createResponseFields, execute, getReport, getReportPayload

Methods inherited from class com.sage.orion.sdata.servlet.accpac.BaseService

getApplicationContext, getName, getOperationName, getPath, getResource, getResourceContext, getService, getViewSet, isForMetaDataInquiry

Methods inherited from class com.sage.orion.sdata.servlet.BaseServiceOperation

getDescription, getResponseFields, getSchema, handleRequest, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

AdvancedReportService

public AdvancedReportService(ApplicationContext applicationContext,
                             ResourceContextImpl resourceContext,
                             Resource resource,
                             Service service,
                             SDataViewSet viewSet)

Constructor which uses the report object created from the report name defined for this service operation

Parameters:

applicationContext - the application context in which the service operation will be run

resourceContext - the resource context in which the service operation will be run

resource - the resource on which the service operation will be performed

service - the service operation to be performed

viewSet - the SDataViewSet associated with the resource

Method Detail

getReportFileField

protected ServiceField getReportFileField()

Create a service field for the report file.

This service field will be populated with a list of reports installed in the system for the application related to the report. It's value will be defaulted to the report file defined in the xxRpt.ini

Overrides:

getReportFileField in class ReportService

Returns:

the service field for the report file