it.eng.spagobi.bo.dao
Interface IBIObjectCMSDAO

All Known Implementing Classes:
BIObjectCMSDAOImpl

public interface IBIObjectCMSDAO

Defines all the methods needed for access contents of BIObject into CMS Repository

Author:
Fiscato

Method Summary
 void deleteSnapshot(java.lang.String snapshotPath)
          Delete a snapshot
 void deleteSubObject(java.lang.String pathParent, java.lang.String name)
          Delete a subObject
 void exportDocument(BIObject obj, java.lang.String destFolder, boolean exportSubObjects, boolean exportSnapshots)
          Exports a document node
 void fillBIObjectTemplate(BIObject obj)
          Given a BIObject at input, fills it with template information.
 java.util.List getAccessibleSubObjects(java.lang.String pathParent, it.eng.spago.security.IEngUserProfile profile)
          Gets the detail of all the subobjects accessible to the user
 java.lang.String getExecutionNotes(java.lang.String biobjPath, java.lang.String execIdentif)
          Get Notes for a specific execution of the biobject
 java.util.List getSnapshots(java.lang.String pathParent)
          Gets the list of the snapshot details that are children of a biobject
 java.io.InputStream getSubObject(java.lang.String pathParent, java.lang.String name)
          Gets the InputStream of the subobjects content
 java.util.List getSubObjects(java.lang.String pathParent)
          Gets the detail of all the biobject subobjects
 java.io.InputStream getTemplate(java.lang.String path)
          Get the template of the object
 java.lang.String importDocument(java.lang.String sourceFolder)
          Imports a document
 void saveExecutionNotes(java.lang.String biobjPath, java.lang.String execIdentif, java.lang.String notes)
          Save Notes for a specific execution of the biobject
 void saveSnapshot(byte[] content, java.lang.String pathParent, java.lang.String name, java.lang.String description)
          Save a snapshot of the object
 void saveSubObject(byte[] content, java.lang.String pathParent, java.lang.String name, java.lang.String description, boolean publicVisibility, it.eng.spago.security.IEngUserProfile profile)
          Save a subObject of the object
 void saveTemplate(byte[] content, java.lang.String path, java.lang.String templateName)
          Save a subObject of the object
 

Method Detail

saveExecutionNotes

void saveExecutionNotes(java.lang.String biobjPath,
                        java.lang.String execIdentif,
                        java.lang.String notes)
                        throws java.lang.Exception
Save Notes for a specific execution of the biobject

Parameters:
biobjPath - path of the biobject executed
execIdentif - identifier of the execution
notes - notes to save
Throws:
java.lang.Exception

getExecutionNotes

java.lang.String getExecutionNotes(java.lang.String biobjPath,
                                   java.lang.String execIdentif)
                                   throws java.lang.Exception
Get Notes for a specific execution of the biobject

Parameters:
biobjPath - path of the biobject executed
execIdentif - identifier of the execution
Returns:
String notes saved
Throws:
java.lang.Exception

getTemplate

java.io.InputStream getTemplate(java.lang.String path)
Get the template of the object

Parameters:
path - Cms path of the object
profile - User Profile
Returns:
InputStream of the template contents

saveSubObject

void saveSubObject(byte[] content,
                   java.lang.String pathParent,
                   java.lang.String name,
                   java.lang.String description,
                   boolean publicVisibility,
                   it.eng.spago.security.IEngUserProfile profile)
                   throws it.eng.spago.error.EMFUserError
Save a subObject of the object

Parameters:
content - byte array containing the content of the subobject
pathParent - the cms path of the parent
name - the name of the new subobject
description - the description of the new subobject
publiicVisibility - the public or private visibility of the subobject
profile - the profile of the user
Throws:
it.eng.spago.error.EMFUserError

getAccessibleSubObjects

java.util.List getAccessibleSubObjects(java.lang.String pathParent,
                                       it.eng.spago.security.IEngUserProfile profile)
Gets the detail of all the subobjects accessible to the user

Parameters:
pathParent - Cms path of the object
profile - Profile of the user
Returns:
List of BIObject.SubObjectDetail objects

getSubObject

java.io.InputStream getSubObject(java.lang.String pathParent,
                                 java.lang.String name)
Gets the InputStream of the subobjects content

Parameters:
pathParent - cms path of the object parent
name - name of the subobject
Returns:
InputStream of the subobject content

deleteSubObject

void deleteSubObject(java.lang.String pathParent,
                     java.lang.String name)
                     throws it.eng.spago.error.EMFUserError
Delete a subObject

Parameters:
pathParent - path of the parent object
name - name of the subObject
Throws:
it.eng.spago.error.EMFUserError

fillBIObjectTemplate

void fillBIObjectTemplate(BIObject obj)
Given a BIObject at input, fills it with template information.

Parameters:
obj - The object to fill template information in.

getSubObjects

java.util.List getSubObjects(java.lang.String pathParent)
Gets the detail of all the biobject subobjects

Parameters:
pathParent - Cms path of the object
Returns:
List of BIObject.SubObjectDetail objects

saveTemplate

void saveTemplate(byte[] content,
                  java.lang.String path,
                  java.lang.String templateName)
                  throws it.eng.spago.error.EMFUserError
Save a subObject of the object

Parameters:
content: - byte array containing the content of the template
path: - the cms path of the document
templateName: - the name of the template
Throws:
it.eng.spago.error.EMFUserError

saveSnapshot

void saveSnapshot(byte[] content,
                  java.lang.String pathParent,
                  java.lang.String name,
                  java.lang.String description)
                  throws it.eng.spago.error.EMFUserError
Save a snapshot of the object

Parameters:
content - byte array containing the content of the snapshot
pathParent - the cms path of the parent
name - the name of the new subobject
description - the description of the new subobject
Throws:
it.eng.spago.error.EMFUserError

getSnapshots

java.util.List getSnapshots(java.lang.String pathParent)
Gets the list of the snapshot details that are children of a biobject

Parameters:
pathParent - Cms path of the biobject
Returns:
List of BIObject.BIObjectSnapshot objects

deleteSnapshot

void deleteSnapshot(java.lang.String snapshotPath)
                    throws it.eng.spago.error.EMFUserError
Delete a snapshot

Parameters:
snapshotPath - path of the snapshot
name - name of the snapshot
Throws:
it.eng.spago.error.EMFUserError

exportDocument

void exportDocument(BIObject obj,
                    java.lang.String destFolder,
                    boolean exportSubObjects,
                    boolean exportSnapshots)
                    throws it.eng.spago.error.EMFUserError
Exports a document node

Parameters:
obj - The BIObject document to be exported: its node is supposed to be existing
destFolder - The folder where document will be serialized
exportSubObjects - Flag indicating if the subobjects must be exported
exportSnapshots - Flag indicating if the snapshots must be exported
Throws:
it.eng.spago.error.EMFUserError

importDocument

java.lang.String importDocument(java.lang.String sourceFolder)
                                throws it.eng.spago.error.EMFUserError
Imports a document

Parameters:
sourceFolder - The folder where document will be deserialized from
Throws:
it.eng.spago.error.EMFUserError