Interface DeliveryExportDelegate
- All Known Implementing Classes:
AbstractDeliveryExportDelegate
public interface DeliveryExportDelegate
A delegate used for package delivery export format-specific behavior.
Supported API: true
Extendable: false
-
Method Summary
Modifier and TypeMethodDescriptionbuildExportFiles(DeliveryRecord deliveryRecord) Builds export files given the passed in delivery record.getPackageExportGraph(DeliveryRecord delivery) Returns instance of PackageExportGraph for passed in delivery record.getPackageExportGraph(DeliveryRecord delivery, boolean bApplyFilters) Returns instance of PackageExportGraph for passed in delivery record.
-
Method Details
-
buildExportFiles
Builds export files given the passed in delivery record. The delivery record must have the following values set:- setMyWorkPackage(WorkPackage)
- setSentFrom(WTUser)
- In general this should be set to SessionHelper.getPrincipal() setDeliveryManifest(DeliveryManifestType)
-
setDeliveryMedium(DeliveryMediumType)
- setDeliveryOption(DeliveryOptionType)
-
if DeliveryOptionType is not DeliveryOptionType.FULL
- then the following must also be set:
- setBase(DeliveryRecord)
- then the following must also be set:
Extendable: false- Parameters:
deliveryRecord-DeliveryRecordbeing exported- Returns:
- delivery export result containing information about the export and export files
- Throws:
WTException- to be handled by caller
- setMyWorkPackage(WorkPackage)
-
getPackageExportGraph
Returns instance of PackageExportGraph for passed in delivery record.
Supported API: true
Extendable: false.- Parameters:
delivery- the delivery- Returns:
- package export graph
- Throws:
WTException- to be handled by caller
-
getPackageExportGraph
PackageExportGraph getPackageExportGraph(DeliveryRecord delivery, boolean bApplyFilters) throws WTException Returns instance of PackageExportGraph for passed in delivery record. The second flag determines if member access filters should be applied.
Supported API: true
Extendable: false.- Parameters:
delivery- the deliverybApplyFilters- determines if member access filters should be applied- Returns:
- package export graph
- Throws:
WTException- to be handled by caller
-