com.ibm.ftt.projects.core.logical
Interface LogicalProjectRegistry


public interface LogicalProjectRegistry

A registry for managing the set of known logical projects.


Field Summary
static String COPY_RIGHT
           
 
Method Summary
 void add(ILogicalProject project)
          Add a project to the registry.
 boolean contains(ILogicalProject project)
          Returns true if the specified project is in the registry.
 ILogicalProject find(String projectName)
          Searches for a project with the specified name in the registry.
 IProjectFactory getProjectFactory(String projectType)
          Returns a project factory which matches the specified project type
 Object[] getProjects()
          Returns an array of the projects in the registry.
 ISubProjectFactory getSubProjectFactory(String subProjectType)
          Return a subproject factory which matches the subproject type
 void remove(ILogicalProject project)
          Removes a project from the registry.
 

Field Detail

COPY_RIGHT

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

add

void add(ILogicalProject project)
         throws OperationFailedException
Add a project to the registry. Enforces the rule that project names have to be unique,

Parameters:
project - the ILogicalProject to be added
Throws:
{@link - OperationFailedException} if the add was not successful
OperationFailedException

contains

boolean contains(ILogicalProject project)
Returns true if the specified project is in the registry.

Parameters:
project - an ILogicalProject whose existence in the registry is to be checked
Returns:
true if the project is already in the registry, false otherwise

find

ILogicalProject find(String projectName)
Searches for a project with the specified name in the registry.

Parameters:
projectName - a String containing the name of the project
Returns:
the ILogicalProject if the project is found, null otherwise

getProjectFactory

IProjectFactory getProjectFactory(String projectType)
Returns a project factory which matches the specified project type

Parameters:
projectType - a String indicating the type of factory to be returned, the set of valid project types is defined in the class XXXXX
Returns:
an IProjectFactory which can be used to create a project

getProjects

Object[] getProjects()
Returns an array of the projects in the registry.

Returns:
an array of ILogicalProjects in the registry

getSubProjectFactory

ISubProjectFactory getSubProjectFactory(String subProjectType)
Return a subproject factory which matches the subproject type

Parameters:
subProjectType - - a String indicating the type of factory to be returned. The set of valid subproject types is defined in the class XXXXX
Returns:
an ISubProjectFactory which can be used to create a subproject

remove

void remove(ILogicalProject project)
            throws OperationFailedException
Removes a project from the registry.

Parameters:
project - an ILogicalProject representing the project to be removed
Throws:
{@link - OperationFailedException} if the remove was not successful
OperationFailedException