|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.owb.project.ProjectManager
ProjectManager
contains operations to handle Projects administration. This class allows only one instance (singleton), which can be obtained by calling getInstance()
method.
Field Summary | |
static java.lang.String |
DEFAULT_PROJECT The name of the default OWB project. |
protected static ProjectManager |
s_instance The sole instance of ProjectManager class. |
Constructor Summary | |
protected |
ProjectManager() Protected default constructor (for invocation by subclass constructors, typically implicit). |
Method Summary | |
void |
createProject(java.lang.String name) Creates a new project. |
void |
deleteProject(java.lang.String projectName) Deletes the specified project. |
static ProjectManager |
getInstance() Returns the sole instance of this class. |
java.lang.String[] |
getProjectNames() Get a list of names of the existing projects. |
Project |
getWorkingProject() Returns the current working project. |
java.lang.String |
lockProject(java.lang.String name) Locks the specified project, which may not necessarily be the current working project. |
java.lang.String |
lockProjectShared(java.lang.String name) This method attempts to aquire a shared lock on the the specified project. |
java.lang.String |
lockProjectWithContents(java.lang.String name) Locks the specified project, together with all its contained components. |
java.lang.String[] |
reloadProjectNames() Retrieve the list of names of the existing projects directly from the repository. |
Project |
setWorkingProject(java.lang.String projectName) Establishes a project as the current project to work into. |
void |
unlockProject(java.lang.String name) Unlocks the specified project, which may not necessarily be the current working project. |
void |
unlockProjectUOID(java.lang.String uoid) Unlocks the project with the UOID passed as an argument. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String DEFAULT_PROJECT
protected static ProjectManager s_instance
ProjectManager
class.Constructor Detail |
protected ProjectManager()
Method Detail |
public static ProjectManager getInstance()
public java.lang.String[] getProjectNames()
public java.lang.String[] reloadProjectNames()
public void createProject(java.lang.String name) throws NameSpaceException, InvalidFormatException
name
- the project nameNameSpaceException
- if another Project
with the same name already existsInvalidFormatException
- if the desired name does not satisfy the format requirementspublic void deleteProject(java.lang.String projectName) throws NoSuchProjectException
projectName
- the project nameNoSuchProjectException
- if the argument is not a valid project nameComponentDeletedException
- if the project has been deleted by another userpublic Project setWorkingProject(java.lang.String projectName) throws NoSuchProjectException
projectName
- the name of the project to be set as working projectNoSuchProjectException
- if the argument is not a valid project nameComponentDeletedException
- if the project has been deleted by another usergetWorkingProject()
public Project getWorkingProject()
null
if no working project has been setComponentDeletedException
- if the working project has been deletedsetWorkingProject(java.lang.String)
public java.lang.String lockProject(java.lang.String name) throws NoSuchProjectException, LockException
name
- the name of the project to be lockedunlockProjectUOID
, in cases when the name of the project has been changedNoSuchProjectException
- if the project could not be foundLockException
- if the lock on the project could not be obtained (for example, some other user already has the lock on the project)Component.lock()
public void unlockProject(java.lang.String name) throws NoSuchProjectException, LockException
name
- the name of the project to be unlockedNoSuchProjectException
- if the project could not be foundLockException
- if the component is not lockedComponent.unlock()
public void unlockProjectUOID(java.lang.String uoid) throws LockException
lockProject
, lockProjectWithContents
, or lockProjectShared
.uoid
- the UOID of the project to be unlocked (previously obtained from a call to lockProject
, lockProjectWithContents
, or lockProjectShared
.LockException
- if the component is not lockedComponent.unlock()
public java.lang.String lockProjectWithContents(java.lang.String name) throws NoSuchProjectException, LockException
name
- the name of the project to be lockedunlockProjectUOID
, in cases when the name of the project has been changedNoSuchProjectException
- if the project could not be foundLockException
- if the lock on the project could not be obtained (for example, some other user already has the lock on the project or on any of the contained components)Folder.lockWithContents()
public java.lang.String lockProjectShared(java.lang.String name) throws NoSuchProjectException, LockException
name
- the name of the project to be lockedunlockProjectUOID
NoSuchProjectException
- if the project could not be foundLockException
- if the lock on the project could not be obtainedFolder.lockShared()
|
Oracle Warehouse Builder Java API Reference 10g Release 1 (10.1) B12155-01 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |