Interface com.ibm.ivj.util.base.Project
- public interface Project
- extends WorkspaceModel
This interface defines the behavior of a project loaded into
the workspace
Method Index
- createDefaultPackage(boolean)
- Creates a new default package in this project if one does not
already exist in the workspace.
- createPackage(String, boolean)
- Creates a new package with the specified name if it does not
already exist in the workspace.
- getAllEditions()
- Returns all editions of this project in the repository
- getComment()
- Returns the comment associated with the project in VisualAge for Java
- getDefaultPackage()
- Return the default package for the project if it exists
- getEdition()
- Returns the repository project edition corresponding to this
workspace project
- getPackages()
- Returns all packages defined in this project
- getTypes()
- Returns all types defined in this project
- isScratchEdition()
- Returns true if this model is a scratch edition
- openBrowser()
- Opens the project browser against this project
- setComment(String)
- Sets the comment associated with the project in VisualAge for Java
Methods
createDefaultPackage
public abstract Package createDefaultPackage(boolean ignoreRepository) throws IvjException
- Creates a new default package in this project if one does not
already exist in the workspace.
- Parameters:
- ignoreRepository - boolean If true, create new default package even
if another default package edition with for the project
exists in the repository
- Returns:
- com.ibm.ivj.util.base.Package or null
createPackage
public abstract Package createPackage(String name,
boolean ignoreRepository) throws IvjException
- Creates a new package with the specified name if it does not
already exist in the workspace.
- Parameters:
- name - java.lang.String
- ignoreRepository - boolean If true, create new package even
if another package edition with the same name exists in the repository
- Returns:
- com.ibm.ivj.util.base.Package
getAllEditions
public abstract ProjectEdition[] getAllEditions() throws IvjException
- Returns all editions of this project in the repository
- Returns:
- com.ibm.ivj.util.base.ProjectEdition[]
getComment
public abstract String getComment() throws IvjException
- Returns the comment associated with the project in VisualAge for Java
- Returns:
- java.lang.String
getDefaultPackage
public abstract Package getDefaultPackage() throws IvjException
- Return the default package for the project if it exists
- Returns:
- com.ibm.ivj.util.base.Package or null if does not exist
getEdition
public abstract ProjectEdition getEdition() throws IvjException
- Returns the repository project edition corresponding to this
workspace project
- Returns:
- com.ibm.ivj.util.base.ProjectEdition
getPackages
public abstract Package[] getPackages() throws IvjException
- Returns all packages defined in this project
- Returns:
- com.ibm.ivj.util.base.Package[]
getTypes
public abstract Type[] getTypes() throws IvjException
- Returns all types defined in this project
- Returns:
- com.ibm.ivj.util.base.Type[]
isScratchEdition
public abstract boolean isScratchEdition() throws IvjException
- Returns true if this model is a scratch edition
- Returns:
- boolean
openBrowser
public abstract void openBrowser() throws IvjException
- Opens the project browser against this project
setComment
public abstract void setComment(String comment) throws IvjException
- Sets the comment associated with the project in VisualAge for Java
- Parameters:
- comment - java.lang.String
