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

java.lang.Object
  com.sage.orion.sdata.servlet.BaseServiceOperation
      com.sage.orion.sdata.servlet.accpac.OpenSessionOperation
          com.sage.orion.sdata.servlet.accpac.OpenCRMSessionOperation

All Implemented Interfaces:

ServiceOperation

public class OpenCRMSessionOperation
extends OpenSessionOperation

The OpenCRMSessionOperation class provides the ability to open a session, by extending the BaseServiceOperation class.

This class is to be used by CRM to open a session. This session will not be mapped to an HTTP Session unlike the OpenSessionOperation.

Construct the class by providing a SystemResourceContext to the constructor.

Nested Class Summary

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

BaseServiceOperation.FieldData, BaseServiceOperation.FieldNames

Constructor Summary

OpenCRMSessionOperation(SystemResourceContext context)
Constructs an instance of the OpenCRMSessionOperation class that will use the provided context for execution.

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.
java.lang.String	getOperationName() Get the short name of this service operation, i.e.
protected java.lang.String	getPath() Get the URL to this service operation.
protected void	updateSessionMap(SDataRequest request, com.sage.accpac.sm.Session accpacSession, com.sage.accpac.sm.Program program, java.lang.String sessionID, java.lang.String programGuid) Updates the session map with the given session.

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

createRequestFields, createResponseFields, createTemplateFields, execute

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

getResponseFields, getSchema, handleRequest, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenCRMSessionOperation

public OpenCRMSessionOperation(SystemResourceContext context)

Constructs an instance of the OpenCRMSessionOperation class that will use the provided context for execution.

Parameters:

context - the SystemResourceContext to which to connect the instance

Method Detail

getOperationName

public java.lang.String getOperationName()

Description copied from class: BaseServiceOperation

Get the short name of this service operation, i.e. the operation name which is not prefixed with resource name(s)

Overrides:

getOperationName in class OpenSessionOperation

Returns:

service operation name

getPath

protected java.lang.String getPath()

Description copied from class: BaseServiceOperation

Get the URL to this service operation.

Overrides:

getPath in class OpenSessionOperation

Returns:

the URL to this service operation

getName

public java.lang.String getName()

Description copied from interface: ServiceOperation

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

Specified by:

getName in interface ServiceOperation

Overrides:

getName in class OpenSessionOperation

Returns:

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

getDescription

public java.lang.String getDescription()

Description copied from interface: ServiceOperation

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

Specified by:

getDescription in interface ServiceOperation

Overrides:

getDescription in class OpenSessionOperation

Returns:

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

updateSessionMap

protected void updateSessionMap(SDataRequest request,
                                com.sage.accpac.sm.Session accpacSession,
                                com.sage.accpac.sm.Program program,
                                java.lang.String sessionID,
                                java.lang.String programGuid)

Description copied from class: OpenSessionOperation

Updates the session map with the given session.

Overrides:

updateSessionMap in class OpenSessionOperation

Parameters:

request - the SDataRequest

accpacSession - the Session

program - the Program

sessionID - the session ID

programGuid - the program GUID