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

Interface IPartitionedDataSet

  • All Superinterfaces:
    IDataSet, IHostResource
    public interface IPartitionedDataSet
extends IDataSet
    A partitioned dataset (PDS) that resides on a z/OS host.

    For details on the state of an IPartitionedDataSet and the function of its methods, see IHostResource.

    Regarding parameter validation for the methods within this class:

    A PDS member name is considered invalid if:

    • The length of the name is 0 or is greater than 8 characters.
    • Any characters outside of the code page 1047 hex values for A-Z, a-z, 0-9, @, #, or $ are present.
    • The name starts with a digit (0-9).

    The following rules apply when determining whether a PDS member filter is valid:

    • * - A single asterisk indicates that zero or more characters can occupy that position.
    • **… - Multiple asterisks can be specified, but sequential asterisks are treated as a single asterisk.
    • % - A single percent sign indicates that any one single alphanumeric or national character can occupy that position.
    • %%... - One to eight percent signs can be specified.

    Examples:
    To allocate a partitioned dataset: 

     IDataSetCommandProvider commandProvider = ...
 String dataSetName = ...
 IAllocateParameters parameters = ...
 
 try {
     commandProvider.allocatePartitionedDataSet(dataSetName, parameters);
 } catch (DataSetExistsException e) {
     // the dataset already exists
     ...
 } catch (AllocationFailedException e) {
     // the allocation failed - most likely because the user does not have the proper authority
     ...
 }
    (Note: the above catch blocks can be replaced with a single catch block on HostResourceException.)

    (Note: see AllocateParametersBuilder for examples of building allocate parameters.)

    To retrieve a partitioned dataset: 

     IDataSetCommandProvider commandProvider = ...
 String dataSetName = ...
 
 // dataSet will be null if it cannot be found
 IPartitionedDataSet dataSet = commandProvider
         .findPartitionedDataSet(dataSetName);
    To retrieve a list of partitioned datasets matching a filter: 
     IDataSetCommandProvider commandProvider = ...
 String dataSetFilter = ...
 
 // dataSets will be empty if no partitioned datasets match the dataset
 // filter
 List<IPartitionedDataSet> dataSets = commandProvider
         .findPartitionedDataSets(dataSetFilter);
    For examples on how to obtain an IDataSetCommandProvider see IDataSetCommandProvider.
    For examples of how to retrieve generic IDataSets see IDataSet.
    For examples of how to build allocate parameters see AllocateParametersBuilder.
    Since:
    1.0.0
    Version:
    2.0.0
    See Also:
    IPartitionedDataSetCharacteristics, IPartitionedDataSetMember
    Restriction:
    This interface is not intended to be extended by clients.
    Restriction:
    This interface is not intended to be implemented by clients.