finwsFileExportPackageHandler Class - finPOWER Connect Business Layer

Represents a handler for creating and using File Export Packages, e.g., generated by an HTML Widget.

Information about the package is stored in a 'Status' file.

Methods

	Name	Description
	Clear
	CreateFileName	Create a Full File Name for a file that will appear in the Package, and add it (in its simplified form) to this Package's File Names List (without the path information).
	GetFullFileName	Get the Full File Name of an item in the FileNames collection.
	GetShortFileName	Get the Short File Name of an item in the FileNames collection, i.e., the file name without the Package prefix (and therefore the file name that is applicable after a Desktop finalise).
	GetStatusAsHtmlWidgetJsonObject
	GetStatusFileNameFull	The full File Name of the .status file.
	IncrementDownloadCount	Increment the Download Count and save the "status" file.
	RemoveFileName	Remove a File Name from the List, e.g., a File Name was added but then something went wrong and the file could not be generated.
	StatusSave	Save any changes to the Status file.
	StatusUpdateComplete	Update the Status to "Complete" and save the "status" file.
	StatusUpdateFailed	Update the Status to "Failed" and save the "status" file.
	StatusUpdateInProgress	Update the Status to "In Progress" and optionally update the Percentage and save the "status" file.