public interface

WebSourceManipulator

com.microstrategy.web.objects.WebSourceManipulator

Summary

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

Public Methods

public abstract void addBulkMergeFromFile (String filePath)

Open a delta file and apply its contents to the current project

Parameters
filePath The file to be read

public abstract void addBulkMergeFromFile (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

public abstract void addCreateUndoFile (String sourceFileName, String undoFileName)

Create an undo file for a package

Parameters
undoFileName The name of the generated undo file

public abstract void applyDeltaPackage (InputStream deltaPackage, long dataLength, String comments)

Applies an first class binary representation on the current session's with the comments in journal change log

Throws
WebObjectsException

public abstract void applyDeltaPackage (InputStream deltaPackage, long dataLength)

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

public abstract 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.

Parameters
objects An array of WebObjectInfo items to include in the package
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
IllegalArgumentException
WebObjectsException

public abstract byte[] createObjectDeltaPackage (WebObjectInfo[] objects, ObjectDeltaFlags[] objDeltaFlags)

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
IllegalArgumentException
WebObjectsException

public abstract byte[] createObjectDeltaPackage (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.

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
IllegalArgumentException
WebObjectsException

public abstract byte[] createUndoPackageClientToClient (InputStream data, long dataLength)

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

public abstract void createUndoPackageClientToServer (InputStream data, long dataLength, String undoFilePath)

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

public abstract byte[] createUndoPackageServerToClient (String sourceFilePath)

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

public abstract void createUndoPackageServerToServer (String sourceFilePath, String undoFilePath)

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

public abstract int getACLConflictRule ()

Get the value of acl conflict rule

public abstract int getFlag ()

Get the value of manipulation flag

public abstract int getInheritACL ()

Get the value of inherit acl

public abstract void invoke ()

Invoke manipulator to execute tasks defined in addBulkMergeFromFile

Throws
WebObjectsException Thrown if an error occurs.

public abstract void invoke (String comments)

Invoke manipulator to execute tasks defined in addBulkMergeFromFile with journal change log

Throws
WebObjectsException

public abstract void reset ()

Clear task list for manipulator

public abstract void setACLConflictRule (int _aclConflictRule)

Set the acl conflict rule (EnumDSSXMLConflictResolution) TQMS 784074, adding ACL options to Web API when adding a package.

public abstract void setFlag (int flag)

Set the manipulation flag

public abstract void setInheritACL (int acl)

Set the inherit acl (EnumDSSXMLSourceManipulatorInheritACL) TQMS 784074, adding ACL options to Web API when adding a package.

public abstract void updateSchema ()

Update the schema for the current project

Throws
WebObjectsException Thrown if an error occurs.

public abstract void updateSchema (int flag)

Update the schema for the current project

Parameters
flag Flags which part of the schema should be updated, from EnumDSSSourceManipulationSchema.
Throws
WebObjectsException Thrown if an error occurs.