Package com.compuware.api.topaz.hostresources.zos

Class DefineGenerationDataGroupParametersBuilder

  • public class DefineGenerationDataGroupParametersBuilder
extends Object
    Builder class used to create instances of IDefineGenerationDataGroupParameters.

    This builder can be used to create define generation data group parameters based off of default parameters.

    The following steps should be used to create an instance of IDefineGenerationDataGroupParameters:

    • call the static defaults() method of this class to create a builder instance
    • optionally, call any of this builder's setter methods to specify alternate values
    • call this builder's build() method to create the IDefineGenerationDataGroupParameters instance

    Examples:
    To create define generation data group parameters using all defaults: 

     IDefineGenerationDataGroupParameters parameters = DefineGenerationDataGroupParametersBuilder
         .defaults().build();
    To create define generation data group parameters while overriding some parameters: 
     IDefineGenerationDataGroupParameters parameters = DefineGenerationDataGroupParametersBuilder
         .defaults().setGenerationsLimit(50)
         .setScratchOnEmpty(true, false).build();
 
 // alternatively:
 
 DefineGenerationDataGroupParametersBuilder builder = DefineGenerationDataGroupParametersBuilder
         .defaults();
 builder.setGenerationsLimit(50);
 builder.setScratchOnEmpty(true, false);
 IDefineGenerationDataGroupParameters parameters = builder.build();
    For example on how to define generation data groups see IGenerationDataGroup.
    Since:
    2.1.0
    Version:
    2.1.0
    See Also:
    IDataSetCommandProvider.defineGenerationDataGroup(String, IDefineGenerationDataGroupParameters)

    • Method Detail

      • defaults

        public static DefineGenerationDataGroupParametersBuilder defaults()
        Creates a define generation data group parameters builder instance with default parameters.

        The builder created by this method will have its parameters set to the following values:

        • generations limit: 255
        • empty all: false
        • scratch on empty: false
        • override expiration date: false
        • ordering: LIFO
        Returns:
        a new define generation data group parameters builder
        Since:
        2.1.0

      • setEmptyAll

        public DefineGenerationDataGroupParametersBuilder setEmptyAll​(boolean isEmptyAll)
        Sets whether all generation data sets should be emptied (i.e. removed) when the generation data group limit is exceeded or if only the oldest generation data set should be emptied.

        The default is false.

        Use setScratchOnEmpty(boolean, boolean) to control whether emptied generation data sets should also be scratched (i.e. deleted).

        Parameters:
        isEmptyAll - true to empty all generation data sets when the limit is exceeded, false to only empty the oldest
        Returns:
        this define generation data group parameters builder to allow for method chaining
        Since:
        2.1.0
        See Also:
        setGenerationsLimit(int), setScratchOnEmpty(boolean, boolean)

      • setScratchOnEmpty

        public DefineGenerationDataGroupParametersBuilder setScratchOnEmpty​(boolean isScratchOnEmpty,
                                                                    boolean isOverrideExpirationDate)
        Sets whether generation data sets should be scratched (i.e. deleted) and whether the expiration date should be ignored (i.e. purged) when generation data sets are emptied.

        The default for both parameters is false.

        Use setEmptyAll(boolean) to control what generation data sets are emptied when the generations limit is exceeded.

        Parameters:
        isScratchOnEmpty - true to scratch (i.e. delete) generation data sets when they are emptied, otherwise false
        isOverrideExpirationDate - true to also override the expiration date (i.e. purge) when scratching generation data sets, otherwise false (only applicable when isScratchOnEmpty is true)
        Returns:
        this define generation data group parameters builder to allow for method chaining
        Since:
        2.1.0
        See Also:
        setGenerationsLimit(int), setEmptyAll(boolean)