ecl-logo Documentation

CancelDiscardSamplesPreview

CancelDiscardSamplesPreview[objects]updatedObjects

returns the preview for CancelDiscardSamples when it is called on objects.

Details

    Input
    Output

Examples

Basic Examples  (3)

Returns Preview for: Cancel a pending disposal request for a sample to ensure it is not permanently discarded as part of regular maintenance:

Returns Preview for: Cancel a pending disposal request for a container and the samples in it to ensure they are not permanently discarded as part of regular maintenance:

Returns Preview for: Cancel a disposal request for multiple samples and containers:

Additional Examples  (3)

Returns Preview for: This function can be safely run on a sample that is not marked for disposal; it will have no effect:

Returns Preview for: This function will ensure that the AwaitingDisposal flag is set to Null for both a sample and its container:

Returns Preview for: The sample's DisposalLog reflects the change to the discarded request:

Messages  (2)

ContainerConflict  (1)

Returns Preview for: If not all samples within the same container are undiscarded, an error is returned; the entire container and all its samples must be all undiscarded simultaneously:

SamplesAlreadyDiscarded  (1)

Returns Preview for: A warning is thrown if any provided samples have already been permanently thrown away; these samples will be ignored: