ICollabNetSoap (SOAP API - Version 60 17.1.524 API)

All Known Implementing Classes:

CollabNetSoapMockStub, CollabNetSoapStub
```
public interface ICollabNetSoap
```
The web service providing the core TeamForge functionality, such as authentication, project and membership information, etc.
Change History

Version 16.7
- login: Modified in 16.7 to allow case-insensitive user names during login, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true;
  Also, it restricts the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
- createUser: Modified in 16.7 to allow license type field to have multiple license with comma separated.
  Also, it restricts the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
- getUserData: getUserData supports list of license types in response;
  Also, it is modified in 16.7 to return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
- getUserData2: getUserData2 supports list of license types in response;
  Also, it is modified in 16.7 to return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
- setUserData: setUserData is modified to accept list of license types
- setUserData2: setUserData2 is modified to accept list of license types
- getUserList2: getUserList2 is modified to accept license type filter to have multiple licenses.
- doMandatoryPasswordChange: Modified in 16.7 to restrict the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
- changePassword: Modified in 16.7 to restrict the length of the password to be less than the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
Version 8.2
- createProjectLinkedApp2: Added support for creation of project-level linked application with orchestrate source association.i
- getLinkedApplicationData2 Added support for getting linked application data with visible and tooltype fields.
- setLinkedApplicationData2 Added support for setting linked application data with visible (to hide or show linked app from menubar), tooltype fields and icon.
- listProjectLinkedApps2: Added support for listing of project-level linked applications with the visible and tooltype fields.
Version 8.0
- getUserList: Modified to fetch the list of users information with organization, alternate emails, locale and time zone details.
- getUserList2: Added new operation to fetch the list of users information with id, organization, alternate emails, locale and time zone details.
- setUserData2: Added new operation to update the user information with validations.
- getProjectGroupsForProject1: Added new operation to get the project groups in which the project belongs and checks for user view permission
- createProjectLinkedApp: Added support for creation of project-level linked application.i
- listSiteWideLinkedApps: Added support for listing of site-wide linked applications.
- listProjectLinkedApps: Added support for listing of project-level linked applications.
- getLinkedApplicationData Added support for getting linked application data.
- setLinkedApplicationData Added support for setting linked application data and icon.
- deleteLinkedApp Added support for deleting linked application.
- getOneTimeToken: Added support to get one time token for active user session
- getUserList: Updated permission check for non-super user can see only non-super-users in the user list and super user can see all users in the user list .
- getUserList2: Updated permission check for non-super user can see only non-super-users in the user list and super user can see all users in the user list .
Since:

4.1

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames)` Makes the users given in the usernames parameter as administrators of the Project Group represented by the projectGroupId.
`void`	`addProjectGroupMember(String sessionId, String projectGroupId, String userName)` Makes a user a member of a project group.
`void`	`addProjectMember(String sessionId, String projectId, String userName)` Makes a user a member of a project.
`void`	`addProjectsToProjectGroup(String sessionId, String projectGroupId, String[] projectIds)` Adds the given projects to a project group.
`void`	`addUserGroupMember(String sessionId, String userGroupId, String userName)` Adds a user to a user group.
`boolean`	`canReceiveOwnUpdates(String sessionId)` Returns whether the current user receives notifications for the user's own updates.
`void`	`changeIAObjectTitle(String sessionId, String pluggableObjectId, String pluggableObjectTitle)` Updates the title for Pluggable objects only.
`boolean`	`changePassword(String sessionId, String userName, String newPassword)` Allows the user to change the password Note: From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
`void`	`createAssociation(String sessionId, String originId, String targetId, String description)` Creates an association between two objects.
`void`	`createAssociationWithTitles(String sessionId, String originId, String originTitle, String targetId, String targetTitle, String description)` Creates an association between two objects with specified title.
`ProjectSoapDO`	`createOrReplaceProjectTemplate(String sessionId, String projectId, String title, String description, String[] contentChoices, String templateId)` Creates or replaces a template from an existing project
`ProjectSoapDO`	`createProject(String sessionId, String name, String title, String description)` Creates a project.
`ProjectSoapDO`	`createProjectFromTemplate(String sessionId, String templateId, String name, String title, String description)` Creates a project from template.
`ProjectGroupSoapDO`	`createProjectGroup(String sessionId, String title, String description)` Creates a Project Group.
`String`	`createProjectLinkedApp(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon)` Creates linked application in a given project and return the created application Id
`String`	`createProjectLinkedApp2(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon, String toolId)` Creates linked application in a given project and return the created application Id
`String`	`createSiteWideLinkedApp(String sessionId, String title, String applicationUrl, String applicationType, boolean singleSignon)` Create a site-wide linked application and return the created application Id
`UserSoapDO`	`createUser(String sessionId, String userName, String email, String fullName, String organization, String locale, String timeZone, String licenseType, boolean isSuperUser, boolean isRestrictedUser, String password)` Creates a new user with the specified parameters.
`UserGroupSoapDO`	`createUserGroup(String sessionId, String fullName, String description)` Creates a new user group with the specified parameters.
`void`	`deleteAssociation(String sessionId, String originId, String targetId)` Deletes an association between two objects
`void`	`deleteAttachment(String sessionId, String objectId, String attachmentId)` Deletes the specified attachment of the specified object.
`void`	`deleteLinkedApp(String sessionId, String linkedAppId)` Delete the linked application.
`void`	`deleteProject(String sessionId, String projectId, boolean noNotification, boolean forceDeleteEvenIfChildFound)` Deletes a project.
`void`	`deleteProjectGroup(String sessionId, String projectGroupId, boolean forceDeleteEvenIfMemberProjectFound)` Deletes a project group.
`void`	`deleteUserGroup(String sessionId, String groupId)` Deletes a user group.
`String`	`doMandatoryPasswordChange(String userName, String oldPassword, String newPassword)` Allows user to change the password if and only if the password was set by an administrator.
`ProjectSoapList`	`findProjects(String sessionId, String queryString)` Finds a list of projects matching a search string.
`UserSoapList`	`findUsers(String sessionId, String queryString)` Finds a list of users matching a search string.
`String`	`getApiVersion()` Gets TeamForge API version.
`AssociationSoapList`	`getAssociationList(String sessionId, String objectId)` Lists all of the associations for a given object.
`AuditHistorySoapList`	`getAuditHistoryList(String sessionId, String objectId, boolean includeDerivedChanges)` Returns the list of changes made to the specified object in reverse chronological order.
`String`	`getBroadCastMessage(String sessionId)` Gets broadcast message
`CommentSoapList`	`getCommentList(String sessionId, String objectId)` Gets list of comments for object.
`String`	`getConfigurationValue(String sessionId, String keyValue)` Gets Configuration value for the passed key.
`long`	`getCurrentTime(String sessionId)` Returns the current server time in milliseconds.
`UserSoapDO`	`getCurrentUserData(String sessionId)` Gets the user details for a given user session id.
`String`	`getJSessionBySoapId(String soapId)` Deprecated. instead use `getJSessionId`
`String`	`getJSessionId(String oneTimeToken)` Returns current user Jsession Id using one time token id
`LinkedApplicationSoapDO`	`getLinkedApplicationData(String sessionId, String linkedAppId)` Gets Linked Application Data by Linked Application Id
`LinkedApplication2SoapDO`	`getLinkedApplicationData2(String sessionId, String linkedAppId)` Gets Linked Application Data by Linked Application Id
`ProjectSoapList`	`getMemberProjectsForProjectGroup(String sessionId, String projectGroupId)` Gets the Project List for project group.
`String`	`getOneTimeToken(String sessionId)` Gives one time token for active sessionId.
`int`	`getProjectAccessLevel(String sessionId, String projectId)` Gets the project's access level.
`ProjectSoapDO`	`getProjectByPath(String sessionId, String projectPath)` Gets the project data for a given project path.
`ProjectSoapDO`	`getProjectData(String sessionId, String projectId)` Gets a project object which includes the parent project ID, project hierarchy path and locked status flag.
`long`	`getProjectDiskUsage(String sessionId, String projectId)` Gets the filestorage disk utilization of a project specified by a project id
`ProjectGroupSoapDO`	`getProjectGroupData(String sessionId, String projectGroupId)` Gets the Project Group Data by project group id.
`ProjectGroupMemberSoapList`	`getProjectGroupMemberList(String sessionId, String projectGroupId)` Returns project group membership list.
`ProjectGroupSoapList`	`getProjectGroupsForProject(String sessionId, String projectId)` Deprecated. in favour of getProjectGroupsForProject1
`ProjectGroupSoapList`	`getProjectGroupsForProject1(String sessionId, String projectId)` Gets ProjectGroupList by project and user should have view permission
`com.collabnet.ce.soap60.types.SoapNamedValues`	`getProjectHierarchyPaths(String sessionId, String[] projectIds)` Returns the hierarchy path of the given projects.
`ProjectSoapList`	`getProjectList(String sessionId, boolean fetchHierarchyPath)` Returns a list of all projects visible to the user.
`ProjectSoapList`	`getProjectListForUser(String sessionId, String username, boolean fetchHierarchyPath, boolean includeGroupMembership)` Returns a list of projects the user passed as parameter is a member of (the list contains only the projects that the soap caller has the right to see).
`ProjectMemberSoapList`	`getProjectMemberList(String sessionId, String projectId)` Returns project membership list.
`long`	`getProjectQuota(String sessionId, String projectId)` Gets the disk quota for a project.
`String`	`getSessionId(String oneTimeToken)` Returns current user session Id using one time token id
`ProjectSoapList`	`getSubprojectList(String sessionId, String projectId, boolean fetchHierarchyPath)` Returns a list of the immediate sub projects of a project.
`UserSoapDO`	`getUserByEmail(String sessionId, String email)` Returns the user information for the given email address.
`UserSoapDO`	`getUserByName(String sessionId, String fullname)` Returns the user information for the given full name.
`UserSoapDO`	`getUserData(String sessionId, String username)` Gets the user details for the given username.
`User2SoapDO`	`getUserData2(String sessionId, String username)` Gets the user details for the given username.
`String`	`getUserEffectiveMode(String sessionId)` Gets effective mode (ALM or SCM) for the current user
`UserGroupSoapDO`	`getUserGroupData(String sessionId, String groupId)` Returns the user group information.
`UserGroupSoapList`	`getUserGroupList(String sessionId)` Gets a list of all user groups on the system.
`UserGroupSoapList`	`getUserGroupListForProject(String sessionId, String projectOrProjectGroupId)` Returns a list of user groups that have a role in the project.
`UserGroupSoapList`	`getUserGroupListForUser(String sessionId, String username)` Gets a list of all user groups the user belongs.
`UserSoapList`	`getUserGroupMembers(String sessionId, String groupId)` Gets a list of active users who are members of a user group
`UserSoapList`	`getUserList(String sessionId, com.collabnet.ce.soap60.types.SoapFilter soapFilter)` Deprecated. use getUserList2 instead, which includes organization, alternate emails, locale and timeZone details in the result.
`User2SoapList`	`getUserList2(String sessionId, com.collabnet.ce.soap60.types.SoapFilter soapFilter)` Gets a list of all users on the system.
`String`	`getUserSessionBySoapId(String soapId)` gets the access token using soap Id.
`String`	`getVersion(String sessionId)` Gets TeamForge version.
`VersionInformationSoapList`	`getVersionInformationList(String sessionId, String folderId)` Obtains a list of versions and last modified dates for the objects residing in the specified folder.
`String`	`getWebAndSoapSessionId(String oneTimeToken)` Gets the web and soap session id's separated by &
`boolean`	`hasGeneralPermission(String sessionId, String username, String projectId, String operationString, String objectId)` Checks if the user has general permission for the resource (specified by objectid).
`boolean`	`hasPermission(String sessionId, String username, String projectId, String operationString, String objectId)` Checks whether the given user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
`boolean`	`hasPermission2(String sessionId, String projectId, String operationString, String objectId)` Checks whether the current user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
`boolean`	`hasSitewideRolePermission(String sessionId, String operationString)` Checks if the current user has the given site wide permission to perform the operation.
`boolean`	`isHostedMode(String sessionId)` Verifies if the TeamForge appserver is running in Hosted Mode.
`boolean`	`isSoapRedirectPostOnlyMode(String sessionId)` Verifies if TeamForge is running in SoapRedirect Post-Only mode.
`void`	`keepAlive(String sessionId)` Deprecated. This operation is no longer supported. Acquire new access token by logging in again.
`AttachmentSoapList`	`listAttachments(String sessionId, String objectId)` Lists the attachments associated with the object, the attachment itself is not part of the returned object.
`UserGroupSoapList`	`listGroupsWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId, boolean includeInherited)` Returns a list of user groups which have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
`UserSoapList`	`listProjectAdmins(String sessionId, String projectId)` Returns project administrators list.
`ProjectGroupSoapList`	`listProjectGroups(String sessionId)` Returns a list of all projects groups.
`LinkedApplicationSoapList`	`listProjectLinkedApps(String sessionId, String projectId)` Lists project-level linked applications for a given project.
`LinkedApplication2SoapList`	`listProjectLinkedApps2(String sessionId, String projectId)` Lists project-level linked applications for a given project.
`LinkedApplicationSoapList`	`listSiteWideLinkedApps(String sessionId)` Lists site-wide linked applications.
`ProjectSoapList`	`listTemplates(String sessionId)` Lists project templates within the installation.
`UserSoapList`	`listUsersWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId)` Returns a list of users who have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
`UserSoapList`	`listUsersWithPermissionOnObject(String sessionId, String operationString, String objectId, int flag)` Returns the list of users who have the given permission on the given object.
`ProjectSoapDO`	`lockProject(String sessionId, String projectId)` Locks project.
`String`	`login(String userName, String password)` Logs in a user and creates a new session.This will throw login fault if the user's password was set by an administrator and if the user has not changed it yet.
`String`	`loginAnonymous(String anonSharedSecret)` This method allows to login as anonymous to get TF default access.
`String`	`loginWithToken(String username, String oneTimeToken)` Logs in a user and creates a new session.
`void`	`logoff(String userName, String sessionId)` Ends a user's session, but the token can still be used until it expires.
`void`	`reindexObject(String sessionId, String objectId)` Re-indexes the contents of the specified project, folder, item or user.
`void`	`removeProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames)` Removes the users given in the usernames parameter from the administrator role of the Project Group represented by the projectGroupId.
`void`	`removeProjectGroupMember(String sessionId, String projectGroupId, String userName)` Removes a user from a project group.
`void`	`removeProjectMember(String sessionId, String projectId, String userName)` Removes a user from a project.
`void`	`removeProjectsFromProjectGroup(String sessionId, String[] projectMemberIds, String projectGroupId)` Removes projects from project group
`void`	`removeUserGroupMember(String sessionId, String userGroupId, String userName)` Removes a user from a user group.
`void`	`setLinkedApplicationData(String sessionId, LinkedApplicationSoapDO linkedApplicationSoapDO, String iconKey, String iconFileName, String iconMimeType)` Sets the linked application.
`void`	`setLinkedApplicationData2(String sessionId, LinkedApplication2SoapDO linkedApplication2SoapDO, String iconKey, String iconFileName, String iconMimeType)` Sets the linked application.
`void`	`setParentProject(String sessionId, String projectId, String parentProjectId)` Sets the parent of a project.
`void`	`setProjectAccessLevel(String sessionId, String projectId, int accessLevel)` Sets the project access level.
`void`	`setProjectGroupData(String sessionId, ProjectGroupSoapDO projectGroupData)` Sets the project group's data with the data represented in the projectGroupData parameter.
`void`	`setProjectQuota(String sessionId, String projectId, long quota)` Sets the disk quota for a project.
`void`	`setUserData(String sessionId, UserSoapDO userData)` Sets the user information.
`void`	`setUserData2(String sessionId, User2SoapDO userData)` Sets the user information.
`void`	`setUserGroupData(String sessionId, UserGroupSoapDO groupData)` Sets the user group information.
`ProjectSoapDO`	`unLockProject(String sessionId, String projectId)` Un-Locks project.

- Method Detail
  - getVersion
```
String getVersion(String sessionId)
           throws RemoteException
```
    Gets TeamForge version. NOTE: In earlier version of TeamForge, this call returned a symbolic name for the version. It is now replaced with the actual version of the product as seen in the "About TeamForge" dialog.
    
    Parameters:
    
    sessionId - the session id.
    
    Returns:
    
    Version as string.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    RemoteException
    
    Since:
    
    4.1
  - getApiVersion
```
String getApiVersion()
              throws RemoteException
```
    Gets TeamForge API version. This is different from the TeamForge Version and can be changed independent of that. IMPORTANT: note that the API version string returned CAN be updated between releases. Therefore it is very important to perform proper version checking against the version returned. This is because we may introduce new API calls as additional features are added to our product. However we guarantee that subsequent releases will not change existing API signatures or SOAP structures. The version returned will be a period separated string with the following format: - The first two fields represent the TeamForge release version number. For example, "4.3" equates to SourceForge 4.3 - The third field, if present, will represent service pack version. - The fourth field, if present, will represent the hot fix version. Example: 4.3 => SourceForge 4.3 4.3.0.2 => SourceForge 4.3 Hotfix2 4.3.2 => SourceForge 4.3 SP2 So a call that existed in 4.3 is guaranteed to exist in 4.3.2. One in 4.3.0.2 will also work in 4.3.2.
    
    Returns:
    
    API version as string.
    
    Throws:
    
    RemoteException
    
    Since:
    
    4.1-HOTFIX2
  - keepAlive
```
void keepAlive(String sessionId)
        throws RemoteException
```
    Deprecated. This operation is no longer supported. Acquire new access token by logging in again.
    
    This operation is no longer supported. If token is timed out, acquire new access token by logging in again.
    
    Parameters:
    
    sessionId - the session id.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    RemoteException
    
    Since:
    
    4.1
  - loginAnonymous
```
String loginAnonymous(String anonSharedSecret)
               throws RemoteException
```
    This method allows to login as anonymous to get TF default access. To make sure this method does not really leave a security hole, a shared security is used. To use this method, the following configuration variable must be added into site-options.conf SOAP_ANONYMOUS_SHARED_SECRET=aSecret
    
    Parameters:
    
    anonSharedSecret - Shared secret for anonymous login. Its value must match the value set for SOAP_ANONYMOUS_SHARED_SECRET configuration variable set in site-options.conf file.
    
    Returns:
    
    Access token.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4
  - login
```
String login(String userName,
             String password)
      throws RemoteException
```
    Logs in a user and creates a new session.This will throw login fault if the user's password was set by an administrator and if the user has not changed it yet.
    Note 1: From 16.7, this allows case-insensitive user names during login, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
    Note 2: From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
    
    Parameters:
    
    userName - Name of the user.
    
    password - User password.
    
    Returns:
    
    Access token.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - loginWithToken
```
String loginWithToken(String username,
                      String oneTimeToken)
               throws RemoteException
```
    Logs in a user and creates a new session.
    
    Parameters:
    
    username - Name of the user.
    
    oneTimeToken - a one time token for login.
    
    Returns:
    
    Access token.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.2
  - logoff
```
void logoff(String userName,
            String sessionId)
     throws RemoteException
```
    Ends a user's session, but the token can still be used until it expires.
    
    Parameters:
    
    userName - User's name.
    
    sessionId - Session id.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - doMandatoryPasswordChange
```
String doMandatoryPasswordChange(String userName,
                                 String oldPassword,
                                 String newPassword)
                          throws RemoteException
```
    Allows user to change the password if and only if the password was set by an administrator.
    Note: From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file; Users who already used a password longer than this limit have to reset their password either by using 'Forgot Password" link in the UI or by contacting TeamForge administrator.
    
    Parameters:
    
    userName - login name
    
    oldPassword - current password
    
    newPassword - new password
    
    Returns:
    
    User session key.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect.
    
    com.collabnet.ce.soap60.fault.InvalidOperationFault - if the user has already changed the password
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If there is a session fault.
    
    com.collabnet.ce.soap60.fault.InvalidPasswordFault - If the new password is not valid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have permissions to change password
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If invalid user name is passed
    
    RemoteException
    
    Since:
    
    6.0
  - changePassword
```
boolean changePassword(String sessionId,
                       String userName,
                       String newPassword)
                throws RemoteException
```
    Allows the user to change the password
    Note: From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
    
    Parameters:
    
    sessionId - User session key
    
    userName - login name
    
    newPassword - new password
    
    Returns:
    
    true if the password has been successfully changed
    
    Throws:
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If there is a session fault.
    
    com.collabnet.ce.soap60.fault.InvalidPasswordFault - If the new password is not valid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have permissions to change password
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If invalid user name is passed
    
    RemoteException
    
    Since:
    
    6.0
  - listGroupsWithGeneralPermission
```
UserGroupSoapList listGroupsWithGeneralPermission(String sessionId,
                                                  String projectId,
                                                  String operationString,
                                                  String folderId,
                                                  boolean includeInherited)
                                           throws RemoteException
```
    Returns a list of user groups which have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
    
    Parameters:
    
    sessionId - The current user session id
    
    projectId - Project for which permission is checked
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    folderId - Id of the folder for which permission needs to be checked.
    
    includeInherited - true includes groups inherited from parent projects, false otherwise
    
    Returns:
    
    a list of user groups which has the permission on a given folder
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - When Session is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the folderId does not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the operationString is in an invalid format
    
    com.collabnet.ce.soap60.fault.SystemFault - Any other exceptions
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have project view permission
    
    RemoteException
    
    Since:
    
    6.0
  - hasPermission
```
boolean hasPermission(String sessionId,
                      String username,
                      String projectId,
                      String operationString,
                      String objectId)
               throws RemoteException
```
    Checks whether the given user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Parameters:
    
    sessionId - the current user session id
    
    username - the name of the user to check permission
    
    projectId - the project in which the operation is defined
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    objectId - the object for which we are doing the permission check. Null if we're checking permission on the app folder of a project
    
    Returns:
    
    whether the given user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - The specified projectId or folderId was invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the operationString is in an invalid format
    
    RemoteException
    
    Since:
    
    6.1
    
    See Also:
    
    OperationConstants
  - hasPermission2
```
boolean hasPermission2(String sessionId,
                       String projectId,
                       String operationString,
                       String objectId)
                throws RemoteException
```
    Checks whether the current user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Parameters:
    
    sessionId - the current user session id
    
    projectId - the project in which the operation is defined
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    objectId - the object for which we are doing the permission check. Null if we're checking permission on the app folder of a project
    
    Returns:
    
    whether the current user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - The specified projectId or folderId was invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the operationString is in an invalid format
    
    RemoteException
    
    Since:
    
    6.2
    
    See Also:
    
    OperationConstants
  - getProjectList
```
ProjectSoapList getProjectList(String sessionId,
                               boolean fetchHierarchyPath)
                        throws RemoteException
```
    Returns a list of all projects visible to the user. Use getUserProjectList() for getting a list of projects in which the user is a member.
    
    Parameters:
    
    sessionId - User session key.
    
    fetchHierarchyPath - flag indicating whether to fetch the hierarchy path for each project
    
    Returns:
    
    List of projects
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - getProjectListForUser
```
ProjectSoapList getProjectListForUser(String sessionId,
                                      String username,
                                      boolean fetchHierarchyPath,
                                      boolean includeGroupMembership)
                               throws RemoteException
```
    Returns a list of projects the user passed as parameter is a member of (the list contains only the projects that the soap caller has the right to see). This method also returns the projects in which the user is a member through group membership and assigned some roles, if the includeGroupMembership flag is true.
    
    Parameters:
    
    sessionId - User session key.
    
    username - User name.
    
    fetchHierarchyPath - flag indicating whether to fetch the hierarchy path for each project
    
    includeGroupMembership - flag indicating whether to return projects which are accessible by group membership.
    
    Returns:
    
    List of user projects.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    RemoteException
    
    Since:
    
    4.4-SP1
  - getSubprojectList
```
ProjectSoapList getSubprojectList(String sessionId,
                                  String projectId,
                                  boolean fetchHierarchyPath)
                           throws RemoteException
```
    Returns a list of the immediate sub projects of a project. When a project group id is passed, this API will throw a NoSuchObjectFault.
    
    Parameters:
    
    sessionId - User session key.
    
    projectId - Project id (not a project group id).
    
    fetchHierarchyPath - flag indicating whether to fetch the hierarchy path for each project
    
    Returns:
    
    List of sub projects.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the project passed as parameter does not exist or if the project id is in fact a project group id.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    RemoteException
    
    Since:
    
    6.0
  - createProject
```
ProjectSoapDO createProject(String sessionId,
                            String name,
                            String title,
                            String description)
                     throws RemoteException
```
    Creates a project.
    
    Parameters:
    
    sessionId - User session key.
    
    name - The name of the project (can be null, will fall back to title or id)
    
    title - The title of the project
    
    description - The description of the project
    
    Returns:
    
    The project data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the project with that name already exists.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when specified argument is invalid.
    
    IllegalArgumentException - Invalid data was passed in
    
    RemoteException
    
    Since:
    
    4.2-SP1
  - createOrReplaceProjectTemplate
```
ProjectSoapDO createOrReplaceProjectTemplate(String sessionId,
                                             String projectId,
                                             String title,
                                             String description,
                                             String[] contentChoices,
                                             String templateId)
                                      throws RemoteException
```
    Creates or replaces a template from an existing project
    
    Parameters:
    
    sessionId - The session id.
    
    projectId - The project to copy into a template
    
    title - The title of the template
    
    description - The description of the template
    
    contentChoices - the desired application content in the template, see constants below
    
    templateId - the id of the template to replace, if null (not empty string but null), a new template will be created
    
    Returns:
    
    The template project data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the template or project does not exist.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when illegal argument is passed.
    
    RemoteException
    
    Since:
    
    5.3
    
    See Also:
    
    ProjectSoapDO.INCLUDE_ALL_CONTENT, ProjectSoapDO.INCLUDE_DISCUSSIONS_CONTENT, ProjectSoapDO.INCLUDE_DOCUMENTS_CONTENT, ProjectSoapDO.INCLUDE_FRS_CONTENT, ProjectSoapDO.INCLUDE_PLANNING_FOLDERS, ProjectSoapDO.INCLUDE_PROJECT_PAGES, ProjectSoapDO.INCLUDE_REPORTS_CONTENT, ProjectSoapDO.INCLUDE_SAVED_SEARCHES, ProjectSoapDO.INCLUDE_TASKS_CONTENT, ProjectSoapDO.INCLUDE_TRACKER_CONTENT, ProjectSoapDO.INCLUDE_WIKI_CONTENT, ProjectSoapDO.INCLUDE_TEAMS
  - createProjectFromTemplate
```
ProjectSoapDO createProjectFromTemplate(String sessionId,
                                        String templateId,
                                        String name,
                                        String title,
                                        String description)
                                 throws RemoteException
```
    Creates a project from template.
    
    Parameters:
    
    sessionId - User session key.
    
    templateId - The template project id
    
    name - The name of the project (can be null, will fall back to title or id)
    
    title - The title of the project
    
    description - The description of the project
    
    Returns:
    
    The project data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the project with that name already exists.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when illegal argument is passed.
    
    RemoteException
    
    Since:
    
    4.2-SP1
  - listTemplates
```
ProjectSoapList listTemplates(String sessionId)
                       throws RemoteException
```
    Lists project templates within the installation.
    
    Parameters:
    
    sessionId - User session key.
    
    Returns:
    
    The list of template projects
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.2-SP1
  - findProjects
```
ProjectSoapList findProjects(String sessionId,
                             String queryString)
                      throws RemoteException
```
    Finds a list of projects matching a search string.
    
    Parameters:
    
    sessionId - User session id.
    
    queryString - Query string.
    
    Returns:
    
    List of projects matching search criteria.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the query string is invalid.
    
    RemoteException
    
    Since:
    
    4.1
  - lockProject
```
ProjectSoapDO lockProject(String sessionId,
                          String projectId)
                   throws RemoteException
```
    Locks project. Thus making all the tools and their data read-only.
    
    Parameters:
    
    sessionId - User session key.
    
    projectId - Project id.
    
    Returns:
    
    Project data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.ProjectAlreadyLockedFault - When a user tries to lock an already locked project
    
    RemoteException
    
    Since:
    
    6.0
  - unLockProject
```
ProjectSoapDO unLockProject(String sessionId,
                            String projectId)
                     throws RemoteException
```
    Un-Locks project. Restoring to the normal state where the objects are editable.
    
    Parameters:
    
    sessionId - User session key.
    
    projectId - Project id.
    
    Returns:
    
    Project data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0
  - getProjectData
```
ProjectSoapDO getProjectData(String sessionId,
                             String projectId)
                      throws RemoteException
```
    Gets a project object which includes the parent project ID, project hierarchy path and locked status flag.
    
    Parameters:
    
    sessionId - User session key.
    
    projectId - Project id.
    
    Returns:
    
    Project data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - getProjectMemberList
```
ProjectMemberSoapList getProjectMemberList(String sessionId,
                                           String projectId)
                                    throws RemoteException
```
    Returns project membership list.
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - Id of the project.
    
    Returns:
    
    Members of project.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - listProjectAdmins
```
UserSoapList listProjectAdmins(String sessionId,
                               String projectId)
                        throws RemoteException
```
    Returns project administrators list.
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - Id of the project.
    
    Returns:
    
    Administrators of the project.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    5.0
  - getUserGroupListForProject
```
UserGroupSoapList getUserGroupListForProject(String sessionId,
                                             String projectOrProjectGroupId)
                                      throws RemoteException
```
    Returns a list of user groups that have a role in the project.
    
    Parameters:
    
    sessionId - User session id.
    
    projectOrProjectGroupId - Project/ProjectGroup Id.
    
    Returns:
    
    UserGroups who have a role in the project.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4-SP1 (renamed from getProjectGroupList in 6.1)
  - addProjectMember
```
void addProjectMember(String sessionId,
                      String projectId,
                      String userName)
               throws RemoteException
```
    Makes a user a member of a project.
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - Id project Id.
    
    userName - Name of the new user.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.3
  - addProjectGroupMember
```
void addProjectGroupMember(String sessionId,
                           String projectGroupId,
                           String userName)
                    throws RemoteException
```
    Makes a user a member of a project group.
    
    Parameters:
    
    sessionId - User session id.
    
    projectGroupId - ProjectGroup id.
    
    userName - Name of the new user.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0.1
  - removeProjectMember
```
void removeProjectMember(String sessionId,
                         String projectId,
                         String userName)
                  throws RemoteException
```
    Removes a user from a project.
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - Id of the project.
    
    userName - Name of the new user.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.RemoveOnlyProjectAdminFault - attempting to remove last project admin
    
    RemoteException
    
    Since:
    
    4.3 hotfix5
  - createUserGroup
```
UserGroupSoapDO createUserGroup(String sessionId,
                                String fullName,
                                String description)
                         throws RemoteException
```
    Creates a new user group with the specified parameters. NOTE: Only super-users or users with Group creation permissions are allowed to create user groups through SOAP interface.
    
    Parameters:
    
    sessionId - User's session id.
    
    fullName - Full name of the new group.
    
    description - Description of the new group.
    
    Returns:
    
    Newly created group object.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the specified group already exists.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more group parameters are invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from createGroup in 6.1)
  - getUserGroupData
```
UserGroupSoapDO getUserGroupData(String sessionId,
                                 String groupId)
                          throws RemoteException
```
    Returns the user group information.
    
    Parameters:
    
    sessionId - User's session id.
    
    groupId - User Group id.
    
    Returns:
    
    User Group data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified group id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from getGroupData in 6.1)
  - setUserGroupData
```
void setUserGroupData(String sessionId,
                      UserGroupSoapDO groupData)
               throws RemoteException
```
    Sets the user group information. NOTE: Only super-users or users with Group edit permissions are allowed to set user group data.
    
    Parameters:
    
    sessionId - User's session id.
    
    groupData - User Group data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.VersionMismatchFault - The user group version being edited is not the latest one
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when a user group with the specified user group name already exists.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the specified user group name is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from setGroupData in 6.1)
  - deleteUserGroup
```
void deleteUserGroup(String sessionId,
                     String groupId)
              throws RemoteException
```
    Deletes a user group. Only Super user or users with User Group delete permissions are allowed to delete a user group.
    
    Parameters:
    
    sessionId - User session key.
    
    groupId - The id of the user group to be deleted
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if we can't find the project with the specified user group id
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalUserModificationFault - when a user tries to delete system created user group.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from deleteGroup in 6.1)
  - getUserGroupList
```
UserGroupSoapList getUserGroupList(String sessionId)
                            throws RemoteException
```
    Gets a list of all user groups on the system.
    
    Parameters:
    
    sessionId - User session id.
    
    Returns:
    
    List of user groups matching a filter.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from getGroupList in 6.1)
  - getUserGroupListForUser
```
UserGroupSoapList getUserGroupListForUser(String sessionId,
                                          String username)
                                   throws RemoteException
```
    Gets a list of all user groups the user belongs. In order to view the list of user groups another user belongs to, caller must have Users - View or UserGroups - View permission.
    
    Parameters:
    
    sessionId - User session id.
    
    username - the name of the user
    
    Returns:
    
    List of user groups the user belongs.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from getUserGroupList in 6.1)
  - getUserGroupMembers
```
UserSoapList getUserGroupMembers(String sessionId,
                                 String groupId)
                          throws RemoteException
```
    Gets a list of active users who are members of a user group
    
    Parameters:
    
    sessionId - User session id.
    
    groupId - the user group id
    
    Returns:
    
    List of members of a user group
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if we can't find the project with the specified user group id.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from getActiveGroupMembers in 6.1)
  - addUserGroupMember
```
void addUserGroupMember(String sessionId,
                        String userGroupId,
                        String userName)
                 throws RemoteException
```
    Adds a user to a user group. The user and user group must be existing already.
    
    Parameters:
    
    sessionId - User session id.
    
    userGroupId - User Group to which the user should be added
    
    userName - User to be added to the user group
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the user group and/or user does not exist
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalGroupMemberAddFault - when an users in the system is added to system created user group.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from addGroupMember in 6.1)
  - removeUserGroupMember
```
void removeUserGroupMember(String sessionId,
                           String userGroupId,
                           String userName)
                    throws RemoteException
```
    Removes a user from a user group.
    
    Parameters:
    
    sessionId - User session id.
    
    userGroupId - User Group from which the user should be removed.
    
    userName - User to be removed.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the user group and/or user does not exist
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4 SP1 (renamed from removeGroupMember in 6.1)
  - createUser
```
UserSoapDO createUser(String sessionId,
                      String userName,
                      String email,
                      String fullName,
                      String organization,
                      String locale,
                      String timeZone,
                      String licenseType,
                      boolean isSuperUser,
                      boolean isRestrictedUser,
                      String password)
               throws RemoteException
```
    Creates a new user with the specified parameters. NOTE: Only super-users are allowed to create users through SOAP interface. Password can be null in which case the newly created user will get an email requesting him to set the initial password.
    From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file.
    
    Parameters:
    
    sessionId - User's session id.
    
    userName - Name of the new user.
    
    email - Email of the new user.
    
    fullName - Full name of the new user.
    
    organization - organization name of the new user.
    
    locale - Locale of the new user (currently supported locales are "en" for English, "ja" for Japanese).
    
    timeZone - User's time zone. The ID for a TimeZone, either an abbreviation such as "PST", a full name such as "America/Los_Angeles", or a custom ID such as "GMT-8:00".
    
    licenseType - User's license type. Multiple license types can be given for a user as ALM,DEVOPS
    
    isSuperUser - Should user be given super-user privileges?
    
    isRestrictedUser - Should user be given restricted privileges?
    
    password - Password of the new user.
    
    Returns:
    
    Newly created user object.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the specified user already exists.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when one or more user parameters are invalid.
    
    com.collabnet.ce.soap60.fault.UserLimitExceededFault - The user limit was exceeded
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - getUserData
```
UserSoapDO getUserData(String sessionId,
                       String username)
                throws RemoteException
```
    Gets the user details for the given username.
    Note: From 16.7, this method can return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
    
    Parameters:
    
    sessionId - User session id.
    
    username - User name (login name)
    
    Returns:
    
    User data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the username is invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.2
  - getUserData2
```
User2SoapDO getUserData2(String sessionId,
                         String username)
                  throws RemoteException
```
    Gets the user details for the given username.
    Note 1: If disableProfilePicture is enabled in CTF, then it returns profilePictureLink field value as EMPTY string.
    Note 2: From 16.7, this method can return the user object even for case-insensitive user names, if the "ALLOW_CASE_INSENSITIVE_LOGIN" configuration variable in the site-options.conf file is set as true.
    
    Parameters:
    
    sessionId - User session id.
    
    username - User name (login name)
    
    Returns:
    
    User data which includes user's profile picture link.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the username is invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    7.0
  - getUserByEmail
```
UserSoapDO getUserByEmail(String sessionId,
                          String email)
                   throws RemoteException
```
    Returns the user information for the given email address.
    
    Parameters:
    
    sessionId - User session id.
    
    email - the email address of a registered user
    
    Returns:
    
    User data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the username is invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0
  - getUserByName
```
UserSoapDO getUserByName(String sessionId,
                         String fullname)
                  throws RemoteException
```
    Returns the user information for the given full name.
    
    Parameters:
    
    sessionId - User session id.
    
    fullname - the full name of a user
    
    Returns:
    
    User data.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the username is invalid
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0
  - getCurrentUserData
```
UserSoapDO getCurrentUserData(String sessionId)
                       throws RemoteException
```
    Gets the user details for a given user session id.
    
    Parameters:
    
    sessionId - user session id
    
    Returns:
    
    a UserSoapDO for a given user session id.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - if the given session id is invalid.
    
    RemoteException
    
    Since:
    
    5.4
  - setUserData2
```
void setUserData2(String sessionId,
                  User2SoapDO userData)
           throws RemoteException
```
    Sets the user information.
    
    Parameters:
    
    sessionId - User session id.
    
    userData - User data which includes user's profile picture link.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.VersionMismatchFault - The user version being edited is not the latest one
    
    com.collabnet.ce.soap60.fault.LastSuperUserFault - The user being edited is the last super user and cannot be un-superusered
    
    com.collabnet.ce.soap60.fault.IllegalUserModificationFault - If someone tried to edit a restricted property on a special user (like the status on the admin user).
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to do this (only site admins and users with site-wide user edit permissions can perform this operation)
    
    com.collabnet.ce.soap60.fault.UserLimitExceededFault - The user limit was exceeded
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    8.0
  - setUserData
```
void setUserData(String sessionId,
                 UserSoapDO userData)
          throws RemoteException
```
    Sets the user information. NOTE: Only super-users are allowed to set user data.
    
    Parameters:
    
    sessionId - User session id.
    
    userData - User data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.VersionMismatchFault - The user version being edited is not the latest one
    
    com.collabnet.ce.soap60.fault.LastSuperUserFault - The user being edited is the last super user and cannot be un-superusered
    
    com.collabnet.ce.soap60.fault.IllegalUserModificationFault - If someone tried to edit a restricted property on a special user (like the status on the admin user).
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to do this (only site admins and users with site-wide user edit permissions can perform this operation)
    
    com.collabnet.ce.soap60.fault.UserLimitExceededFault - The user limit was exceeded
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.3
  - findUsers
```
UserSoapList findUsers(String sessionId,
                       String queryString)
                throws RemoteException
```
    Finds a list of users matching a search string.
    
    Parameters:
    
    sessionId - User session id.
    
    queryString - Query string.
    
    Returns:
    
    List of users matching search criteria.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when the query string is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    RemoteException
    
    Since:
    
    4.1
  - getUserList
```
UserSoapList getUserList(String sessionId,
                         com.collabnet.ce.soap60.types.SoapFilter soapFilter)
                  throws RemoteException
```
    Deprecated. use getUserList2 instead, which includes organization, alternate emails, locale and timeZone details in the result.
    
    Gets a list of all users on the system.
    
    Parameters:
    
    sessionId - User session id.
    
    soapFilter - Search filter. See UserSoapDO.FILTER constants for supported filter names.
    
    Returns:
    
    List of users matching a filter.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission
    
    RemoteException
    
    Since:
    
    4.3
  - getUserList2
```
User2SoapList getUserList2(String sessionId,
                           com.collabnet.ce.soap60.types.SoapFilter soapFilter)
                    throws RemoteException
```
    Gets a list of all users on the system.
    
    Parameters:
    
    sessionId - User session id.
    
    soapFilter - Search filter. See UserSoapDO.FILTER constants for supported filter names.
    
    Returns:
    
    List of users matching a filter.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault - when the specified search query string is syntactically invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission
    
    RemoteException
    
    Since:
    
    8.0
  - getProjectAccessLevel
```
int getProjectAccessLevel(String sessionId,
                          String projectId)
                   throws RemoteException
```
    Gets the project's access level. Need to be project or site admin. NoSuchObjectFault will be thrown if a Project Group's id is passed to this API.
    
    Parameters:
    
    sessionId - User session Id
    
    projectId - The project Id
    
    Returns:
    
    The project access level.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is invalid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the project id is not a valid project id or if it is a Project Group's id
    
    RemoteException
    
    Since:
    
    4.1-HOTFIX6.1
    
    See Also:
    
    ProjectSoapDO.PUBLIC, ProjectSoapDO.GATED_COMMUNITY, ProjectSoapDO.PRIVATE
  - setProjectAccessLevel
```
void setProjectAccessLevel(String sessionId,
                           String projectId,
                           int accessLevel)
                    throws RemoteException
```
    Sets the project access level.
    Note: This is allowed only if the "PROJECT_ACCESS_EDITABLE" configuration's value is true. However, superusers can change the project access even though this configuration is turned off. Use getConfigurationValue to check this flag.
    
    Parameters:
    
    sessionId - User session Id
    
    projectId - The project Id
    
    accessLevel - The access level to set the project to
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is invalid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the project id is not a valid project id
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - When the accessLevel is invalid or if the "PROJECT_ACCESS_EDITABLE" configuration's value is false
    
    RemoteException
    
    Since:
    
    4.1-HOTFIX6.1
    
    See Also:
    
    getConfigurationValue(java.lang.String, java.lang.String)
  - getCommentList
```
CommentSoapList getCommentList(String sessionId,
                               String objectId)
                        throws RemoteException
```
    Gets list of comments for object.
    
    Parameters:
    
    sessionId - User session id.
    
    objectId - Object id.
    
    Returns:
    
    List of comments.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the object id is not valid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation
    
    com.collabnet.ce.soap60.fault.SystemFault - When an unexpected system level error occurs.
    
    RemoteException
    
    Since:
    
    4.2
  - listAttachments
```
AttachmentSoapList listAttachments(String sessionId,
                                   String objectId)
                            throws RemoteException
```
    Lists the attachments associated with the object, the attachment itself is not part of the returned object.
    
    Parameters:
    
    sessionId - user session id
    
    objectId - the id of the object from which attachments are to be listed
    
    Returns:
    
    List of attachments, does not include the actual file.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - When the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the object id is not valid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user doesn't have permission to perform the operation.
    
    com.collabnet.ce.soap60.fault.SystemFault - If an unexpected system fault occurs.
    
    RemoteException
    
    Since:
    
    4.4-SP1
  - deleteAttachment
```
void deleteAttachment(String sessionId,
                      String objectId,
                      String attachmentId)
               throws RemoteException
```
    Deletes the specified attachment of the specified object.
    
    Parameters:
    
    sessionId - User session id.
    
    objectId - The id of the object from which attachment has to be deleted.
    
    attachmentId - The attachment id.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4-SP1
  - createAssociation
```
void createAssociation(String sessionId,
                       String originId,
                       String targetId,
                       String description)
                throws RemoteException
```
    Creates an association between two objects. User must have view permission on both object and edit permission on at least one of the two objects.
    
    Parameters:
    
    sessionId - User session id.
    
    originId - the origin object's id (Only CTF objects can be passed as origin id)
    
    targetId - the target object's id (Incase of pluggable app object, provide the object id for targetId parameter)
    
    description - the description for the association
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - if the user's session is not valid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to create the association
    
    com.collabnet.ce.soap60.fault.SystemFault - if an unexpected system error occurs
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the origin or target objects do not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if a valid association cannot be created between the given objects
    
    RemoteException
    
    Since:
    
    4.1
  - createAssociationWithTitles
```
void createAssociationWithTitles(String sessionId,
                                 String originId,
                                 String originTitle,
                                 String targetId,
                                 String targetTitle,
                                 String description)
                          throws RemoteException
```
    Creates an association between two objects with specified title. User must have view permission on both object and edit permission on at least one of the two objects. Titles will not be stored for CTF objects.
    
    Parameters:
    
    sessionId - User session id.
    
    originId - the origin object's id (Only CTF objects can be passed as origin id)
    
    originTitle - the origin object's title (As of 7.0 originTitle will be ignored completely)
    
    targetId - the target object's id (For pluggable app object, provide the object id for targetId parameter)
    
    targetTitle - the target object's title (CTF objects title will not be stored. Only title supplied for IAF Objects will be stored)
    
    description - the description for the association
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - if the user's session is not valid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to create the association
    
    com.collabnet.ce.soap60.fault.SystemFault - if an unexpected system error occurs
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the origin or target objects do not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if a valid association cannot be created between the given objects
    
    RemoteException
    
    Since:
    
    7.0
  - changeIAObjectTitle
```
void changeIAObjectTitle(String sessionId,
                         String pluggableObjectId,
                         String pluggableObjectTitle)
                  throws RemoteException
```
    Updates the title for Pluggable objects only.
    
    Parameters:
    
    sessionId - User session id.
    
    pluggableObjectId - The pluggable app object id, provide the object id for which the title needs to be updated
    
    pluggableObjectTitle - the pluggable object's title (Pluggable objects could pass the object title to be updated in CTF)
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - if the user's session is not valid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to create the association
    
    com.collabnet.ce.soap60.fault.SystemFault - if an unexpected system error occurs
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the origin or target objects do not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if a valid association cannot be created between the given objects
    
    RemoteException
    
    Since:
    
    7.0
  - deleteAssociation
```
void deleteAssociation(String sessionId,
                       String originId,
                       String targetId)
                throws RemoteException
```
    Deletes an association between two objects
    
    Parameters:
    
    sessionId - User session id.
    
    originId - the origin object's id (Only CTF objects can be passed as origin id)
    
    targetId - the target object's id
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - if the user's session is not valid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to delete the association
    
    com.collabnet.ce.soap60.fault.SystemFault - if an unexpected system error occurs
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if the origin or target objects do not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if an association does not exist between the given objects
    
    RemoteException
    
    Since:
    
    4.2
  - deleteProject
```
void deleteProject(String sessionId,
                   String projectId,
                   boolean noNotification,
                   boolean forceDeleteEvenIfChildFound)
            throws RemoteException
```
    Deletes a project.
    
    Parameters:
    
    sessionId - User session key.
    
    projectId - The id of the project to be deleted
    
    noNotification - if true no notifications will be sent.
    
    forceDeleteEvenIfChildFound - delete even if there are child projects
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if we can't find the project with the specified project id
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.ParentRoleUsedInChildProjectsFault - when a role of the project is used in its child projects.
    
    com.collabnet.ce.soap60.fault.ChildProjectsFoundFault - thrown if any child projects are found for the project that is deleted.
    
    RemoteException
    
    Since:
    
    4.3
  - getAssociationList
```
AssociationSoapList getAssociationList(String sessionId,
                                       String objectId)
                                throws RemoteException
```
    Lists all of the associations for a given object.
    
    Parameters:
    
    sessionId - The current session id.
    
    objectId - The id of the object that has associations.
    
    Returns:
    
    A list of associations for the given object.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is not valid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the object does not exist or is deleted.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If you are not allowed to view the object or its associations.
    
    com.collabnet.ce.soap60.fault.SystemFault - If an unexpected error occurs.
    
    RemoteException
    
    Since:
    
    4.2
  - getAuditHistoryList
```
AuditHistorySoapList getAuditHistoryList(String sessionId,
                                         String objectId,
                                         boolean includeDerivedChanges)
                                  throws RemoteException
```
    Returns the list of changes made to the specified object in reverse chronological order. The entries returned include all updates to an object but does not include the object creation itself. NOTE: The object must be either a task or an artifact. All other object types result in a IllegalArgumentFault.
    
    Parameters:
    
    sessionId - The current session id.
    
    objectId - ID of the object.
    
    includeDerivedChanges - whether we want to get the derived entries(effort fields changed for autosummed artfs)
    
    Returns:
    
    List of changes made to the specified object.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session is not valid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the object does not exist or is deleted.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If you are not allowed to view the object or its associations.
    
    com.collabnet.ce.soap60.fault.SystemFault - If an unexpected error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the objectId is not a task or an artifact.
    
    RemoteException
    
    Since:
    
    4.1-SP3
  - getVersionInformationList
```
VersionInformationSoapList getVersionInformationList(String sessionId,
                                                     String folderId)
                                              throws RemoteException
```
    Obtains a list of versions and last modified dates for the objects residing in the specified folder.
    
    Parameters:
    
    sessionId - Soap session id
    
    folderId - Folder to obtain the list for
    
    Returns:
    
    The version information
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the folder does not exist.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when permissions are denied for the operation.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected error occurs.
    
    RemoteException
    
    Since:
    
    4.2
  - reindexObject
```
void reindexObject(String sessionId,
                   String objectId)
            throws RemoteException
```
    Re-indexes the contents of the specified project, folder, item or user. CAUTION: Use this operation sparingly. Indiscriminate use can cause system overload.
    
    Parameters:
    
    sessionId - User session ID (must be a system administrator to perform this operation)
    
    objectId - Project to re-index.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user does not have sufficient privileges (must be a system admin).
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object ID is invalid.
    
    RemoteException
    
    Since:
    
    4.1-SP3-HOTFIX9
  - getUserEffectiveMode
```
String getUserEffectiveMode(String sessionId)
                     throws RemoteException
```
    Gets effective mode (ALM or SCM) for the current user
    
    Parameters:
    
    sessionId - Session id.
    
    Returns:
    
    effective mode (ALM or SCM) for the current user
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    RemoteException
    
    Since:
    
    5.4
  - isHostedMode
```
boolean isHostedMode(String sessionId)
              throws RemoteException
```
    Verifies if the TeamForge appserver is running in Hosted Mode.
    
    Parameters:
    
    sessionId - Session id.
    
    Returns:
    
    true if the appserver is running in Hosted Mode.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    RemoteException
    
    Since:
    
    4.3
  - getProjectDiskUsage
```
long getProjectDiskUsage(String sessionId,
                         String projectId)
                  throws RemoteException
```
    Gets the filestorage disk utilization of a project specified by a project id
    
    Parameters:
    
    sessionId - the soap session key
    
    projectId - the id of the project
    
    Returns:
    
    the file storage disk usage of a project
    
    Throws:
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - thrown if the project was not found.
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - thrown if the session id is not valid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - thrown if sessionId is not a session started by an admin.
    
    com.collabnet.ce.soap60.fault.SystemFault - If there was a problem checking the permissions.
    
    RemoteException
    
    Since:
    
    4.3
  - getProjectQuota
```
long getProjectQuota(String sessionId,
                     String projectId)
              throws RemoteException
```
    Gets the disk quota for a project.
    
    Parameters:
    
    sessionId - The id of the current session.
    
    projectId - The id of the project.
    
    Returns:
    
    The disk quota for the project.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session id is not valid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the project id does not exist.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user is not allowed to view this information.
    
    com.collabnet.ce.soap60.fault.SystemFault - If there was a problem checking the permissions.
    
    RemoteException
    
    Since:
    
    4.3
  - setProjectQuota
```
void setProjectQuota(String sessionId,
                     String projectId,
                     long quota)
              throws RemoteException
```
    Sets the disk quota for a project.
    
    Parameters:
    
    sessionId - The id of the current session.
    
    projectId - The id of the project.
    
    quota - The disk quota to be set for the project.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - If the session id is not valid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - If the project id does not exist.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If the user is not allowed to view this information.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    RemoteException
    
    Since:
    
    4.3
  - getConfigurationValue
```
String getConfigurationValue(String sessionId,
                             String keyValue)
                      throws RemoteException
```
    Gets Configuration value for the passed key.
    
    Parameters:
    
    sessionId - The id of the current session.
    
    keyValue - of the configuration parameter sought for as String.(Currently supported for 'RequireAssociationOnDocumentCreate', 'RequireArtifactToBeOpenOnDocumentAssociation', 'AllowedAssociationTypeOnDocumentCreate', 'ProjectAccessEditable')
    
    Returns:
    
    The configuration value of the key requested.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    4.4-SP1
  - getProjectByPath
```
ProjectSoapDO getProjectByPath(String sessionId,
                               String projectPath)
                        throws RemoteException
```
    Gets the project data for a given project path.
    
    Parameters:
    
    sessionId - user session id
    
    projectPath - path for which the project info. is requested
    
    Returns:
    
    a ProjectSoapDO for a given project path.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    5.4
  - listUsersWithGeneralPermission
```
UserSoapList listUsersWithGeneralPermission(String sessionId,
                                            String projectId,
                                            String operationString,
                                            String folderId)
                                     throws RemoteException
```
    Returns a list of users who have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
    
    Parameters:
    
    sessionId - user session id
    
    projectId - project for which permission is checked
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    folderId - id of the folder for which permission needs to be checked.
    
    Returns:
    
    List of users who have permission on the given object for the given operation
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when session is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the objectId does not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the operationString is in an invalid format
    
    com.collabnet.ce.soap60.fault.SystemFault - any other exceptions
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have project view permission
    
    RemoteException
    
    Since:
    
    5.4
  - hasGeneralPermission
```
boolean hasGeneralPermission(String sessionId,
                             String username,
                             String projectId,
                             String operationString,
                             String objectId)
                      throws RemoteException
```
    Checks if the user has general permission for the resource (specified by objectid). The API doesn't support project group. Use hasPermission instead. Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Parameters:
    
    sessionId - User session
    
    username - user for which permission needs to be checked
    
    projectId - Project for which permission is checked
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    objectId - Object id can't be null for which permission needs to be checked.
    
    Returns:
    
    Does the user has permission on this resource for this project Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - When Session is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the objectId does not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - Illegal arguments for the operation string
    
    com.collabnet.ce.soap60.fault.SystemFault - Any other exceptions
    
    RemoteException
    
    Since:
    
    6.0
  - hasSitewideRolePermission
```
boolean hasSitewideRolePermission(String sessionId,
                                  String operationString)
                           throws RemoteException
```
    Checks if the current user has the given site wide permission to perform the operation.
    
    Parameters:
    
    sessionId - User session id
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    Returns:
    
    true if the user has the permission for the operation at Site-Wide scope, false otherwise.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the sessionId is invalid
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the operationString is in an invalid format
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs
    
    RemoteException
    
    Since:
    
    6.1.1
  - setParentProject
```
void setParentProject(String sessionId,
                      String projectId,
                      String parentProjectId)
               throws RemoteException
```
    Sets the parent of a project.
    Removes the parent, if the given parentProjectId is null or empty.
    NOTE: parentProjectId must not be same as the projectId and must not be one of the child projects. Otherwise, this will result in a IllegalArgumentFault.
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - Id of the project whose parent needs to be set.
    
    parentProjectId - Id of the project which is to be set as parent; null/empty, removes the parent.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if the parent is one of the child projects or is same as the project.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have permission to do this (only site admins can perform this operation)
    
    com.collabnet.ce.soap60.fault.ChangeParentNotAllowedFault - if the project is system project (look project).
    
    com.collabnet.ce.soap60.fault.ParentRoleUsedInChildProjectsFault - if any role of this or ancestor project is used by child of this project.
    
    com.collabnet.ce.soap60.fault.SystemFault - unexpected error
    
    RemoteException
    
    Since:
    
    6.0
  - getProjectHierarchyPaths
```
com.collabnet.ce.soap60.types.SoapNamedValues getProjectHierarchyPaths(String sessionId,
                                                                       String[] projectIds)
                                                                throws RemoteException
```
    Returns the hierarchy path of the given projects. This API doesn't accept a Project Group's id. If one or more of the project ids passed is a Project Group's id, this API throws a SystemFault.
    
    Parameters:
    
    sessionId - User session key.
    
    projectIds - An array of project Ids.
    
    Returns:
    
    A name-value pair of project hierarchy paths, project id string as name and hierarchy path string of the project as value.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs or if one of the projectIds passed is a Project Group's Id.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges on any of the given projects.
    
    RemoteException
    
    Since:
    
    6.0
  - getCurrentTime
```
long getCurrentTime(String sessionId)
             throws RemoteException
```
    Returns the current server time in milliseconds.
    
    Parameters:
    
    sessionId - user session id.
    
    Returns:
    
    the current server time in milliseconds
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    RemoteException
    
    Since:
    
    6.0
  - canReceiveOwnUpdates
```
boolean canReceiveOwnUpdates(String sessionId)
                      throws RemoteException
```
    Returns whether the current user receives notifications for the user's own updates.
    
    Parameters:
    
    sessionId - user session id.
    
    Returns:
    
    whether the user can receive notifications on own updates
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when anything unexpected happen.
    
    RemoteException
    
    Since:
    
    6.0
  - createProjectGroup
```
ProjectGroupSoapDO createProjectGroup(String sessionId,
                                      String title,
                                      String description)
                               throws RemoteException
```
    Creates a Project Group.
    
    Parameters:
    
    sessionId - User session key.
    
    title - The title of the project group
    
    description - The description of the project group
    
    Returns:
    
    The project group data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault - when the project group with that name already exists.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when invalid data was passed in
    
    RemoteException
    
    Since:
    
    6.0.1
  - addProjectsToProjectGroup
```
void addProjectsToProjectGroup(String sessionId,
                               String projectGroupId,
                               String[] projectIds)
                        throws RemoteException
```
    Adds the given projects to a project group.
    
    Parameters:
    
    sessionId - the user session id
    
    projectGroupId - the project group id
    
    projectIds - the project ids
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - when invalid data was passed in
    
    RemoteException
    
    Since:
    
    6.0.1
  - listProjectGroups
```
ProjectGroupSoapList listProjectGroups(String sessionId)
                                throws RemoteException
```
    Returns a list of all projects groups.
    
    Parameters:
    
    sessionId - User session key.
    
    Returns:
    
    List of project groups
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault
    
    RemoteException
    
    Since:
    
    6.0.1
  - getProjectGroupData
```
ProjectGroupSoapDO getProjectGroupData(String sessionId,
                                       String projectGroupId)
                                throws RemoteException
```
    Gets the Project Group Data by project group id.
    
    Parameters:
    
    sessionId - user session id
    
    projectGroupId - project group Id
    
    Returns:
    
    projectGroupSoapDO Project Group data
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    RemoteException
    
    Since:
    
    6.0.1
  - setProjectGroupData
```
void setProjectGroupData(String sessionId,
                         ProjectGroupSoapDO projectGroupData)
                  throws RemoteException
```
    Sets the project group's data with the data represented in the projectGroupData parameter. Please note that this call *does not* set the Project Group's path, even if the passed projectGroupData contains a modified value for the Project Group path.
    
    Parameters:
    
    sessionId - user session id
    
    projectGroupData - project group's ProjectGroupSoapDO
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.VersionMismatchFault - when the project group version being edited is not the latest one
    
    RemoteException
    
    Since:
    
    6.0.1
  - addProjectGroupAdmins
```
void addProjectGroupAdmins(String sessionId,
                           String projectGroupId,
                           String[] usernames)
                    throws RemoteException
```
    Makes the users given in the usernames parameter as administrators of the Project Group represented by the projectGroupId. This operation is atomic in the case of any of the usernames is invalid. Either all of the users passed in will be removed from the admin role or none will be removed. To be precise all the usernames should be valid.
    
    Parameters:
    
    sessionId - user session id
    
    projectGroupId - project group's id
    
    usernames - The username of the users that need to be made as admins for this Project Group
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid or if the projectGroupId is in fact not a Project Group's id.
    
    RemoteException
    
    Since:
    
    6.0.1
  - removeProjectGroupAdmins
```
void removeProjectGroupAdmins(String sessionId,
                              String projectGroupId,
                              String[] usernames)
                       throws RemoteException
```
    Removes the users given in the usernames parameter from the administrator role of the Project Group represented by the projectGroupId. This operation is atomic in the case of any of the usernames is invalid. Either all of the users passed in will be removed from the admin role or none will be removed. To be precise all the usernames should be valid.
    
    Parameters:
    
    sessionId - user session id
    
    projectGroupId - project group's id
    
    usernames - The username of the users that need to be made as admins for this Project Group
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    RemoteException
    
    Since:
    
    6.0.1
  - getMemberProjectsForProjectGroup
```
ProjectSoapList getMemberProjectsForProjectGroup(String sessionId,
                                                 String projectGroupId)
                                          throws RemoteException
```
    Gets the Project List for project group.
    
    Parameters:
    
    sessionId - the user session id
    
    projectGroupId - the project group id
    
    Returns:
    
    ProjectList the list of projects.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the given projectGroupId does not exist.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0.1
  - removeProjectsFromProjectGroup
```
void removeProjectsFromProjectGroup(String sessionId,
                                    String[] projectMemberIds,
                                    String projectGroupId)
                             throws RemoteException
```
    Removes projects from project group
    
    Parameters:
    
    sessionId - user session id
    
    projectMemberIds - project members in project group
    
    projectGroupId - project group id
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    RemoteException
    
    Since:
    
    6.0.1
  - removeProjectGroupMember
```
void removeProjectGroupMember(String sessionId,
                              String projectGroupId,
                              String userName)
                       throws RemoteException
```
    Removes a user from a project group.
    
    Parameters:
    
    sessionId - User session id.
    
    projectGroupId - Id of the project group.
    
    userName - Name of the new user.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.RemoveOnlyProjectAdminFault - attempting to remove last project group admin
    
    RemoteException
    
    Since:
    
    6.0.1
  - getProjectGroupMemberList
```
ProjectGroupMemberSoapList getProjectGroupMemberList(String sessionId,
                                                     String projectGroupId)
                                              throws RemoteException
```
    Returns project group membership list.
    
    Parameters:
    
    sessionId - User session id.
    
    projectGroupId - Id of the project group.
    
    Returns:
    
    Members of project group.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified object id is invalid.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0.1
  - getProjectGroupsForProject
```
ProjectGroupSoapList getProjectGroupsForProject(String sessionId,
                                                String projectId)
                                         throws RemoteException
```
    Deprecated. in favour of getProjectGroupsForProject1
    
    Gets ProjectGroupList by project
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - project id
    
    Returns:
    
    projectgroup list
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    6.0.1
  - getProjectGroupsForProject1
```
ProjectGroupSoapList getProjectGroupsForProject1(String sessionId,
                                                 String projectId)
                                          throws RemoteException
```
    Gets ProjectGroupList by project and user should have view permission
    
    Parameters:
    
    sessionId - User session id.
    
    projectId - project id
    
    Returns:
    
    list of projectgroups on which the user has access
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when the specified project id is invalid.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    8.0
  - deleteProjectGroup
```
void deleteProjectGroup(String sessionId,
                        String projectGroupId,
                        boolean forceDeleteEvenIfMemberProjectFound)
                 throws RemoteException
```
    Deletes a project group.
    
    Parameters:
    
    sessionId - User session key.
    
    projectGroupId - The id of the project group to be deleted
    
    forceDeleteEvenIfMemberProjectFound - delete the project group even if it has member project(s)
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - if we can't find the project group with the specified projectGroupId
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - when the user has insufficient privileges.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.ChildProjectsFoundFault - if the project group has any member project(s)
    
    RemoteException
    
    Since:
    
    6.0.1
  - listUsersWithPermissionOnObject
```
UserSoapList listUsersWithPermissionOnObject(String sessionId,
                                             String operationString,
                                             String objectId,
                                             int flag)
                                      throws RemoteException
```
    Returns the list of users who have the given permission on the given object.
    
    Parameters:
    
    sessionId - User session
    
    operationString - The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.
    
    objectId - The object to check permission for the users with access; It can't be null
    
    flag - either WITHOUT_SUPERUSERS or WITH_SUPERUSERS or WITH_PROJECT_MEMBERS or WITH_ASSIGNED_GROUP_MEMBERS or WITHOUT_GROUP_MEMBERS
    
    Returns:
    
    List of Users who have the given permission on the given object
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the specified session id is invalid.
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When the objectId is invalid or does not exist
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If the operationString is in an invalid format
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system level error occurs.
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have project view permission
    
    RemoteException
    
    Since:
    
    6.0.1
    
    See Also:
    
    OperationConstants, UserSoapDO.WITHOUT_SUPERUSERS, UserSoapDO.WITH_SUPERUSERS, UserSoapDO.WITH_PROJECT_MEMBERS, UserSoapDO.WITH_ASSIGNED_GROUP_MEMBERS, UserSoapDO.WITHOUT_GROUP_MEMBERS
  - getSessionId
```
String getSessionId(String oneTimeToken)
             throws RemoteException
```
    Returns current user session Id using one time token id
    
    Parameters:
    
    oneTimeToken - a one time token for login.
    
    Returns:
    
    Access token.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect.
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    5.4
  - getJSessionId
```
String getJSessionId(String oneTimeToken)
              throws RemoteException
```
    Returns current user Jsession Id using one time token id
    
    Parameters:
    
    oneTimeToken - a one time token for login.
    
    Returns:
    
    User jsession Id.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    RemoteException
    
    Since:
    
    5.4
  - getWebAndSoapSessionId
```
String getWebAndSoapSessionId(String oneTimeToken)
                       throws RemoteException
```
    Gets the web and soap session id's separated by &
    
    Parameters:
    
    oneTimeToken - a one time token for login.
    
    Returns:
    
    a string containing the web and soap session id's separated by &
    
    Throws:
    
    com.collabnet.ce.soap60.fault.SystemFault - when an unexpected system error occurs.
    
    com.collabnet.ce.soap60.fault.LoginFault - when the login information is incorrect
    
    RemoteException
    
    Since:
    
    5.4
  - getBroadCastMessage
```
String getBroadCastMessage(String sessionId)
                    throws RemoteException
```
    Gets broadcast message
    
    Parameters:
    
    sessionId - the session id.
    
    Returns:
    
    current broadcast message
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when fault occurs.
    
    RemoteException
    
    Since:
    
    6.1
  - getJSessionBySoapId
```
String getJSessionBySoapId(String soapId)
                    throws RemoteException
```
    Deprecated. instead use getJSessionId
    
    Gets the JsessionID using soap Id.
    
    Parameters:
    
    soapId - webservice soap id
    
    Returns:
    
    String jsession id
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when fault occurs.
    
    RemoteException
    
    Since:
    
    5.4
  - getUserSessionBySoapId
```
String getUserSessionBySoapId(String soapId)
                       throws RemoteException
```
    gets the access token using soap Id. This is mostly useful for external integration servers and SvnEdge based replicas.
    
    Parameters:
    
    soapId - webservice soap id
    
    Returns:
    
    the access token
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when fault occurs.
    
    RemoteException
    
    Since:
    
    6.1
  - createSiteWideLinkedApp
```
String createSiteWideLinkedApp(String sessionId,
                               String title,
                               String applicationUrl,
                               String applicationType,
                               boolean singleSignon)
                        throws RemoteException
```
    Create a site-wide linked application and return the created application Id
    
    Parameters:
    
    title - A name for the linked application, which appears on the link
    
    applicationUrl - the location url of the linked application
    
    applicationType - determines how the linked app should appear The following are the valid options: 'same' - To open the linked app in same window and it takes over the entire browser window. 'new' - To open the linked app in a new window 'iframe' - To open the linked app in a box in the same window framed by Collabnet's header
    
    singleSignon - Whether single signon should be enabled. When its enabled the authentication is managed through CollabnetTeamForge authentication system. Users are not required to log into linked app after they have logged into TeamForge. When single sign on is not enabled users will be required to log in to the linked application using its native authentication system. Only site admin users can enable this. When non site admin users attempt to enable this, it will be set to false as default.
    
    Returns:
    
    A linked application id representing the newly created application
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - When Session is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - When an attempt to retrieve the created linked app results in error
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - If any arguments is of invalid format
    
    com.collabnet.ce.soap60.fault.SystemFault - Any other exceptions, such as object already exists
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - If user does not have site admin permission
    
    RemoteException
    
    Since:
    
    7.0
  - createProjectLinkedApp
```
String createProjectLinkedApp(String sessionId,
                              String projectId,
                              String title,
                              String applicationUrl,
                              String iconKey,
                              String iconFileName,
                              String iconMimeType,
                              boolean singleSignon)
                       throws RemoteException
```
    Creates linked application in a given project and return the created application Id
    
    Parameters:
    
    sessionId - user session
    
    projectId - id of the given project
    
    title - name for the linked application, which appears on the link
    
    applicationUrl - the URL of the linked application
    
    singleSignon - indicates whether single signon should be enabled.
    
    iconKey - the key of the icon (e.g. guid9baa2613b27278f720000c58). This key can be obtained from SimpleFileStorageApp SOAP that is used to upload the icon.
    
    iconFileName - the file name of the icon (e.g. "iconFile.jpg")
    
    iconMimeType - the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.
    
    Returns:
    
    A linked application id representing the newly created application
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - whem sesion is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when an attempt to retrieve the created linked app results in error
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if any argument is invalid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have admin permission
    
    com.collabnet.ce.soap60.fault.SystemFault - any other exception
    
    RemoteException
    
    Since:
    
    8.0
  - createProjectLinkedApp2
```
String createProjectLinkedApp2(String sessionId,
                               String projectId,
                               String title,
                               String applicationUrl,
                               String iconKey,
                               String iconFileName,
                               String iconMimeType,
                               boolean singleSignon,
                               String toolId)
                        throws RemoteException
```
    Creates linked application in a given project and return the created application Id
    
    Parameters:
    
    sessionId - user session
    
    projectId - id of the given project
    
    title - name for the linked application, which appears on the link
    
    applicationUrl - the URL of the linked application
    
    singleSignon - indicates whether single signon should be enabled.
    
    iconKey - the key of the icon (e.g. guid9baa2613b27278f720000c58). This key can be obtained from SimpleFileStorageApp SOAP that is used to upload the icon.
    
    iconFileName - the file name of the icon (e.g. "iconFile.jpg")
    
    toolId - the id of tool in orchestrate
    
    iconMimeType - the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.
    
    Returns:
    
    A linked application id representing the newly created application
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - whem sesion is invalid
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault - when an attempt to retrieve the created linked app results in error
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault - if any argument is invalid
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault - if the user does not have admin permission
    
    com.collabnet.ce.soap60.fault.SystemFault - any other exception
    
    RemoteException
    
    Since:
    
    8.2
  - getLinkedApplicationData
```
LinkedApplicationSoapDO getLinkedApplicationData(String sessionId,
                                                 String linkedAppId)
                                          throws RemoteException
```
    Gets Linked Application Data by Linked Application Id
    
    Parameters:
    
    sessionId -
    
    linkedAppId -
    
    Returns:
    
    Linked Application Soap Data
    
    Throws:
    
    RemoteException
    
    Since:
    
    8.0
  - getLinkedApplicationData2
```
LinkedApplication2SoapDO getLinkedApplicationData2(String sessionId,
                                                   String linkedAppId)
                                            throws RemoteException
```
    Gets Linked Application Data by Linked Application Id
    
    Parameters:
    
    sessionId -
    
    linkedAppId -
    
    Returns:
    
    Linked Application2 Soap Data
    
    Throws:
    
    RemoteException
    
    Since:
    
    8.2
  - setLinkedApplicationData
```
void setLinkedApplicationData(String sessionId,
                              LinkedApplicationSoapDO linkedApplicationSoapDO,
                              String iconKey,
                              String iconFileName,
                              String iconMimeType)
                       throws RemoteException
```
    Sets the linked application.
    
    Parameters:
    
    sessionId - user session
    
    linkedApplicationSoapDO - the linkedApplication Data Object
    
    iconKey - the key of the icon (e.g. guid9baa2613b27278f720000c58)
    
    iconFileName - the file name of the icon (e.g. "iconFile.jpg")
    
    iconMimeType - the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.
    
    Throws:
    
    RemoteException
    
    Since:
    
    8.0
  - setLinkedApplicationData2
```
void setLinkedApplicationData2(String sessionId,
                               LinkedApplication2SoapDO linkedApplication2SoapDO,
                               String iconKey,
                               String iconFileName,
                               String iconMimeType)
                        throws RemoteException
```
    Sets the linked application.
    
    Parameters:
    
    sessionId - user session
    
    linkedApplication2SoapDO - the linkedApplication Data Object
    
    iconKey - the key of the icon (e.g. guid9baa2613b27278f720000c58)
    
    iconFileName - the file name of the icon (e.g. "iconFile.jpg")
    
    iconMimeType - the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.
    
    Throws:
    
    RemoteException
    
    Since:
    
    8.2
  - deleteLinkedApp
```
void deleteLinkedApp(String sessionId,
                     String linkedAppId)
              throws RemoteException
```
    Delete the linked application.
    
    Parameters:
    
    sessionId - the session id
    
    linkedAppId - - LinkedApplication Id which is requested to be deleted
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault
    
    com.collabnet.ce.soap60.fault.NoSuchObjectFault
    
    com.collabnet.ce.soap60.fault.IllegalArgumentFault
    
    com.collabnet.ce.soap60.fault.PermissionDeniedFault
    
    com.collabnet.ce.soap60.fault.SystemFault
    
    RemoteException
    
    Since:
    
    8.0
  - listSiteWideLinkedApps
```
LinkedApplicationSoapList listSiteWideLinkedApps(String sessionId)
                                          throws RemoteException
```
    Lists site-wide linked applications.
    
    Parameters:
    
    sessionId - user session
    
    Returns:
    
    LinkedApplicationSoapList
    
    Throws:
    
    RemoteException
  - listProjectLinkedApps
```
LinkedApplicationSoapList listProjectLinkedApps(String sessionId,
                                                String projectId)
                                         throws RemoteException
```
    Lists project-level linked applications for a given project.
    
    Parameters:
    
    sessionId - user session
    
    projectId - id of the given project
    
    Returns:
    
    LinkedapplicationSoapList
    
    Throws:
    
    RemoteException
  - listProjectLinkedApps2
```
LinkedApplication2SoapList listProjectLinkedApps2(String sessionId,
                                                  String projectId)
                                           throws RemoteException
```
    Lists project-level linked applications for a given project.
    
    Parameters:
    
    sessionId - user session
    
    projectId - id of the given project
    
    Returns:
    
    LinkedapplicationSoapList
    
    Throws:
    
    RemoteException
    
    Since:
    
    8.2
  - isSoapRedirectPostOnlyMode
```
boolean isSoapRedirectPostOnlyMode(String sessionId)
                            throws RemoteException
```
    Verifies if TeamForge is running in SoapRedirect Post-Only mode.
    
    Parameters:
    
    sessionId - Session id.
    
    Returns:
    
    true if Teamforge is running in SoapRedirect Post-Only Mode.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    RemoteException
    
    Since:
    
    7.1
  - getOneTimeToken
```
String getOneTimeToken(String sessionId)
                throws RemoteException
```
    Gives one time token for active sessionId.
    
    Parameters:
    
    sessionId - Session id.
    
    Returns:
    
    one time token.
    
    Throws:
    
    com.collabnet.ce.soap60.fault.InvalidSessionFault - when the user session ID is invalid or timed out.
    
    RemoteException
    
    Since:
    
    8.0

Interface ICollabNetSoap

Method Summary

Method Detail

getVersion

getApiVersion

keepAlive

loginAnonymous

login

loginWithToken

logoff

doMandatoryPasswordChange

changePassword

listGroupsWithGeneralPermission

hasPermission

hasPermission2

getProjectList

getProjectListForUser

getSubprojectList

createProject

createOrReplaceProjectTemplate

createProjectFromTemplate

listTemplates

findProjects

lockProject

unLockProject

getProjectData

getProjectMemberList

listProjectAdmins

getUserGroupListForProject

addProjectMember

addProjectGroupMember

removeProjectMember

createUserGroup

getUserGroupData

setUserGroupData

deleteUserGroup

getUserGroupList

getUserGroupListForUser

getUserGroupMembers

addUserGroupMember

removeUserGroupMember

createUser

getUserData

getUserData2

getUserByEmail

getUserByName

getCurrentUserData

setUserData2

setUserData

findUsers

getUserList

getUserList2

getProjectAccessLevel

setProjectAccessLevel

getCommentList

listAttachments

deleteAttachment

createAssociation

createAssociationWithTitles

changeIAObjectTitle

deleteAssociation

deleteProject

getAssociationList

getAuditHistoryList

getVersionInformationList

reindexObject

getUserEffectiveMode

isHostedMode

getProjectDiskUsage

getProjectQuota

setProjectQuota

getConfigurationValue

getProjectByPath

listUsersWithGeneralPermission

hasGeneralPermission

hasSitewideRolePermission

setParentProject

getProjectHierarchyPaths

getCurrentTime

canReceiveOwnUpdates