wt.project
Interface ProjectService

All Known Implementing Classes:

ProjectServiceFwd, StandardProjectService

Deprecated. in R6.0 Project will be replaced by a new Team object in a future release.

public interface ProjectService

ProjectService provides client invokable methods to project services. These methods are executed on the server side.

Supported API: false

Extendable: false

Method Summary

Role[]	allRoles() Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.
Project	copyProject(Project aProject, String copyName, String folderLocation, boolean persist) Deprecated.
ProjectReference	createTeamInstance(Persistable object) Deprecated. in R6.0
Vector	getCandidateProjects() Deprecated.
Vector	getCandidateProjects(AdminDomainRef domainRef) Deprecated.
Vector	getCandidateProjects(String domain) Deprecated.
Vector	getEnabledProjectNames() Deprecated.
Vector	getMembers(Project aProject) Deprecated.
Project	getProject(AdministrativeDomain adminDomain, String projectName) Deprecated.
Project	getProject(ProjectManaged object) Deprecated.
Project	getProject(String projectIdentity) Deprecated.
Vector	getProjectNames() Deprecated.
Vector	getProjects() Deprecated.
Vector	getTeamInstances() Deprecated. in R6.0
ProjectManaged	reproject(ProjectManaged object, ProjectReference projRef) Deprecated.
void	setIgnoreDelete(Object obj) Deprecated.
ProjectManaged	setProject(ProjectManaged object, String projectName, String domain) Deprecated. at 6.0 (Use the ProjectHelper.setProject(myObject, ProjectHelper.service.getProject(AdministrativeDomainHelper.manager.getDomain(adminDomainName), projectName)) instead
Vector	whereUsed(ProjectReference project) Deprecated.

Method Detail

getCandidateProjects

public Vector getCandidateProjects(String domain)
                            throws WTException,
                                   ProjectException

Deprecated.

Answer a vector of project references from the specified domain that the project managed object can be assigned to

Supported API: false

Parameters:

domain - the name of the domain used as search criteria in the retrieval of candidate projects

Returns:

Vector

Throws:

WTException

ProjectException

getCandidateProjects

public Vector getCandidateProjects()
                            throws WTException,
                                   ProjectException

Deprecated.

Answer a vector of project references that the project managed object can be assigned to

Supported API: false

Returns:

Vector

Throws:

WTException

ProjectException

getCandidateProjects

public Vector getCandidateProjects(AdminDomainRef domainRef)
                            throws WTException,
                                   ProjectException

Deprecated.

Answer a vector of project references that the project managed object can be assigned to

Supported API: false

Parameters:

domainRef - the AdminDomainRef object used as search criteria in the retrieval of candidate projects

Returns:

Vector

Throws:

WTException

ProjectException

allRoles

public Role[] allRoles()
                throws WTException

Deprecated. in R4.0. Use the appropriate call on the EnumeratedType object to get these values.

Answer an array of Role objects

Supported API: false

Returns:

Role[]

Throws:

WTException

getProject

public Project getProject(ProjectManaged object)
                   throws WTException,
                          ProjectException

Deprecated.

Given a ProjectManaged object, answer the assigned project

Supported API: false

Parameters:

object - the ProjectManaged object

Returns:

Project

Throws:

WTException

ProjectException

getProject

public Project getProject(AdministrativeDomain adminDomain,
                          String projectName)
                   throws WTException,
                          ProjectException

Deprecated.

Given the AdministrativeDomain and name of a project, find the Project object.

Supported API: false

Parameters:

adminDomain - the AdministrativeDomain of the project

projectName - the name of the project

Returns:

Project

Throws:

WTException

ProjectException

getProject

public Project getProject(String projectIdentity)
                   throws WTException,
                          ProjectException

Deprecated.

Given the name or the identity of a project, find the Project object. If the identity of the object is passed in and the project exists, it should always be returned. If the name of the project is passed in and there is only one in the system by that name, it will be returned. If the name of the project is passed in, but there are multiples in the system (in different cabinets) by that name, an exception will be thrown.

Supported API: false

Parameters:

projectIdentity - a String that contains the identity of the project

Returns:

Project

Throws:

WTException

ProjectException

setProject

public ProjectManaged setProject(ProjectManaged object,
                                 String projectName,
                                 String domain)
                          throws WTException,
                                 ProjectException,
                                 WTPropertyVetoException

Deprecated. at 6.0 (Use the ProjectHelper.setProject(myObject, ProjectHelper.service.getProject(AdministrativeDomainHelper.manager.getDomain(adminDomainName), projectName)) instead

Set the project of the ProjectManaged object

Supported API: false

Parameters:

object - the ProjectManaged object whose project should be set

projectName - a String that contains the name of the project to set on the ProjectManaged object.

domain - a String that contain the AdministrativeDomain of the project that should be set

Returns:

ProjectManaged

Throws:

WTException

ProjectException

WTPropertyVetoException

reproject

public ProjectManaged reproject(ProjectManaged object,
                                ProjectReference projRef)
                         throws WTException,
                                ProjectException

Deprecated.

Associate a project managed object with a new project.

Supported API: false

Parameters:

object - the ProjectManaged object that should be associated with a new project.

projRef - a reference to a Project, a ProjectReference of the projec tthat the object should be reassigned to

Returns:

ProjectManaged

Throws:

WTException

ProjectException

setIgnoreDelete

public void setIgnoreDelete(Object obj)
                     throws WTException

Deprecated.

Supported API: false

Parameters:

obj -

Throws:

WTException

getMembers

public Vector getMembers(Project aProject)
                  throws WTException

Deprecated.

Answer a vector of WTPrincipalReference of all members of a project

Supported API: false

Parameters:

aProject -

Returns:

Vector

Throws:

WTException

copyProject

public Project copyProject(Project aProject,
                           String copyName,
                           String folderLocation,
                           boolean persist)
                    throws WTException

Deprecated.

Produces a copy of the Project object with the name passed as argument. If the name argument is "null", the name of the copied Project is prefixed with 'copy of'. If the folder location is not specified, the object will be created in the orginal Project's folder location. If the persist parameter is set to True, the object will be persisted before it is returned. Note: The 'Copy Of' prefix is pulled from a Resource Bundle for localization purposes.

Supported API: false

Parameters:

aProject -

copyName -

folderLocation -

persist -

Returns:

Project

Throws:

WTException

getProjects

public Vector getProjects()
                   throws WTException,
                          ProjectException

Deprecated.

Answer a vector of project references for all projects, including the disabled ones

Supported API: false

Returns:

Vector

Throws:

WTException

ProjectException

whereUsed

public Vector whereUsed(ProjectReference project)
                 throws WTException,
                        ProjectException

Deprecated.

Answer a Vector of ProjectManaged objects Note: Any services that persist a ProjectReferenceare individually responsible for making sure the Project doesn't disappear on them. For example, see the Workflow Engine and Workflow Definer service. These services listen for the pre_delete of a Project object and perform their own 'whereUsed' lookup. If the Project object that is about to be deleted is used by that service, that service vetoes the exception.

Supported API: false

Parameters:

project - A ProjectReference representing the Project object of interest

Returns:

Vector

Throws:

WTException

ProjectException

createTeamInstance

public ProjectReference createTeamInstance(Persistable object)
                                    throws WTException

Deprecated. in R6.0

Creates a team instance based on the selected project. Links the object to the team.

Supported API: false

Parameters:

object - The object that needs a Team Instance

Returns:

ProjectReference

Throws:

WTException

getTeamInstances

public Vector getTeamInstances()
                        throws WTException,
                               ProjectException

Deprecated. in R6.0

Answer a vector of project references for all team instances, including the disabled ones

Supported API: false

Returns:

Vector

Throws:

WTException

ProjectException

getProjectNames

public Vector getProjectNames()
                       throws WTException

Deprecated.

Retrieve an unsorted Vector of Project names as strings. The list includes all Projects including those which are no longer enabled.

Supported API: false

Returns:

Vector

Throws:

WTException

getEnabledProjectNames

public Vector getEnabledProjectNames()
                              throws WTException

Deprecated.

Return an unsorted Vector of Project names as Strings. The list of names comprises only enabled Projects

Supported API: false

Returns:

Vector

Throws:

WTException