com.ibm.ftt.resources.core.physical
Interface PhysicalSystemRegistry

All Superinterfaces:
IPopulatorConstants

public interface PhysicalSystemRegistry
extends IPopulatorConstants

A registry of the remote systems defined in the workspace.


Field Summary
static String COPY_RIGHT
           
 
Fields inherited from interface com.ibm.ftt.resources.core.physical.IPopulatorConstants
MVSFiles
 
Method Summary
 boolean add(IOSImage system)
          Registers a system.
 boolean contains(IOSImage system, int type)
          Determines whether the given system is registered or not.
 IOSImage find(String systemName, int type)
          Find a system in this registry by name and type.
 Object[] getSystems(int type)
          Returns an array of systems defined in the workspace.
 boolean remove(IOSImage system)
          Removes a system from this registry.
 

Field Detail

COPY_RIGHT

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

getSystems

Object[] getSystems(int type)
Returns an array of systems defined in the workspace.

For example, registered MVS files subsystems can be obtained by the following code:

 Object [] systemReferences = PhysicalSystemRegistryFactory.getSingleton()
                              .getSystems(IPopulatorConstants.MVSFiles);
 
The systemReferences contains IOSImage instances for MVS files subsystems.

Parameters:
type - the type of subsystem to get. Specify a subsystem factory ID defined in IPopulatorConstants.
Returns:
an array of IOSImage. If no system was found for the specified type, returns an empty array

add

boolean add(IOSImage system)
Registers a system.

The system names have to be unique for a given system image type. If a system with the same name and type already exists in this registry, the given system is not added and returns false.

Parameters:
system - the system to add
Returns:
true if successfully added; false otherwise
See Also:
IOSImage.equals(Object)

remove

boolean remove(IOSImage system)
Removes a system from this registry.

Parameters:
system - the system to remove
Returns:
true if successfully removed; false otherwise

contains

boolean contains(IOSImage system,
                 int type)
Determines whether the given system is registered or not.

Parameters:
system - the system to find
type - the type of subsystem to find. Specify a subsystem factory ID defined in IPopulatorConstants.
Returns:
true if the system is registered; false if not
See Also:
IOSImage.equals(Object)

find

IOSImage find(String systemName,
              int type)
Find a system in this registry by name and type. Searches the registry for a system with the given name and type, and returns the system if found.

Parameters:
systemName - the name of the system to find
type - the type of subsystem to find. Specify a subsystem factory ID defined in IPopulatorConstants.
Returns:
IOSImage of the specified type, or null if not found