Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.perspective.model
Interface IISeriesProjectPropertiesFactory


public interface IISeriesProjectPropertiesFactory

iSeries Properties Model Factory.
Hides properties model complexity. The generate and load model methods should know what to create when a resource is passed. The resource can be either an IProject or an IFolder, or an IFile.
Clients are not expected to implement this interface.


Field Summary
static String Copyright
           
 
Method Summary
 IISeriesPropertiesModel createPropertiesModel(IFile file)
          Instantiates and returns an IISeriesPropertiesModel depending on whether the file represents either a save file or a source member.
 IISeriesPropertiesModel createPropertiesModel(IFolder folder)
          Instantiates and returns an ISeriesPropertiesModel for the IFolder.
 IISeriesPropertiesModel generatePropertyModel(IFile ifile, IProgressMonitor monitor, Hashtable properties)
          Saves both Shared and Local properties for the AbstractiSeriesNativeMember associated with this IFile.
 IISeriesPropertiesModel generatePropertyModel(IFolder ifolder, IProgressMonitor monitor, Hashtable properties)
          Saves both Shared and Local properties for the AbstractiSeriesNativeObject associated with this folder.
It generates a .properties file for shared properties.
And it saves local properties as persistent properties in the IResource.
 IISeriesPropertiesModel generatePropertyModel(IProject iproject, IProgressMonitor monitor, Hashtable properties)
          Saves both Shared and Local properties for the AbstractiSeriesProject associated with this project.
It generates a .*_properties file for shared properties.
And it saves local properties as persistent properties in the IResource.
 IFile getPropertiesFilePath(IResource resource, int resourceType)
          Gets the corresponding handle for the properties file associated with file according to its type.
 boolean hasSrcpfProperties(IFolder folder)
          Is there a persisted properties model for the given IResource
 IISeriesPropertiesModel loadPropertyModel(IFile ifile, IProgressMonitor monitor)
          Creates an instance of IISeriesMemberPropertiesModel which has already loaded both Shared and Local properties for the AbstractiSeriesNativeMember associated with this IFile.
 IISeriesPropertiesModel loadPropertyModel(IFolder ifolder, IProgressMonitor monitor)
          Creates an instance of IISeriesPropertiesModel which has already loaded both Shared and Local properties for the the AbstractiSeriesNativeObject associated with this folder.
 IISeriesPropertiesModel loadPropertyModel(IProject iproject, IProgressMonitor monitor)
          Creates an instance of IISeriesPropertiesModel which has already loaded both Shared and Local properties for the AbstractiSeriesProject associated with this project.
 

Field Detail

Copyright

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

createPropertiesModel

IISeriesPropertiesModel createPropertiesModel(IFile file)
Instantiates and returns an IISeriesPropertiesModel depending on whether the file represents either a save file or a source member. Does not populate the properties model with properties and does not save the properties model.

Parameters:
file - the IFile that this property model is based on.
Returns:
the property model for file.

createPropertiesModel

IISeriesPropertiesModel createPropertiesModel(IFolder folder)
Instantiates and returns an ISeriesPropertiesModel for the IFolder. Does not populate the properties model with properties and does not save the properties model.

Parameters:
folder - the IFolder that this property model is based on.
Returns:
the property model for folder.

generatePropertyModel

IISeriesPropertiesModel generatePropertyModel(IProject iproject,
                                              IProgressMonitor monitor,
                                              Hashtable properties)
Saves both Shared and Local properties for the AbstractiSeriesProject associated with this project.
It generates a .*_properties file for shared properties.
And it saves local properties as persistent properties in the IResource.


loadPropertyModel

IISeriesPropertiesModel loadPropertyModel(IProject iproject,
                                          IProgressMonitor monitor)
Creates an instance of IISeriesPropertiesModel which has already loaded both Shared and Local properties for the AbstractiSeriesProject associated with this project.


generatePropertyModel

IISeriesPropertiesModel generatePropertyModel(IFolder ifolder,
                                              IProgressMonitor monitor,
                                              Hashtable properties)
Saves both Shared and Local properties for the AbstractiSeriesNativeObject associated with this folder.
It generates a .properties file for shared properties.
And it saves local properties as persistent properties in the IResource.


loadPropertyModel

IISeriesPropertiesModel loadPropertyModel(IFolder ifolder,
                                          IProgressMonitor monitor)
Creates an instance of IISeriesPropertiesModel which has already loaded both Shared and Local properties for the the AbstractiSeriesNativeObject associated with this folder.


generatePropertyModel

IISeriesPropertiesModel generatePropertyModel(IFile ifile,
                                              IProgressMonitor monitor,
                                              Hashtable properties)
Saves both Shared and Local properties for the AbstractiSeriesNativeMember associated with this IFile.
It generates a .*_properties file for shared properties.
And it saves local properties as persistent properties in the IResource.


loadPropertyModel

IISeriesPropertiesModel loadPropertyModel(IFile ifile,
                                          IProgressMonitor monitor)
Creates an instance of IISeriesMemberPropertiesModel which has already loaded both Shared and Local properties for the AbstractiSeriesNativeMember associated with this IFile.


hasSrcpfProperties

boolean hasSrcpfProperties(IFolder folder)
Is there a persisted properties model for the given IResource

Parameters:
folder - - the IResource for which we want to see if there is and associated i Project properties model
Returns:
true iff an associated properties model exists

getPropertiesFilePath

IFile getPropertiesFilePath(IResource resource,
                            int resourceType)
Gets the corresponding handle for the properties file associated with file according to its type. This is a handle operation, thus the IFile returned may or may not exist.

Parameters:
resource - The IResource that the return properties file is describing.
resourceType - int constant indicating which subclass of AbstractISeriesResource type. Will be one of: AbstractISeriesResource.NATIVE_MEMBER AbstractISeriesResource.NATIVE_OBJECT AbstractISeriesResource.PROJECT
Returns:
A file handle for the properties file of file.

Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.