ValidCancelDiscardSamplesQ

ValidCancelDiscardSamplesQ[objects]⟹bools

checks whether the provided objects and specified options are valid for calling CancelDiscardSamples.

Details

Input

Output

General Options

Examples

Basic Examples (3)

Check the validity of the CancelDiscardSamples call to: Cancel a pending disposal request for a sample to ensure it is not permanently discarded as part of regular maintenance:

Check the validity of the CancelDiscardSamples call to: 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:

Check the validity of the CancelDiscardSamples call to: Cancel a disposal request for multiple samples and containers:

Additional Examples (3)

Check the validity of the CancelDiscardSamples call for: This function can be safely run on a sample that is not marked for disposal; it will have no effect:

Check the validity of the CancelDiscardSamples call for: This function will ensure that the AwaitingDisposal flag is set to Null for both a sample and its container:

Check the validity of the CancelDiscardSamples call for: The sample's DisposalLog reflects the change to the discarded request:

Options (3)

OutputFormat (1)

Check the validity of CancelDiscardSamples to Cancel a disposal request for multiple samples and containers, and return a test summary if OutputFormat -> TestSummary:

Verbose (2)

Check the validity of CancelDiscardSamples to Cancel a disposal request for multiple samples and containers, and indicate the passing and failing tests with the Verbose option:

Check the validity of CancelDiscardSamples to Cancel a disposal request if not all samples within the same container are undiscarded, and indicate only the failing tests with the Verbose -> Failures option:

Messages (2)

ContainerConflict (1)

Check the validity of the CancelDiscardSamples call 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)

Check the validity of the CancelDiscardSamples call so that: A warning is thrown if any provided samples have already been permanently thrown away; these samples will be ignored: