it.eng.spagobi.drivers
Interface IEngineDriver


public interface IEngineDriver

Defines the methods implements by the SpagoBI drivers that, starting from a SpagoBI BIOBject, produce the parameters for a specific engine to which they are associated. The names anv values of the map parameters will be used by the system to produce a POST request to the engine application. Each driver can extract and trasform the BIParameter of the BIObject in order to create a a right request based on the engine specificaion. The methods can be used also to do some setting operation like for example handshake security requests.


Method Summary
 EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject)
          Returns the EngineURL for the modification of the document template
 EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject)
          Returns the EngineURL for the creation of a new template for the document
 java.util.Map getParameterMap(java.lang.Object biobject, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 java.util.Map getParameterMap(java.lang.Object object, java.lang.Object subObject, it.eng.spago.security.IEngUserProfile profile, java.lang.String roleName)
          Returns a map of parameters which will be send in the request to the engine application.
 

Method Detail

getParameterMap

java.util.Map getParameterMap(java.lang.Object biobject,
                              it.eng.spago.security.IEngUserProfile profile,
                              java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Parameters:
biObject - Object to execute
profile - Profile of the user
roleName - the name of the execution role
Returns:
Map The map of the execution call parameters

getParameterMap

java.util.Map getParameterMap(java.lang.Object object,
                              java.lang.Object subObject,
                              it.eng.spago.security.IEngUserProfile profile,
                              java.lang.String roleName)
Returns a map of parameters which will be send in the request to the engine application.

Parameters:
biObject - Object container of the subObject
subObject - SubObject to execute
profile - Profile of the user
roleName - the name of the execution role
Returns:
Map The map of the execution call parameters

getNewDocumentTemplateBuildUrl

EngineURL getNewDocumentTemplateBuildUrl(java.lang.Object biobject)
                                         throws InvalidOperationRequest
Returns the EngineURL for the creation of a new template for the document

Returns:
the EngineURL for the creation of a new template for the document
Throws:
InvalidOperationRequest

getEditDocumentTemplateBuildUrl

EngineURL getEditDocumentTemplateBuildUrl(java.lang.Object biobject)
                                          throws InvalidOperationRequest
Returns the EngineURL for the modification of the document template

Returns:
the EngineURL for the modification of the document template
Throws:
InvalidOperationRequest