com.nomagic.magicdraw.teamwork.application

Class TeamworkUtils

java.lang.Object

com.nomagic.magicdraw.teamwork.application.TeamworkUtils

@OpenApi
public class TeamworkUtils
extends java.lang.Object

Teamwork related helper.

Method Summary

Modifier and Type	Method and Description
static boolean	addProjectToTeamwork(Project project, java.lang.String name, java.lang.String path, java.lang.String category, java.lang.String comment, java.util.List<java.lang.String> tags, java.util.Collection<ResolveLocalModuleInfo> resolveInfos) Add local project to teamwork.
static boolean	authenticate(java.lang.String server, int port, boolean secure, java.lang.String user, java.lang.String password) Authenticate to the Teamwork Server.
static java.util.Map<java.lang.String,java.lang.String>	branchProject(ProjectDescriptor projectDescriptor, java.util.Set<java.lang.String> modules, java.lang.String branchName, java.lang.String comment) Create branch for project.
static void	changeModuleBranch(ModuleUsage usage, java.lang.String moduleBranchQualifiedName, int versionNumber, ProgressStatus progressStatus) Change used module branch.
static boolean	commitProject(Project project, java.lang.String comment) Commit project.
static boolean	commitProject(Project project, java.lang.String comment, java.util.List<java.lang.String> tags, java.util.Collection<Element> unlockElements, java.util.Collection<ModuleUsage> unlockModules) Commit project.
static void	convertToLocal(Project project, java.io.File projectFile) Convert(save) teamwork project to local project.
static java.lang.String	createCategory(java.lang.String categoryName) Creates project category with the given name.
static ProjectDescriptor	createTeamworkProject(java.lang.String name, java.lang.String path, java.lang.String category) Create teamwork project.
static void	deleteCategory(java.lang.String categoryID) Deletes the given category, however projects assigned to the given category are retained.
static void	exportTeamworkModule(Project project, java.util.Collection packages, java.lang.String moduleQualifiedName) Deprecated. Use exportTeamworkModule(com.nomagic.magicdraw.core.Project, java.util.Collection, String, String)
static void	exportTeamworkModule(Project project, java.util.Collection packages, java.lang.String description, java.lang.String moduleQualifiedName) Exports teamwork module.
static java.lang.String	generateProjectQualifiedName(java.lang.String projectName, java.lang.String[] branches) Creates unique qualified name from project name and it's branch path.
static BranchData	getBranchedFrom(ProjectDescriptor projectDescriptor) Get info the project is branched from.
static java.util.Set<BranchData>	getBranches(ProjectDescriptor projectDescriptor) Get all project branches.
static java.util.Map<java.lang.String,java.lang.String>	getCategories() Gets remote project categories from the Teamwork server.
static java.lang.String	getCategoryIDByName(java.lang.String categoryName) Finds ID of the category by the given name.
static java.util.Collection<RemoteProjectDescriptor>	getCategoryProjects(java.lang.String categoryID) Gets all projects that belong to given category.
static int	getLastVersion(ProjectDescriptor descriptor) Get last project version number.
static java.util.Collection<Element>	getLockedElement(Project project, java.lang.String user) Returns a collection of locked elements.
static java.util.Collection<ModuleUsage>	getLockedModules(Project project, java.lang.String user) Returns a collection of locked modules.
static java.lang.String	getLoggedUserName() Returns the currently logged teamwork user name.
static java.util.Set<java.lang.String>	getLoggedUserNames() Get logged in users if current user has rights to access user list.
static java.lang.String	getProjectCategory(RemoteProjectDescriptor project) Gets the project category that the project belongs to.
static ProjectDescriptor	getRemoteProjectDescriptor(java.lang.String projectID) Returns remote project descriptor for given project id.
static ProjectDescriptor	getRemoteProjectDescriptorByQualifiedName(java.lang.String qualifiedName) Returns remote (teamwork) project descriptor.
static java.util.List	getRemoteProjectDescriptors() Returns descriptors of projects stored on server.
static java.lang.String	getRemoteProjectIDByQualifiedName(java.lang.String qualifiedName) Returns remote project id for given project name.
static java.util.List<java.lang.String>	getTags(ProjectDescriptor descriptor, int versionNumber) Get tags of given project version.
static java.util.Map<java.lang.String,java.lang.Integer>	getUsedModules(ProjectDescriptor descriptor, boolean directlyUsedOnly) Get modules being used by given project.
static java.util.Set<java.lang.String>	getUserNames() Get all users if current user has rights to access user list.
static java.util.List<VersionData>	getVersions(ProjectDescriptor descriptor) Get list of teamwork project (or branch) versions.
static boolean	lockElement(Project project, BaseElement element, boolean recursively) Deprecated. use lockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean)
static boolean	lockElement(Project project, Element element, boolean recursively) Locks given element.
static boolean	login(java.lang.String server, int port, java.lang.String user, java.lang.String password) Deprecated. use loginWithSession(String, int, String, String)
static com.nomagic.teamwork.common.users.SessionInfo	loginWithSession(java.lang.String server, int port, boolean secure, java.lang.String user, java.lang.String password) Login to the teamwork server.
static com.nomagic.teamwork.common.users.SessionInfo	loginWithSession(java.lang.String server, int port, java.lang.String user, java.lang.String password) Deprecated. use loginWithSession(String, int, boolean, String, String)
static boolean	logout() Logout current/active user from teamwork server.
static void	openModuleAsProject(ProjectDescriptor descriptor) Opens module as project.
static void	removeTeamworkProject(ProjectDescriptor projectDescriptor) Remove teamwork project.
static void	setCategoryName(java.lang.String categoryID, java.lang.String categoryName) Sets the new name for the given category.
static void	setProjectCategory(RemoteProjectDescriptor project, java.lang.String categoryID) Assigns the project to the given category.
static void	setTags(ProjectDescriptor descriptor, java.util.List<java.lang.String> tags, int versionNumber) Set tags for given project version.
static ProjectDescriptor	setTeamworkProjectBranchName(ProjectDescriptor projectDescriptor, java.lang.String name) Set teamwork project branch name.
static ProjectDescriptor	setTeamworkProjectName(ProjectDescriptor projectDescriptor, java.lang.String name) Set teamwork project name.
static void	unlockElement(Project project, BaseElement element, boolean recursively, boolean discard) Deprecated. use unlockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean, boolean)
static void	unlockElement(Project project, BaseElement element, boolean recursively, boolean discard, boolean silent) Deprecated. use unlockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean, boolean, boolean)
static void	unlockElement(Project project, Element element, boolean recursively, boolean discard) Unlock given element.
static void	unlockElement(Project project, Element element, boolean recursively, boolean discard, boolean silent) Unlock given element.
static void	updateProject(Project project) Updates given teamwork project project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

exportTeamworkModule

@OpenApi
 @Deprecated
public static void exportTeamworkModule(Project project,
                                                              java.util.Collection packages,
                                                              java.lang.String moduleQualifiedName)
                                                       throws java.lang.Exception

Deprecated. Use exportTeamworkModule(com.nomagic.magicdraw.core.Project, java.util.Collection, String, String)

Exports teamwork module.

Parameters:

project - project.

packages - packages to export.

moduleQualifiedName - qualified teamwork module (project) name.

Throws:

java.lang.Exception - in case of some problem

exportTeamworkModule

@OpenApi
public static void exportTeamworkModule(Project project,
                                                 java.util.Collection packages,
                                                 java.lang.String description,
                                                 java.lang.String moduleQualifiedName)
                                          throws java.lang.Exception

Exports teamwork module.

Parameters:

project - project.

packages - packages to export.

description - module description.

moduleQualifiedName - qualified teamwork module (project) name.

Throws:

java.lang.Exception - in case of some problem

getRemoteProjectDescriptors

@OpenApi
public static java.util.List getRemoteProjectDescriptors()
                                                           throws java.rmi.RemoteException

Returns descriptors of projects stored on server.

Returns:

list of remote project descriptors.

Throws:

java.rmi.RemoteException - in case of some problem

getRemoteProjectDescriptor

@OpenApi
 @CheckForNull
public static ProjectDescriptor getRemoteProjectDescriptor(java.lang.String projectID)
                                                                            throws java.rmi.RemoteException

Returns remote project descriptor for given project id.

Parameters:

projectID - project id.

Returns:

remote project descriptor.

Throws:

java.rmi.RemoteException - in case of some problem

getRemoteProjectIDByQualifiedName

@OpenApi
 @CheckForNull
public static java.lang.String getRemoteProjectIDByQualifiedName(java.lang.String qualifiedName)
                                                                                  throws java.rmi.RemoteException

Returns remote project id for given project name.

Parameters:

qualifiedName - Teamwork Project qualified name, unique name constructed from project name and it's branches. Examples: "MyProject" with no branches = "MyProject" "MyProject" branch ["release"] = "MyProject##release" "MyProject" branch with subbranch ["release", "sp1"] = "MyProject##release##sp1"

Returns:

project id.

Throws:

java.rmi.RemoteException - in case of some problem

See Also:

generateProjectQualifiedName(String, String[])

generateProjectQualifiedName

@OpenApi
public static java.lang.String generateProjectQualifiedName(java.lang.String projectName,
                                                                     java.lang.String[] branches)

Creates unique qualified name from project name and it's branch path. Examples: "MyProject" with no branches = "MyProject" "MyProject" branch ["release"] = "MyProject##release" "MyProject" branch with subbranch ["release", "sp1"] = "MyProject##release##sp1"

Parameters:

projectName - Teamwork Project name

branches - branch name path. Array is constructed in this way: [project branch, project branch subbranch, project branch subbranch subbranch ..., active branch]

Returns:

qualified name

getRemoteProjectDescriptorByQualifiedName

@CheckForNull
 @OpenApi
public static ProjectDescriptor getRemoteProjectDescriptorByQualifiedName(java.lang.String qualifiedName)
                                                                                           throws java.rmi.RemoteException

Returns remote (teamwork) project descriptor.

Parameters:

qualifiedName - Teamwork Project qualified name, unique name constructed from project name and it's branches.

E.g:

"MyProject" with no branches = "MyProject"
"MyProject" branch ["release"] = "MyProject##release"
"MyProject" branch with subbranch ["release", "sp1"] = "MyProject##release##sp1"

Returns:

remote project descriptor

Throws:

java.rmi.RemoteException - in case of some problem

See Also:

generateProjectQualifiedName(String, String[])

openModuleAsProject

@OpenApi
public static void openModuleAsProject(ProjectDescriptor descriptor)

Opens module as project.

Parameters:

descriptor - module project descriptor.

See Also:

com.nomagic.magicdraw.core.project.ProjectsManager#loadProject(com.nomagic.magicdraw.core.project.ProjectDescriptor, boolean)}

getVersions

@OpenApi
 @CheckForNull
public static java.util.List<VersionData> getVersions(@Nonnull
                                                                              ProjectDescriptor descriptor)
                                                                       throws java.rmi.RemoteException

Get list of teamwork project (or branch) versions.

Parameters:

descriptor - project descriptor.

Returns:

list of version infos.

Throws:

java.rmi.RemoteException - in case of some problem

getTags

@OpenApi
 @CheckForNull
public static java.util.List<java.lang.String> getTags(@Nonnull
                                                                               ProjectDescriptor descriptor,
                                                                               int versionNumber)
                                                                        throws java.rmi.RemoteException

Get tags of given project version.

Parameters:

descriptor - project descriptor.

versionNumber - version number, or -1 to get last version tags.

Returns:

list of tags, or null - there is no such project or project version or MagicDraw is not connected to the server.

Throws:

java.rmi.RemoteException - in case of some problem

setTags

@OpenApi
public static void setTags(@Nonnull
                                    ProjectDescriptor descriptor,
                                    java.util.List<java.lang.String> tags,
                                    int versionNumber)
                             throws java.rmi.RemoteException

Set tags for given project version.

Parameters:

descriptor - project descriptor.

tags - list of tags to set.

versionNumber - version number, or -1 to set tags for last version.

Throws:

java.rmi.RemoteException - in case of some problem

getUsedModules

@OpenApi
 @CheckForNull
public static java.util.Map<java.lang.String,java.lang.Integer> getUsedModules(ProjectDescriptor descriptor,
                                                                                                       boolean directlyUsedOnly)
                                                                                                throws java.rmi.RemoteException

Get modules being used by given project.

Parameters:

descriptor - project descriptor.

directlyUsedOnly - true - get only modules used directly by project, false - get all modules used by project and modules.

Returns:

ids and versions of directly used modules, or null - there is no such project or version.

Throws:

java.rmi.RemoteException - in case of some problem

getLastVersion

@OpenApi
public static int getLastVersion(@Nonnull
                                          ProjectDescriptor descriptor)
                                   throws java.rmi.RemoteException

Get last project version number.

Parameters:

descriptor - project descriptor.

Returns:

last project version number, -1 - there is no such project or MagicDraw is not connected to the server.

Throws:

java.rmi.RemoteException - in case of some problem

lockElement

@OpenApi
 @Deprecated
public static boolean lockElement(Project project,
                                                        BaseElement element,
                                                        boolean recursively)

Deprecated. use lockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean)

Locks given element.

Parameters:

project - project that locks element.

element - element to lock.

recursively - lock owned elements recursively.

Returns:

true if locked, otherwise - false.

unlockElement

@OpenApi
 @Deprecated
public static void unlockElement(Project project,
                                                       BaseElement element,
                                                       boolean recursively,
                                                       boolean discard)

Deprecated. use unlockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean, boolean)

Unlock given element.

Parameters:

project - project that locked element.

element - element to unlock.

recursively - unlock owned elements recursively.

discard - discard changes, if false project will be committed.

lockElement

@OpenApi
public static boolean lockElement(Project project,
                                           Element element,
                                           boolean recursively)

Locks given element.

Parameters:

project - project that locks element.

element - element to lock.

recursively - lock owned elements recursively.

Returns:

true if locked, otherwise - false.

unlockElement

@OpenApi
public static void unlockElement(Project project,
                                          Element element,
                                          boolean recursively,
                                          boolean discard)

Unlock given element.

Parameters:

project - project that locked element.

element - element to unlock.

recursively - unlock owned elements recursively.

discard - discard changes, if false project will be committed.

unlockElement

@OpenApi
 @Deprecated
public static void unlockElement(Project project,
                                                       BaseElement element,
                                                       boolean recursively,
                                                       boolean discard,
                                                       boolean silent)

Deprecated. use unlockElement(com.nomagic.magicdraw.core.Project, com.nomagic.uml2.ext.magicdraw.classes.mdkernel.Element, boolean, boolean, boolean)

Unlock given element.

Parameters:

project - project that locked element.

element - element to unlock.

recursively - unlock owned elements recursively.

discard - discard changes, if false project will be committed.

silent - true if no UI should be shown while executing method.

unlockElement

@OpenApi
public static void unlockElement(Project project,
                                          Element element,
                                          boolean recursively,
                                          boolean discard,
                                          boolean silent)

Unlock given element.

Parameters:

project - project that locked element.

element - element to unlock.

recursively - unlock owned elements recursively.

discard - discard changes, if false project will be committed.

silent - true if no UI should be shown while executing method.

getLockedElement

@OpenApi
public static java.util.Collection<Element> getLockedElement(@Nonnull
                                                                      Project project,
                                                                      @CheckForNull
                                                                      java.lang.String user)

Returns a collection of locked elements. Makes given project active.

Parameters:

project - project.

user - locked by the user, or null to get the all locked elements.

Returns:

collection of locked elements.

getLockedModules

@OpenApi
public static java.util.Collection<ModuleUsage> getLockedModules(Project project,
                                                                          java.lang.String user)

Returns a collection of locked modules. Makes given project active.

Parameters:

project - project.

user - locked by the user, or null to get the all locked elements.

Returns:

collection of locked modules.

commitProject

@OpenApi
public static boolean commitProject(@Nonnull
                                             Project project,
                                             @CheckForNull
                                             java.lang.String comment)

Commit project.

Parameters:

project - project

comment - comment.

Returns:

true if committed.

Throws:

java.lang.IllegalStateException - if given project uses local modules.

commitProject

@OpenApi
public static boolean commitProject(@Nonnull
                                             Project project,
                                             @CheckForNull
                                             java.lang.String comment,
                                             @CheckForNull
                                             java.util.List<java.lang.String> tags,
                                             @CheckForNull
                                             java.util.Collection<Element> unlockElements,
                                             @CheckForNull
                                             java.util.Collection<ModuleUsage> unlockModules)

Commit project.

Parameters:

project - project

comment - comment.

tags - tags to set.

unlockElements - collection of elements to unlock.

unlockModules - collection of modules to unlock.

Returns:

true if committed.

Throws:

java.lang.IllegalStateException - if given project uses local modules.

updateProject

@OpenApi
public static void updateProject(Project project)

Updates given teamwork project project. Project is activated before update.

Parameters:

project - teamwork project to update.

createTeamworkProject

@OpenApi
 @CheckForNull
public static ProjectDescriptor createTeamworkProject(@Nonnull
                                                                              java.lang.String name,
                                                                              @CheckForNull
                                                                              java.lang.String path,
                                                                              @CheckForNull
                                                                              java.lang.String category)
                                                                       throws java.rmi.RemoteException

Create teamwork project. Project is created only if currently logged user rights allows to create projects.

Parameters:

name - project name.

path - project path, null for Native (default) repository Teamwork server.

category - project category.

Returns:

crated project descriptor.

Throws:

java.rmi.RemoteException - in case of some problem

setTeamworkProjectName

@OpenApi
 @CheckForNull
public static ProjectDescriptor setTeamworkProjectName(@Nonnull
                                                                               ProjectDescriptor projectDescriptor,
                                                                               @Nonnull
                                                                               java.lang.String name)
                                                                        throws java.rmi.RemoteException,
                                                                               java.lang.IllegalArgumentException

Set teamwork project name. Project is renamed only if currently logged user rights allows to edit project properties.

Parameters:

projectDescriptor - project to rename.

name - new name.

Returns:

renamed project descriptor.

Throws:

java.rmi.RemoteException - in case of some problem

java.lang.IllegalArgumentException - if project with given name already exists.

setTeamworkProjectBranchName

@OpenApi
 @CheckForNull
public static ProjectDescriptor setTeamworkProjectBranchName(@Nonnull
                                                                                     ProjectDescriptor projectDescriptor,
                                                                                     @Nonnull
                                                                                     java.lang.String name)
                                                                              throws java.rmi.RemoteException,
                                                                                     java.lang.IllegalArgumentException

Set teamwork project branch name. Project is renamed only if currently logged user rights allows to edit project properties.

Parameters:

projectDescriptor - branched project to rename branch.

name - new name.

Returns:

renamed project descriptor.

Throws:

java.rmi.RemoteException - in case of some problem

java.lang.IllegalArgumentException - if project branch with given name already exists, if given descriptor does not represent branched project.

removeTeamworkProject

@OpenApi
public static void removeTeamworkProject(ProjectDescriptor projectDescriptor)
                                           throws java.rmi.RemoteException

Remove teamwork project. Project is removed only if currently logged user rights allows to remove projects.

Parameters:

projectDescriptor - teamwork project descriptor.

Throws:

java.rmi.RemoteException - in case of some problem

branchProject

@OpenApi
 @CheckForNull
public static java.util.Map<java.lang.String,java.lang.String> branchProject(@Nonnull
                                                                                                     ProjectDescriptor projectDescriptor,
                                                                                                     @CheckForNull
                                                                                                     java.util.Set<java.lang.String> modules,
                                                                                                     @Nonnull
                                                                                                     java.lang.String branchName,
                                                                                                     @CheckForNull
                                                                                                     java.lang.String comment)
                                                                                              throws java.rmi.RemoteException

Create branch for project.

Parameters:

projectDescriptor - project descriptor to create branch for.

modules - ids of modules to branch with project (null - all used modules are branched too, empty set - no modules branched)

branchName - name of the branch.

comment - comment

Returns:

branching result (project id -> branched project id)

Throws:

java.rmi.RemoteException - in case of some problem

getBranches

@OpenApi
 @CheckForNull
public static java.util.Set<BranchData> getBranches(ProjectDescriptor projectDescriptor)
                                                                     throws java.rmi.RemoteException

Get all project branches.

Parameters:

projectDescriptor - project descriptor.

Returns:

branches data.

Throws:

java.rmi.RemoteException - in case of some problem

getBranchedFrom

@OpenApi
 @CheckForNull
public static BranchData getBranchedFrom(ProjectDescriptor projectDescriptor)
                                                          throws java.rmi.RemoteException

Get info the project is branched from.

Parameters:

projectDescriptor - project descriptor.

Returns:

branch data.

Throws:

java.rmi.RemoteException - in case of some problem

changeModuleBranch

@OpenApi
public static void changeModuleBranch(ModuleUsage usage,
                                               java.lang.String moduleBranchQualifiedName,
                                               int versionNumber,
                                               ProgressStatus progressStatus)
                                        throws java.lang.Exception

Change used module branch.

Parameters:

usage - module usage.

moduleBranchQualifiedName - module branch qualified name.

progressStatus - progress status.

Throws:

java.lang.Exception - exception.

addProjectToTeamwork

@OpenApi
public static boolean addProjectToTeamwork(@Nonnull
                                                    Project project,
                                                    @Nonnull
                                                    java.lang.String name,
                                                    @CheckForNull
                                                    java.lang.String path,
                                                    @CheckForNull
                                                    java.lang.String category,
                                                    @CheckForNull
                                                    java.lang.String comment,
                                                    @CheckForNull
                                                    java.util.List<java.lang.String> tags,
                                                    @Nonnull
                                                    java.util.Collection<ResolveLocalModuleInfo> resolveInfos)
                                             throws java.lang.Exception

Add local project to teamwork.

Parameters:

project - project.

name - teamwork project name.

path - repository path.

category - category

comment - comment.

tags - tags.

resolveInfos - local module resolve info.

Returns:

true if project added, otherwise false.

Throws:

java.lang.Exception - exception.

convertToLocal

@OpenApi
public static void convertToLocal(@Nonnull
                                           Project project,
                                           @Nonnull
                                           java.io.File projectFile)
                                    throws java.lang.Exception

Convert(save) teamwork project to local project.

Parameters:

project - teamwork project to convert to local project.

projectFile - file to save project.

Throws:

java.lang.IllegalArgumentException - if project is not teamwork project.

java.lang.Exception

getLoggedUserName

@OpenApi
 @CheckForNull
public static java.lang.String getLoggedUserName()

Returns the currently logged teamwork user name.

Returns:

user name

getUserNames

@OpenApi
public static java.util.Set<java.lang.String> getUserNames()

Get all users if current user has rights to access user list.

Returns:

log in names.

getLoggedUserNames

@OpenApi
public static java.util.Set<java.lang.String> getLoggedUserNames()

Get logged in users if current user has rights to access user list.

Returns:

log in names.

login

@OpenApi
 @Deprecated
public static boolean login(java.lang.String server,
                                                  int port,
                                                  java.lang.String user,
                                                  java.lang.String password)

Deprecated. use loginWithSession(String, int, String, String)

Login to the teamwork server.

Parameters:

server - server address.

port - server port (-1 to use default port).

user - user to login.

password - user password.

Returns:

true if logged in

loginWithSession

@CheckForNull
 @OpenApi
 @Deprecated
public static com.nomagic.teamwork.common.users.SessionInfo loginWithSession(java.lang.String server,
                                                                                                                  int port,
                                                                                                                  java.lang.String user,
                                                                                                                  java.lang.String password)

Deprecated. use loginWithSession(String, int, boolean, String, String)

Login to the teamwork server.

Parameters:

server - server address.

port - server port (-1 to use default port).

user - user to login.

password - user password.

Returns:

null or session

loginWithSession

@CheckForNull
 @OpenApi
public static com.nomagic.teamwork.common.users.SessionInfo loginWithSession(java.lang.String server,
                                                                                                     int port,
                                                                                                     boolean secure,
                                                                                                     java.lang.String user,
                                                                                                     java.lang.String password)

Login to the teamwork server.

Parameters:

server - server address.

port - server port (-1 to use default port).

secure - Use SSL connection type.

user - user to login.

password - user password.

Returns:

null or session

authenticate

@OpenApi
public static boolean authenticate(java.lang.String server,
                                            int port,
                                            boolean secure,
                                            java.lang.String user,
                                            java.lang.String password)

Authenticate to the Teamwork Server.

Parameters:

server - server address.

port - server port (-1 to use default port).

secure - Use SSL connection type.

user - user to login.

password - user password.

Returns:

true if logged in.

logout

@OpenApi
public static boolean logout()

Logout current/active user from teamwork server.

Returns:

true if logged out.

getCategories

@OpenApi
public static java.util.Map<java.lang.String,java.lang.String> getCategories()
                                                                               throws java.rmi.RemoteException

Gets remote project categories from the Teamwork server.

Returns:

map where key is the category ID and value is the corresponding category name.

Throws:

java.rmi.RemoteException - connection problems with Teamwork server.

getCategoryProjects

@OpenApi
public static java.util.Collection<RemoteProjectDescriptor> getCategoryProjects(java.lang.String categoryID)
                                                                                  throws java.rmi.RemoteException

Gets all projects that belong to given category. Each remote project can belong to only one category a time, thus none of the projects from this collection will be return for other categories.

Parameters:

categoryID - the category ID

Returns:

collection of descriptors of remote projects that belong to the given category.

Throws:

java.rmi.RemoteException - connection problems with Teamwork server or category with given ID does not exist.

getCategoryIDByName

@OpenApi
 @CheckForNull
public static java.lang.String getCategoryIDByName(java.lang.String categoryName)
                                                                    throws java.rmi.RemoteException

Finds ID of the category by the given name. The name of the category has to be unique, thus there should be only one category matching the given name.

Parameters:

categoryName - category name.

Returns:

category id or null if category of the given name does not exist on the server.

Throws:

java.rmi.RemoteException - connection problems with Teamwork server.

createCategory

@OpenApi
public static java.lang.String createCategory(java.lang.String categoryName)
                                                throws java.rmi.RemoteException

Creates project category with the given name. The name has to be unique among the other categories.

Parameters:

categoryName - the new category name

Returns:

created category ID

Throws:

java.rmi.RemoteException - connection problems with Teamwork server or when category already exists with the given name or the user has no sufficient permissions to create a category.

setCategoryName

@OpenApi
public static void setCategoryName(java.lang.String categoryID,
                                            java.lang.String categoryName)
                                     throws java.rmi.RemoteException

Sets the new name for the given category. The name has to be unique among the other categories.

Parameters:

categoryID - the category to rename

categoryName - the new category name

Throws:

java.rmi.RemoteException - connection problems with Teamwork server or when category already exists with the given name or user has no sufficient permissions to rename a category.

deleteCategory

@OpenApi
public static void deleteCategory(java.lang.String categoryID)
                                    throws java.rmi.RemoteException

Deletes the given category, however projects assigned to the given category are retained. They are just do not belong to any category.

Parameters:

categoryID - ID of the category to delete

Throws:

java.rmi.RemoteException - connection problems with Teamwork server or the user has no sufficient permissions to delete a category.

getProjectCategory

@OpenApi
 @CheckForNull
public static java.lang.String getProjectCategory(RemoteProjectDescriptor project)
                                                                   throws java.rmi.RemoteException

Gets the project category that the project belongs to. The project can belong only to a one category a time. The project also may not belong to any category, then null is returned instead of category ID.

Parameters:

project - given project

Returns:

category ID or null if given project does not belong to any category.

Throws:

java.rmi.RemoteException - connection problems with Teamwork server

setProjectCategory

@OpenApi
public static void setProjectCategory(RemoteProjectDescriptor project,
                                               java.lang.String categoryID)
                                        throws java.rmi.RemoteException

Assigns the project to the given category. The project can belong only to a one category a time, thus if project already belongs to some other category, then project is removed from that category and assigned to the given category. If given categoryID is null, then project becomes unassigned to any category.

Parameters:

project - given project

categoryID - id of the category

Throws:

java.rmi.RemoteException - connection problems with Teamwork server or the user has no sufficient permissions to assign a project to a category.