com.ibm.ftt.resources.zos.zosphysical
Interface DataSetCharacteristics


public interface DataSetCharacteristics

A DataSetCharacteristics holds various characteristics of a z/OS data set and provides accessor methods for the characteristics.

A DataSetCharacteristics instance containing information about the data set can be obtained from a ZOSDataSet. One can also create a new instance using ZosphysicalFactory.createDataSetCharacteristics() and use it to set the data set characteristics of a ZOSDataSet to be allocated.

See Also:
ZOSDataSet.getCharacteristics(), ZOSDataSet.setCharacteristics(DataSetCharacteristics), ZosphysicalFactory.createDataSetCharacteristics()

Field Summary
static String COPY_RIGHT
           
 
Method Summary
 int getBlockSize()
          Returns the block size.
 String getDataClass()
          Returns the data class.
 int getDirectoryBlocks()
          Returns the directory blocks.
 DataSetType getDSNType()
          Returns the data set type.
 String getDSOrg()
          Returns the data set organization.
 Date getExpirationDate()
          Returns the expiration date.
 String getGenericUnit()
          Returns the generic unit.
 String getManagementClass()
          Returns the management class.
 int getPrimaryQuantity()
          Returns the primary allocation.
 RecordFormat getRecordFormat()
          Returns the record format.
 int getRecordLength()
          Returns the record length.
 int getSecondaryQuantity()
          the primary allocation to set to the data set.
 SpaceUnits getSpaceUnits()
          Returns the space units.
 String getStorageClass()
          Returns the storage class.
 String getVolumeSerial()
          Returns the volume serial.
 void setBlockSize(int value)
          Sets the block size.
 void setDataClass(String value)
          Sets the data class.
 void setDirectoryBlocks(int value)
          Sets the directory blocks.
 void setDSNType(DataSetType value)
          Sets the data set type.
 void setDSOrg(String value)
          Sets the data set organization.
 void setExpirationDate(Date value)
          Sets the expiration date.
 void setGenericUnit(String value)
          Sets the generic unit.
 void setManagementClass(String value)
          Sets the management class.
 void setPrimaryQuantity(int value)
          Sets the primary allocation.
 void setRecordFormat(RecordFormat value)
          Sets the record format.
 void setRecordLength(int value)
          Sets the record length.
 void setSecondaryQuantity(int value)
          Sets the secondary allocation.
 void setSpaceUnits(SpaceUnits value)
          Sets the space units.
 void setStorageClass(String value)
          Sets the storage class.
 void setVolumeSerial(String value)
          Sets the volume serial.
 

Field Detail

COPY_RIGHT

static final String COPY_RIGHT
See Also:
Constant Field Values
Method Detail

getVolumeSerial

String getVolumeSerial()
Returns the volume serial.

Returns:
a string representing the volume serial of the data set
See Also:
setVolumeSerial(String)

setVolumeSerial

void setVolumeSerial(String value)
Sets the volume serial.

Parameters:
value - a string representing the volume serial of the data set

getGenericUnit

String getGenericUnit()
Returns the generic unit.

Returns:
a string representing the generic unit of the data set
See Also:
setGenericUnit(String)

setGenericUnit

void setGenericUnit(String value)
Sets the generic unit.

Parameters:
value - a string representing the generic unit of the data set
See Also:
getGenericUnit()

getSpaceUnits

SpaceUnits getSpaceUnits()
Returns the space units.

Returns:
a space unit object that represents blocks, tracks or cylinders
See Also:
setSpaceUnits(SpaceUnits)

setSpaceUnits

void setSpaceUnits(SpaceUnits value)
Sets the space units.

Parameters:
value - a space unit object that represents blocks, tracks or cylinders
See Also:
setSpaceUnits(SpaceUnits)

getPrimaryQuantity

int getPrimaryQuantity()
Returns the primary allocation.

Returns:
the primary allocation of the data set
See Also:
setPrimaryQuantity(int)

setPrimaryQuantity

void setPrimaryQuantity(int value)
Sets the primary allocation.

Parameters:
value - the primary allocation to set to the data set

getSecondaryQuantity

int getSecondaryQuantity()
the primary allocation to set to the data set.

Returns:
the secondary allocation of the data set
See Also:
setSecondaryQuantity(int)

setSecondaryQuantity

void setSecondaryQuantity(int value)
Sets the secondary allocation.

Parameters:
value - the secondary allocation to set to the data set
See Also:
getPrimaryQuantity()

getDirectoryBlocks

int getDirectoryBlocks()
Returns the directory blocks.

Returns:
the directory blocks value of the data set
See Also:
setDirectoryBlocks(int)

setDirectoryBlocks

void setDirectoryBlocks(int value)
Sets the directory blocks.

Directory blocks should be 0 for sequential data sets.

Parameters:
value - the directory blocks value to set to the data set
See Also:
setDirectoryBlocks(int)

getRecordFormat

RecordFormat getRecordFormat()
Returns the record format.

Returns:
a record format object that represents FB, F, VB, etc.
See Also:
setRecordFormat(RecordFormat)

setRecordFormat

void setRecordFormat(RecordFormat value)
Sets the record format.

Parameters:
value - a record format object that represents FB, F, VB, etc.
See Also:
getRecordFormat()

getRecordLength

int getRecordLength()
Returns the record length.

Returns:
the record length value of the data set
See Also:
setRecordLength(int)

setRecordLength

void setRecordLength(int value)
Sets the record length.

Parameters:
value - the record length value to set to the data set
See Also:
getRecordLength()

getBlockSize

int getBlockSize()
Returns the block size.

Returns:
the block size value of the data set
See Also:
setBlockSize(int)

setBlockSize

void setBlockSize(int value)
Sets the block size.

Parameters:
value - the block size value to set to the data set
See Also:
getBlockSize()

getDSOrg

String getDSOrg()
Returns the data set organization.

Returns:
the string representing the data set organization, can be either "PS" or "PO"
See Also:
setDSOrg(String)

setDSOrg

void setDSOrg(String value)
Sets the data set organization.

Parameters:
value - a string representing the data set organization, can be either "PS" or "PO"
See Also:
getDSOrg()

getExpirationDate

Date getExpirationDate()
Returns the expiration date.

Returns:
a date object that represents the expiration date of the data set
See Also:
setExpirationDate(Date)

setExpirationDate

void setExpirationDate(Date value)
Sets the expiration date.

Parameters:
value - a date object that represents the expiration date of the data set
See Also:
getExpirationDate()

setDSNType

void setDSNType(DataSetType value)
Sets the data set type.

Parameters:
value - a data set type object that represents PDS, PDSE, etc.
See Also:
getDSNType()

getDSNType

DataSetType getDSNType()
Returns the data set type.

Returns:
a data set type object that represents PDS, PDSE, etc.
See Also:
setDSNType(DataSetType)

setManagementClass

void setManagementClass(String value)
Sets the management class.

Parameters:
value - a string that represents the management class of the data set
See Also:
getManagementClass()

getManagementClass

String getManagementClass()
Returns the management class.

Returns:
a string that represents the management class of the data set
See Also:
setManagementClass(String)

setStorageClass

void setStorageClass(String value)
Sets the storage class.

Parameters:
value - a string that represents the storage class of the data set
See Also:
getStorageClass()

getStorageClass

String getStorageClass()
Returns the storage class.

Returns:
a string that represents the storage class of the data set
See Also:
setStorageClass(String)

setDataClass

void setDataClass(String value)
Sets the data class.

Parameters:
value - a string that represents the data class of the data set
See Also:
getDataClass()

getDataClass

String getDataClass()
Returns the data class.

Returns:
a string that represents the data class of the data set
See Also:
setDataClass(String)