com.sage.orion.sdata.servlet
Interface ServiceOperation

All Known Implementing Classes:

AdvancedReportService, BaseService, BaseServiceOperation, ChangePasswordOperation, CloseCRMSessionOperation, CloseSessionOperation, CompanyInfoService, ExportService, FormlessReportService, GetLoginTokenOperation, IsDirtyOperation, LicenseStatusService, OpenCRMSessionOperation, OpenSessionOperation, PingOperation, ReportService, SuperviewReportService, ViewProcessService

public interface ServiceOperation

The ServiveOperation interface provides the core definition of the interface. You will probably want to build on the BaseServiceOperation adapter.

The main method of the interface is the handleRequest method.

Method Summary

java.lang.String	getDescription() Get a description of the service operation, for use in service lists
java.lang.String	getName() Get the full name of this service operation, i.e.
ResourceResponse	handleRequest(SDataRequest request, AsyncStatusListener listener) Handle the request
void	shutdown() Release any resources allocated for this service operation.

Method Detail

getName

java.lang.String getName()

Get the full name of this service operation, i.e. the operation name prefixed with resource name(s) to make it unique in the schema

Returns:

a non-null String containing the full name of the service operation

getDescription

java.lang.String getDescription()

Get a description of the service operation, for use in service lists

It defaults to the full name of this service operation, i.e. the operation name prefixed with resource name(s)

The description should be in the language required by the user

Returns:

a non-null String containing the description of the service operation

handleRequest

ResourceResponse handleRequest(SDataRequest request,
                               AsyncStatusListener listener)

Handle the request

Parameters:

request - the SDataRequest

listener - the asynchronous status listener that will listen for events and status from the service operation

Returns:

the resource response.

shutdown

void shutdown()

Release any resources allocated for this service operation.