it.eng.spagobi.sdk.documents.impl
Class DocumentsServiceImpl

java.lang.Object
  extended by it.eng.spagobi.sdk.AbstractSDKService
      extended by it.eng.spagobi.sdk.documents.impl.DocumentsServiceImpl
All Implemented Interfaces:
it.eng.spagobi.sdk.documents.DocumentsService

public class DocumentsServiceImpl
extends AbstractSDKService
implements it.eng.spagobi.sdk.documents.DocumentsService


Field Summary
static java.lang.String DATAMART_FILE_NAME
           
 
Constructor Summary
DocumentsServiceImpl()
           
 
Method Summary
 it.eng.spagobi.sdk.documents.bo.SDKTemplate downloadDatamartTemplate(java.lang.String folderName, java.lang.String fileName)
           
 it.eng.spagobi.sdk.documents.bo.SDKTemplate downloadTemplate(java.lang.Integer documentId)
           
 it.eng.spagobi.sdk.documents.bo.SDKExecutedDocumentContent executeDocument(it.eng.spagobi.sdk.documents.bo.SDKDocument document, it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] parameters, java.lang.String roleName, java.lang.String outputType)
          Executes a document and return an object containing the result
 java.util.HashMap getAdmissibleValues(java.lang.Integer documentParameterId, java.lang.String roleName)
           
 java.lang.String[] getCorrectRolesForExecution(java.lang.Integer documentId)
           
 it.eng.spagobi.sdk.documents.bo.SDKDocument getDocumentById(java.lang.Integer id)
           
 it.eng.spagobi.sdk.documents.bo.SDKDocument getDocumentByLabel(java.lang.String label)
           
 it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] getDocumentParameters(java.lang.Integer documentId, java.lang.String roleName)
           
 it.eng.spagobi.sdk.documents.bo.SDKDocument[] getDocumentsAsList(java.lang.String type, java.lang.String state, java.lang.String folderPath)
           
 it.eng.spagobi.sdk.documents.bo.SDKFunctionality getDocumentsAsTree(java.lang.String initialPath)
           
 java.lang.Integer saveNewDocument(it.eng.spagobi.sdk.documents.bo.SDKDocument document, it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate, java.lang.Integer functionalityId)
           
 void uploadDatamartTemplate(it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate)
           
 void uploadTemplate(java.lang.Integer documentId, it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate)
           
 
Methods inherited from class it.eng.spagobi.sdk.AbstractSDKService
checkUserPermissionForFunctionality, getUserProfile
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DATAMART_FILE_NAME

public static final java.lang.String DATAMART_FILE_NAME
See Also:
Constant Field Values
Constructor Detail

DocumentsServiceImpl

public DocumentsServiceImpl()
Method Detail

getAdmissibleValues

public java.util.HashMap getAdmissibleValues(java.lang.Integer documentParameterId,
                                             java.lang.String roleName)
                                      throws it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException
Specified by:
getAdmissibleValues in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException

getCorrectRolesForExecution

public java.lang.String[] getCorrectRolesForExecution(java.lang.Integer documentId)
                                               throws it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException
Specified by:
getCorrectRolesForExecution in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException

getDocumentParameters

public it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] getDocumentParameters(java.lang.Integer documentId,
                                                                                    java.lang.String roleName)
                                                                             throws it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException
Specified by:
getDocumentParameters in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException

getDocumentsAsList

public it.eng.spagobi.sdk.documents.bo.SDKDocument[] getDocumentsAsList(java.lang.String type,
                                                                        java.lang.String state,
                                                                        java.lang.String folderPath)
Specified by:
getDocumentsAsList in interface it.eng.spagobi.sdk.documents.DocumentsService

getDocumentsAsTree

public it.eng.spagobi.sdk.documents.bo.SDKFunctionality getDocumentsAsTree(java.lang.String initialPath)
Specified by:
getDocumentsAsTree in interface it.eng.spagobi.sdk.documents.DocumentsService

saveNewDocument

public java.lang.Integer saveNewDocument(it.eng.spagobi.sdk.documents.bo.SDKDocument document,
                                         it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate,
                                         java.lang.Integer functionalityId)
                                  throws it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
Specified by:
saveNewDocument in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException

uploadTemplate

public void uploadTemplate(java.lang.Integer documentId,
                           it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate)
                    throws it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
Specified by:
uploadTemplate in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException

downloadTemplate

public it.eng.spagobi.sdk.documents.bo.SDKTemplate downloadTemplate(java.lang.Integer documentId)
                                                             throws it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
Specified by:
downloadTemplate in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException

executeDocument

public it.eng.spagobi.sdk.documents.bo.SDKExecutedDocumentContent executeDocument(it.eng.spagobi.sdk.documents.bo.SDKDocument document,
                                                                                  it.eng.spagobi.sdk.documents.bo.SDKDocumentParameter[] parameters,
                                                                                  java.lang.String roleName,
                                                                                  java.lang.String outputType)
                                                                           throws it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException,
                                                                                  it.eng.spagobi.sdk.exceptions.NotAllowedOperationException,
                                                                                  it.eng.spagobi.sdk.exceptions.MissingParameterValue,
                                                                                  it.eng.spagobi.sdk.exceptions.InvalidParameterValue
Executes a document and return an object containing the result

Specified by:
executeDocument in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NonExecutableDocumentException
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
it.eng.spagobi.sdk.exceptions.MissingParameterValue
it.eng.spagobi.sdk.exceptions.InvalidParameterValue

getDocumentById

public it.eng.spagobi.sdk.documents.bo.SDKDocument getDocumentById(java.lang.Integer id)
Specified by:
getDocumentById in interface it.eng.spagobi.sdk.documents.DocumentsService

getDocumentByLabel

public it.eng.spagobi.sdk.documents.bo.SDKDocument getDocumentByLabel(java.lang.String label)
Specified by:
getDocumentByLabel in interface it.eng.spagobi.sdk.documents.DocumentsService

uploadDatamartTemplate

public void uploadDatamartTemplate(it.eng.spagobi.sdk.documents.bo.SDKTemplate sdkTemplate)
                            throws it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
Specified by:
uploadDatamartTemplate in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException

downloadDatamartTemplate

public it.eng.spagobi.sdk.documents.bo.SDKTemplate downloadDatamartTemplate(java.lang.String folderName,
                                                                            java.lang.String fileName)
                                                                     throws it.eng.spagobi.sdk.exceptions.NotAllowedOperationException
Specified by:
downloadDatamartTemplate in interface it.eng.spagobi.sdk.documents.DocumentsService
Throws:
it.eng.spagobi.sdk.exceptions.NotAllowedOperationException