Interface WebSourceManipulator


  • public interface WebSourceManipulator
    Since:
    MicroStrategy Web 9.0.0
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addBulkMergeFromFile​(java.lang.String filePath)
      Open a delta file and apply its contents to the current project
      void addBulkMergeFromFile​(java.lang.String filePath, boolean useFileRules)
      Open a delta file and apply its contents to the current project
      void addCreateUndoFile​(java.lang.String sourceFileName, java.lang.String undoFileName)
      Create an undo file for a package
      void applyDeltaPackage​(java.io.InputStream deltaPackage, long dataLength)
      Applies an first class binary representation on the current session's project
      void applyDeltaPackage​(java.io.InputStream deltaPackage, long dataLength, java.lang.String comments)
      Applies an first class binary representation on the current session's with the comments in journal change log
      byte[] createObjectDeltaPackage​(WebObjectInfo[] objects, int conflictDomain, int conflictParts, int conflictResolution)
      Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
      byte[] createObjectDeltaPackage​(WebObjectInfo[] objects, ObjectDeltaFlags[] objDeltaFlags)
      Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
      byte[] createObjectDeltaPackage​(java.lang.String objectID, int type, int conflictDomain, int conflictParts, int conflictResolution)
      Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
      byte[] createUndoPackageClientToClient​(java.io.InputStream data, long dataLength)
      Create a undo package saved at client side, and the source file is at client side.
      void createUndoPackageClientToServer​(java.io.InputStream data, long dataLength, java.lang.String undoFilePath)
      Create a undo package saved at server side, and the source file is at client side
      byte[] createUndoPackageServerToClient​(java.lang.String sourceFilePath)
      Create a undo package saved at client side, and the source file is at server side.
      void createUndoPackageServerToServer​(java.lang.String sourceFilePath, java.lang.String undoFilePath)
      Create a undo package saved at server side, and the source file is at server side.
      int getACLConflictRule()
      Get the value of acl conflict rule
      int getFlag()
      Get the value of manipulation flag
      int getInheritACL()
      Get the value of inherit acl
      void invoke()
      Invoke manipulator to execute tasks defined in addBulkMergeFromFile
      void invoke​(java.lang.String comments)
      Invoke manipulator to execute tasks defined in addBulkMergeFromFile with journal change log
      void reset()
      Clear task list for manipulator
      void setACLConflictRule​(int _aclConflictRule)
      Set the acl conflict rule (EnumDSSXMLConflictResolution) TQMS 784074, adding ACL options to Web API when adding a package.
      void setFlag​(int flag)
      Set the manipulation flag
      void setInheritACL​(int acl)
      Set the inherit acl (EnumDSSXMLSourceManipulatorInheritACL) TQMS 784074, adding ACL options to Web API when adding a package.
      void updateSchema()
      Update the schema for the current project
      void updateSchema​(int flag)
      Update the schema for the current project
    • Method Detail

      • addBulkMergeFromFile

        void addBulkMergeFromFile​(java.lang.String filePath)
        Open a delta file and apply its contents to the current project
        Parameters:
        filePath - The file to be read
      • addBulkMergeFromFile

        void addBulkMergeFromFile​(java.lang.String filePath,
                                  boolean useFileRules)
        Open a delta file and apply its contents to the current project
        Parameters:
        filePath - The file to be read
        useFileRules - Indicates whether we use rules contained in file
      • invoke

        void invoke​(java.lang.String comments)
             throws WebObjectsException
        Invoke manipulator to execute tasks defined in addBulkMergeFromFile with journal change log
        Parameters:
        comments -
        Throws:
        WebObjectsException
      • reset

        void reset()
        Clear task list for manipulator
      • setFlag

        void setFlag​(int flag)
        Set the manipulation flag
      • getFlag

        int getFlag()
        Get the value of manipulation flag
      • setACLConflictRule

        void setACLConflictRule​(int _aclConflictRule)
        Set the acl conflict rule (EnumDSSXMLConflictResolution) TQMS 784074, adding ACL options to Web API when adding a package.
      • getInheritACL

        int getInheritACL()
        Get the value of inherit acl
      • getACLConflictRule

        int getACLConflictRule()
        Get the value of acl conflict rule
      • addCreateUndoFile

        void addCreateUndoFile​(java.lang.String sourceFileName,
                               java.lang.String undoFileName)
        Create an undo file for a package
        Parameters:
        sourceFilePath - The file to be read
        undoFileName - The name of the generated undo file
      • createObjectDeltaPackage

        byte[] createObjectDeltaPackage​(java.lang.String objectID,
                                        int type,
                                        int conflictDomain,
                                        int conflictParts,
                                        int conflictResolution)
                                 throws java.lang.IllegalArgumentException,
                                        WebObjectsException
        Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
        Parameters:
        objectID - The DSSID of the object to package
        type - The EnumDSSXMLObjectTypes type of the object
        conflictDomain - The EnumDSSXMLConflictDomain for conflict resolution
        conflictParts - The EnumDSSXMLObjectFlags to indicate the object flags to be included in the resolution
        conflictResolution - The EnumDSSXMLConflictResolution rule to apply
        Returns:
        byte[] The object's binary representation
        Throws:
        java.lang.IllegalArgumentException
        WebObjectsException
      • createUndoPackageClientToClient

        byte[] createUndoPackageClientToClient​(java.io.InputStream data,
                                               long dataLength)
                                        throws WebObjectsException
        Create a undo package saved at client side, and the source file is at client side.
        Parameters:
        data - The inputStream of source file
        dataLength - The length of data
        Returns:
        A binary undo package
        Throws:
        WebObjectsException
      • createUndoPackageClientToServer

        void createUndoPackageClientToServer​(java.io.InputStream data,
                                             long dataLength,
                                             java.lang.String undoFilePath)
                                      throws WebObjectsException
        Create a undo package saved at server side, and the source file is at client side
        Parameters:
        data - The inputStream of source file
        dataLength - The length of data
        undoFilePath - The path of undo package saved at server side.
        Throws:
        WebObjectsException
      • createUndoPackageServerToClient

        byte[] createUndoPackageServerToClient​(java.lang.String sourceFilePath)
                                        throws WebObjectsException
        Create a undo package saved at client side, and the source file is at server side.
        Parameters:
        sourceFilePath - The path of source file at server side.
        Returns:
        A binary undo package
        Throws:
        WebObjectsException
      • createUndoPackageServerToServer

        void createUndoPackageServerToServer​(java.lang.String sourceFilePath,
                                             java.lang.String undoFilePath)
                                      throws WebObjectsException
        Create a undo package saved at server side, and the source file is at server side.
        Parameters:
        sourceFilePath - The path of source file at server side.
        undoFilePath - The path of undo package saved at server side.
        Throws:
        WebObjectsException
      • createObjectDeltaPackage

        byte[] createObjectDeltaPackage​(WebObjectInfo[] objects,
                                        int conflictDomain,
                                        int conflictParts,
                                        int conflictResolution)
                                 throws java.lang.IllegalArgumentException,
                                        WebObjectsException
        Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
        Parameters:
        objects - An array of WebObjectInfo items to include in the package
        type - The EnumDSSXMLObjectTypes type of the object
        conflictDomain - The EnumDSSXMLConflictDomain for conflict resolution
        conflictParts - The EnumDSSXMLObjectFlags to indicate the object flags to be included in the resolution
        conflictResolution - The EnumDSSXMLConflictResolution rule to apply
        Returns:
        byte[] The object's binary representation
        Throws:
        java.lang.IllegalArgumentException
        WebObjectsException
      • applyDeltaPackage

        void applyDeltaPackage​(java.io.InputStream deltaPackage,
                               long dataLength)
                        throws WebObjectsException
        Applies an first class binary representation on the current session's project
        Parameters:
        deltaPackage - The object's binary representation
        dataLength - The length of the package's InputStream
        Throws:
        WebObjectsException
      • applyDeltaPackage

        void applyDeltaPackage​(java.io.InputStream deltaPackage,
                               long dataLength,
                               java.lang.String comments)
                        throws WebObjectsException
        Applies an first class binary representation on the current session's with the comments in journal change log
        Parameters:
        deltaPackage -
        dataLength -
        comments -
        Throws:
        WebObjectsException
      • createObjectDeltaPackage

        byte[] createObjectDeltaPackage​(WebObjectInfo[] objects,
                                        ObjectDeltaFlags[] objDeltaFlags)
                                 throws java.lang.IllegalArgumentException,
                                        WebObjectsException
        Returns a binary package for a first class object that can be applied onto another MicroStrategy Project.
        Parameters:
        objects - An array of WebObjectInfo items to include in the package
        objDeltaFlags - An array of ObjectDeltaFlags to define multiple level conflict resolution to apply in the package
        Returns:
        byte[] The object's binary representation
        Throws:
        java.lang.IllegalArgumentException
        WebObjectsException