Interface com.ibm.ivj.util.base.Model
- public interface Model
This interface defines the base type used as the root
in the inheritance tree for all VisualAge for Java "models". A model
is a project, package or type in the workspace, or in the
repository. The various models are expressed in terms of
interfaces as follows:
Model ... base model identity behavior
|
+--- RepositoryModel ... common edition behavior in repository
| |
| +--- ProjectEdition ... project edition in repository
| +--- PackageEdition ... package edition in repository
| +--- TypeEdition ... type edition in repository
|
+--- WorkspaceModel ... common workspace behavior
|
+--- Project ... project loaded in workspace
+--- Package ... package loaded in workspace
+--- Type ... type loaded in workspace
Method Index
- getName()
- Returns the model (project, package, type) name.
- getOwnerName()
- Return the name of the person designated as the owner of the model
- getVersionName()
- Returns the version name string for this model.
- getVersionStamp()
- Returns the version time stamp for this model.
- isEdition()
- Returns true if this model is an open edition (note, that a scratch
edition is NOT considered an open edition, see isScratchEdition() )
- isPackage()
- Returns true if the model is a package
- isProject()
- Returns true if this model is a project
- isType()
- Returns true if this model is a type.
- isVersion()
- Returns true if this model is a version
Methods
getName
public abstract String getName()
- Returns the model (project, package, type) name. For types
this is the fully qualified name of the type.
- Returns:
- String
getOwnerName
public abstract String getOwnerName() throws IvjException
- Return the name of the person designated as the owner of the model
- Returns:
- java.lang.String
getVersionName
public abstract String getVersionName() throws IvjException
- Returns the version name string for this model.
The returned value will depend on the current version
state of the model object:
- if version, the return value is the version string
- if open edition, the return value is null (no version name)
- if scratch edition, the return value is the version string
the scratch edition is based on
- Returns:
- String
getVersionStamp
public abstract Date getVersionStamp() throws IvjException
- Returns the version time stamp for this model.
The returned value will depend on the current version
state of the model object:
- if version, the return value is stamp when versioned
- if open edition, the return value is stamp when created
- if scratch edition, the return value is the version stamp
of the version the scratch edition is based on
- Returns:
- java.util.Date
isEdition
public abstract boolean isEdition() throws IvjException
- Returns true if this model is an open edition (note, that a scratch
edition is NOT considered an open edition, see isScratchEdition() )
- Returns:
- boolean
isPackage
public abstract boolean isPackage()
- Returns true if the model is a package
- Returns:
- boolean
isProject
public abstract boolean isProject()
- Returns true if this model is a project
- Returns:
- boolean
isType
public abstract boolean isType()
- Returns true if this model is a type.
- Returns:
- boolean
isVersion
public abstract boolean isVersion() throws IvjException
- Returns true if this model is a version
- Returns:
- boolean
