com.ibm.ftt.properties.zos
Class ZOSPropertyGroupManager

java.lang.Object
  extended by com.ibm.ftt.properties.util.AbstractPropertyGroupManager
      extended by com.ibm.ftt.properties.impl.InternalAbstractPropertyGroupManager
          extended by com.ibm.ftt.properties.zos.InternalZOSPropertyGroupManager
              extended by com.ibm.ftt.properties.zos.ZOSPropertyGroupManager
All Implemented Interfaces:
IPropertyGroupManager, org.eclipse.rse.core.events.ISystemModelChangeListener

public class ZOSPropertyGroupManager
extends com.ibm.ftt.properties.zos.InternalZOSPropertyGroupManager
implements IPropertyGroupManager, org.eclipse.rse.core.events.ISystemModelChangeListener

This class provides access to property groups that can be associated with ILogicalResource and IPhysicalResource resources. It also supports property groups for systems. Each system is identified by the name of a ZOSSytemImage.

This class creates a property group container for each system.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void deleteOverriddenPropertiesInCategory(String system, ICategory category)
          Delete all of the overridden properties for the given system that are defined by the given category.
 void deleteOverride(String system, IProperty property)
          Delete the override for the given property for the given system.
 IPropertyGroup getCurrentPropertyGroup(String system)
          Get the current property group for the given system.
 List<IProperty> getOverriddenProperties(String system)
          Returns the overridden properties for the given system.
 IPropertyGroupContainer getPropertyGroupContainer(String name)
          Get the container for the given name of a ZOSSystemImage.
 List<IPropertyGroupContainer> getPropertyGroupContainers()
          Returns a list of property group containers.
static ZOSPropertyGroupManager getZOSPropertyGroupManager()
          Returns the singleton instance of the ZOSPropertyGroupManager.
 void setCurrentPropertyGroup(String system, IPropertyGroup group)
          Set the current property group for the given system.
 void setOverride(String system, IProperty property, String newValue)
          Set an override for the given property for the given system.
 
Methods inherited from interface com.ibm.ftt.properties.IPropertyGroupManager
deregister, getCategories, register
 

Field Detail

COPY_RIGHT

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

getZOSPropertyGroupManager

public static ZOSPropertyGroupManager getZOSPropertyGroupManager()
Returns the singleton instance of the ZOSPropertyGroupManager.

Returns:
The ZOSPropertyGroupManager.

getPropertyGroupContainers

public List<IPropertyGroupContainer> getPropertyGroupContainers()
Returns a list of property group containers. There will be one container for each host. The containers are of type ZOSPropertyGroupContainer.

Specified by:
getPropertyGroupContainers in interface IPropertyGroupManager
Specified by:
getPropertyGroupContainers in class AbstractPropertyGroupManager
Returns:
The list of property group containers. An empty list is returned if there are no hosts.

getPropertyGroupContainer

public IPropertyGroupContainer getPropertyGroupContainer(String name)
Get the container for the given name of a ZOSSystemImage.

Specified by:
getPropertyGroupContainer in class com.ibm.ftt.properties.zos.InternalZOSPropertyGroupManager
Parameters:
name - The name of a ZOSSystemImage
Returns:
The property group container for the ZOSSystemImage with a name that matches the given name, or null.

setCurrentPropertyGroup

public void setCurrentPropertyGroup(String system,
                                    IPropertyGroup group)
                             throws IllegalSystemException
Set the current property group for the given system. The system is identified by the name of a ZOSSystemImage.

Parameters:
system - The name of a ZOSSystemImage.
group - The property group that will be the current property group. It can be null to remove the current property group from a system.
Throws:
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the system parameter.

getCurrentPropertyGroup

public IPropertyGroup getCurrentPropertyGroup(String system)
                                       throws IllegalSystemException
Get the current property group for the given system. The system is the name of a ZOSSystemImage.

Parameters:
system - The name of a ZOSSystemImage.
Returns:
The current property group, or null if there is no current property group for the system.
Throws:
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the system parameter.

setOverride

public void setOverride(String system,
                        IProperty property,
                        String newValue)
                 throws IllegalPropertyException,
                        IllegalSystemException
Set an override for the given property for the given system.

Parameters:
system - The name of a ZOSSystemImage.
property - The property to override
newValue - The overridden value
Throws:
IllegalPropertyException - If the property does not exist in the current property group for the given system.
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the system parameter.

deleteOverride

public void deleteOverride(String system,
                           IProperty property)
                    throws NoOverrideException,
                           IllegalSystemException
Delete the override for the given property for the given system.

Parameters:
system - The name of a ZOSSystemImage
property - The property that was overridden.
Throws:
NoOverrideException - If the given property was not overridden for the given system.
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the system parameter.

getOverriddenProperties

public List<IProperty> getOverriddenProperties(String system)
                                        throws IllegalSystemException
Returns the overridden properties for the given system.

Parameters:
system - The name of a ZOSSystemImage
Returns:
The overridden properties, or an empty list if there are no overridden properties.
Throws:
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the system parameter.

deleteOverriddenPropertiesInCategory

public void deleteOverriddenPropertiesInCategory(String system,
                                                 ICategory category)
                                          throws NoOverrideException,
                                                 IllegalSystemException
Delete all of the overridden properties for the given system that are defined by the given category.

Parameters:
system - The name of a ZOSSystemImage.
category - The category that defines the properties
Throws:
NoOverrideException - If there are no overrides for the given system, or there are overrides but the overrides are not for properties defined by the given category.
IllegalSystemException - If there is no ZOSSystemImage with a name that matches the given system.