com.ibm.pim.common
Interface ProcessingOptions


public interface ProcessingOptions

The advanced methods provided via this object represent administrative parameters that affect the way in which items in a catalog are handled from the perspective of functional flows for example saving an item. These methods provide temporary ways to change the default behavior so for performance reasons. An example would be if an item import was taking place it would be beneficial not to have locking enabled so this can be disabled.

Note that no PIMAutorizationException can be thrown here since access to and authorization for these methods is controlled from the parent

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void resetProcessingOptions()
          Re-enables the default processing options disabled by methods such as disablePreScript, disableMinMaxOccurrenceValidation, etc
 void setAllProcessingOptions(boolean setEnabled)
          Set all processing options: enabled or disabled.
 void setCategoryLockingForItemSaveProcessing(boolean setEnabled)
          Set lock categories for item save validation processing: enabled or disabled.
 void setCollaborationAreaLocksValidationProcessing(boolean setEnabled)
          Set collaboration area lock validation processing: enabled or disabled.
 void setDefaultValueRulesProcessing(boolean setEnabled)
          Set default value rules processing: enabled or disabled.
 void setDefaultValuesProcessing(boolean setEnabled)
          Set default values processing: enabled or disabled.
 void setEntryBuildScriptProcessing(boolean setEnabled)
          Set Entry Build Script processing: enabled or disabled.
 void setLocaleRestrictionsForScripts(boolean setEnabled)
          sets or clears the enforcement of locale restrictions for scripts
 void setLockingProcessing(boolean setEnabled)
          Set locking processing: enabled or disabled.
 void setMergeWithOldVersionProcessing(boolean setEnabled)
          Set merge with old version processing: enabled or disabled.
 void setMinMaxLengthProcessing(boolean setEnabled)
          Set Min & Max Length processing: enabled or disabled.
 void setMinMaxOccurrenceValidationProcessing(boolean setEnabled)
          Set Min & Max Occurrence Validation processing: enabled or disabled.
 void setPatternValidationProcessing(boolean setEnabled)
          Set Pattern validation processing: enabled or disabled.
 void setPossibleValueProcessing(boolean setEnabled)
          Set Possible Value processing: enabled or disabled.
 void setPostSaveScriptProcessing(boolean setEnabled)
          Set post-save script processing for this collaboration area: enabled or disabled.
 void setPostScriptProcessing(boolean setEnabled)
          Set post-script processing: enabled or disabled.
 void setPreScriptProcessing(boolean setEnabled)
          Set pre-script processing: enabled or disabled.
 void setSequencesProcessing(boolean setEnabled)
          Set sequence field completion processing: enabled or disabled.
 void setTypeValidationProcessing(boolean setEnabled)
          Set type validation processing: enabled or disabled.
 void setUniquenessValidationProcessing(boolean setEnabled)
          Set uniqueness validation processing: enabled or disabled.
 void setValidationRulesProcessing(boolean setEnabled)
          Set validation-rule processing: enabled or disabled.
 void setValueRulesProcessing(boolean setEnabled)
          Set value-rule validation processing: enabled or disabled.
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

resetProcessingOptions

void resetProcessingOptions()
Re-enables the default processing options disabled by methods such as disablePreScript, disableMinMaxOccurrenceValidation, etc

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Throws:
PIMInternalException - If an internal error occurs

setAllProcessingOptions

void setAllProcessingOptions(boolean setEnabled)
Set all processing options: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setCategoryLockingForItemSaveProcessing

void setCategoryLockingForItemSaveProcessing(boolean setEnabled)
Set lock categories for item save validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setDefaultValuesProcessing

void setDefaultValuesProcessing(boolean setEnabled)
Set default values processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setDefaultValueRulesProcessing

void setDefaultValueRulesProcessing(boolean setEnabled)
Set default value rules processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setEntryBuildScriptProcessing

void setEntryBuildScriptProcessing(boolean setEnabled)
Set Entry Build Script processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setLocaleRestrictionsForScripts

void setLocaleRestrictionsForScripts(boolean setEnabled)
sets or clears the enforcement of locale restrictions for scripts

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true to turn on enforcement, false to turn off enforcement
Throws:
PIMInternalException - If an internal error occurs

setLockingProcessing

void setLockingProcessing(boolean setEnabled)
Set locking processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setCollaborationAreaLocksValidationProcessing

void setCollaborationAreaLocksValidationProcessing(boolean setEnabled)
Set collaboration area lock validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setMergeWithOldVersionProcessing

void setMergeWithOldVersionProcessing(boolean setEnabled)
Set merge with old version processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setMinMaxOccurrenceValidationProcessing

void setMinMaxOccurrenceValidationProcessing(boolean setEnabled)
Set Min & Max Occurrence Validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setMinMaxLengthProcessing

void setMinMaxLengthProcessing(boolean setEnabled)
Set Min & Max Length processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setPatternValidationProcessing

void setPatternValidationProcessing(boolean setEnabled)
Set Pattern validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setPossibleValueProcessing

void setPossibleValueProcessing(boolean setEnabled)
Set Possible Value processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setPostSaveScriptProcessing

void setPostSaveScriptProcessing(boolean setEnabled)
Set post-save script processing for this collaboration area: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setPostScriptProcessing

void setPostScriptProcessing(boolean setEnabled)
Set post-script processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setPreScriptProcessing

void setPreScriptProcessing(boolean setEnabled)
Set pre-script processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setSequencesProcessing

void setSequencesProcessing(boolean setEnabled)
Set sequence field completion processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setTypeValidationProcessing

void setTypeValidationProcessing(boolean setEnabled)
Set type validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Note that if this option is disabled, no validation errors will be reported due to invalid data supplied to attributes but no data will be modified, for example, Type conversion problems. To check whether there are validation errors, use save or validate methods.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setUniquenessValidationProcessing

void setUniquenessValidationProcessing(boolean setEnabled)
Set uniqueness validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setValidationRulesProcessing

void setValidationRulesProcessing(boolean setEnabled)
Set validation-rule processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs

setValueRulesProcessing

void setValueRulesProcessing(boolean setEnabled)
Set value-rule validation processing: enabled or disabled. Not recommended. Use resetProcessingOptions() to reset all options to their default value.

The use of this type of function applies solely to the in memory instance of this object whilst applying a specific process to it such as an import This will not alter the parameters on the underlying object and cannot be saved as default behavior.

Parameters:
setEnabled - true if the option is enabled false to disable
Throws:
PIMInternalException - If an internal error occurs