com.ibm.workplace.wcm.api.custom
Interface DeleteDirectiveParams

All Superinterfaces:

DirectiveParams, java.io.Serializable

All Known Implementing Classes:

WCM_DeleteDirectiveParams

public interface DeleteDirectiveParams
extends DirectiveParams

The DeleteDirectiveParams object is used to specify arguments or options to a 'Delete' Directive.

To create a new DeleteDirectiveParams object call Directives.DELETE.createDirectiveParams() and cast the returned object to DeleteDirectiveParams

To use a DeleteDirectiveParams object call the CustomWorkflowActionService.createResult(Directive, String, DirectiveParams) method instead of CustomWorkflowActionService.createResult(Directive, String) to construct the workflow action result.

Since:

6.1

Method Summary

boolean	isPermanentDelete() Indicates if a permanent delete has been requested
void	setPermanentDelete(boolean performPermanentDelete) Specifies whether the Delete Directive should perform a permanent delete.

Method Detail

setPermanentDelete

void setPermanentDelete(boolean performPermanentDelete)

Specifies whether the Delete Directive should perform a permanent delete.

By default all deletes of non-draft items are soft-deletes. Draft items are always permanently deleted.

Parameters:

performPermanentDelete - true if a permanent delete should be performed. false otherwise

isPermanentDelete

boolean isPermanentDelete()

Indicates if a permanent delete has been requested

Returns:

true if a permanent delete has been requested, false otherwise