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

All Superinterfaces:
Comparable, org.eclipse.core.runtime.IAdaptable, IContainer, IPhysicalContainer, IPhysicalResource, ZOSDataSet, ZOSResource

public interface ZOSGenerationDataGroup
extends ZOSDataSet, IPhysicalContainer

The ZOSGenerationDataGroup represents a generation data group in a z/OS system.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void addDataSet(ZOSDataSet dataSet)
          Add data set to this generation data group
 void define(int limit, boolean empty, boolean scratch, String owner, boolean forSelected, String forDate, String toDate, org.eclipse.core.runtime.IProgressMonitor monitor)
          Define generation data group for this handle
 org.eclipse.core.runtime.IAdaptable findMemberInModel(String name)
          Find a generation data set in model
 SortedSet getDataSets()
          Get generation data set of this generation data group
 int getLimit()
          Get limit value
 boolean isEmpty()
          Determine if empty flag is set
 boolean isScratch()
          Determine if scratch flag is set
 void removeDataSet(ZOSDataSet dataSet)
          Remove data set from this generation data group
 void setEmpty(boolean empty)
          Set empty flag
 void setLimit(int limit)
          Set limit value
 void setScratch(boolean scratch)
          Set scratch flag
 
Methods inherited from interface com.ibm.ftt.resources.zos.zosphysical.ZOSDataSet
allocate, allocateLike, getCatalog, getCharacteristics, getGenerationDataGroup, getReference, getRelativeGenerationNumber, hdelete, isAlias, isMigrated, isOfflineVolume, migrate, recall, setCharacteristics, setGenerationDataGroup
 
Methods inherited from interface com.ibm.ftt.resources.zos.zosphysical.ZOSResource
copy, getCharset, getMVSFileMapping, getMVSFileMappingOverride, getName, getResourceIdentifier, setMVSFileMappingOverride
 
Methods inherited from interface com.ibm.ftt.resources.core.physical.IPhysicalResource
delete, deleteOverriddenPropertiesInCategory, deleteOverride, exists, getCurrentPropertyGroup, getFullPath, getModificationStamp, getModificationStamp, getOverriddenProperties, getParent, getPersistentProperty, getResourcePublisher, getSessionProperty, refresh, rename, setCurrentPropertyGroup, setOverride, setPersistentProperty, setSessionProperty
 
Methods inherited from interface com.ibm.ftt.resources.core.physical.IContainer
exists, findMember, findMember, getMembers, members
 

Field Detail

COPY_RIGHT

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

getDataSets

SortedSet getDataSets()
Get generation data set of this generation data group

Returns:
generation data set in sorted set

findMemberInModel

org.eclipse.core.runtime.IAdaptable findMemberInModel(String name)
Find a generation data set in model

Parameters:
name - generation data set name
Returns:
generation data set

define

void define(int limit,
            boolean empty,
            boolean scratch,
            String owner,
            boolean forSelected,
            String forDate,
            String toDate,
            org.eclipse.core.runtime.IProgressMonitor monitor)
            throws OperationFailedException
Define generation data group for this handle

Parameters:
limit - limit value
empty - empty flag
scratch - scratch flag
owner - owner of the defined generation data group
forSelected - retention period is specified by "for" or "to"
forDate - retention period specified by "for"
toDate - retention period specified by "to"
monitor - progress monitor
Throws:
OperationFailedException

isEmpty

boolean isEmpty()
Determine if empty flag is set

Returns:
true if empty flag is set, or false if not

setEmpty

void setEmpty(boolean empty)
Set empty flag

Parameters:
empty - empty flag

isScratch

boolean isScratch()
Determine if scratch flag is set

Returns:
true if scratch flag is set, or false if not

setScratch

void setScratch(boolean scratch)
Set scratch flag

Parameters:
scratch - scratch flag

getLimit

int getLimit()
Get limit value

Returns:
limit value

setLimit

void setLimit(int limit)
Set limit value

Parameters:
limit - limit value

addDataSet

void addDataSet(ZOSDataSet dataSet)
Add data set to this generation data group

Parameters:
dataSet - data set to be added

removeDataSet

void removeDataSet(ZOSDataSet dataSet)
Remove data set from this generation data group

Parameters:
dataSet - data set to be removed