Package com.collabnet.ce.soap60.webservices.cemain

# Class CollabNetSoapStub

java.lang.Object
com.collabnet.ce.soap60.webservices.ClientSoapStub
com.collabnet.ce.soap60.webservices.cemain.CollabNetSoapStub

All Implemented Interfaces:
  `ICollabNetSoap`

public class CollabNetSoapStub extends ClientSoapStub implements ICollabNetSoap

- ## Field Summary

  ### Fields inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

  `DEFAULT_CLIENT_TIME_OUT`

- ## Constructor Summary

  Constructors
  Constructor
  Description
  `CollabNetSoapStub(String soapServerUrl)`

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `addProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames)`
  Makes the users given in the usernames parameter as administrators of the Project Group
  `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
  `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)`
  Gets the JsessionID using soap Id.
  `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)`
  Gets ProjectGroupList by project
  `ProjectGroupSoapList`
  `getProjectGroupsForProject1(String sessionId, String projectId)`
  Gets ProjectGroupList by project and user should have view permission
  `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
  `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, SoapFilter soapFilter)`
  Gets a list of all users on the system.
  `User2SoapList`
  `getUserList2(String sessionId, 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
  `boolean`
  `hasPermission2(String sessionId, String projectId, String operationString, String objectId)`
  Checks whether the current user has permission for an operation on a specified object
  `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)`
  This operation is no longer supported.
  `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
  `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.
  `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
  `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.

  ### Methods inherited from class com.collabnet.ce.soap60.webservices.ClientSoapStub

  `getServiceCall, getSoapServer, getTimeout, setTimeout, soapParam`

  ### Methods inherited from class java.lang.Object

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

- ## Constructor Details

  - ### CollabNetSoapStub

    public CollabNetSoapStub(String soapServerUrl)

- ## Method Details

  - ### getVersion

    public String getVersion(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets TeamForge version.
    Specified by:
      `getVersion` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the session id.
    Returns:
      Version as string.
    Throws:
      `RemoteException`

  - ### getApiVersion

    public String getApiVersion() throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets TeamForge API version.
    Specified by:
      `getApiVersion` in interface `ICollabNetSoap`
    Returns:
      API version as string.
    Throws:
      `RemoteException`

  - ### keepAlive

    public void keepAlive(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    This operation is no longer supported. If token is timed out, acquire new access token by logging in again.
    Specified by:
      `keepAlive` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the session id.
    Throws:
      `RemoteException`

  - ### loginAnonymous

    public String loginAnonymous(String anonSharedSecret) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    This method allows to login as anonymous to get TF default access.
    Specified by:
      `loginAnonymous` in interface `ICollabNetSoap`
    Parameters:
      `anonSharedSecret` - Shared secret for anonymous login.
    Returns:
      Access token.
    Throws:
      `RemoteException`

  - ### login

    public String login(String userName, String password) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Logs in a user and creates a new session.
    Specified by:
      `login` in interface `ICollabNetSoap`
    Parameters:
      `userName` - Name of the user.
      `password` - User password.
    Returns:
      Access token.
    Throws:
      `RemoteException`

  - ### loginWithToken

    public String loginWithToken(String username, String oneTimeToken) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Logs in a user and creates a new session.
    Specified by:
      `loginWithToken` in interface `ICollabNetSoap`
    Parameters:
      `username` - Name of the user.
      `oneTimeToken` - a one time token for login.
    Returns:
      Access token.
    Throws:
      `RemoteException`

  - ### logoff

    public void logoff(String userName, String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Ends a user's session, but the token can still be used until it expires.
    Specified by:
      `logoff` in interface `ICollabNetSoap`
    Parameters:
      `userName` - User's name.
      `sessionId` - Session id.
    Throws:
      `RemoteException`

  - ### doMandatoryPasswordChange

    public String doMandatoryPasswordChange(String userName, String oldPassword, String newPassword) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Allows user to change the password if and only if the password was set by an administrator.
    Specified by:
      `doMandatoryPasswordChange` in interface `ICollabNetSoap`
    Parameters:
      `userName` - login name
      `oldPassword` - current password
      `newPassword` - new password
    Returns:
      User session key.
    Throws:
      `RemoteException`

  - ### changePassword

    public boolean changePassword(String sessionId, String userName, String newPassword) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Allows the user to change the password
    Specified by:
      `changePassword` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key
      `userName` - login name
      `newPassword` - new password
    Returns:
      true if the password has been successfully changed
    Throws:
      `RemoteException`

  - ### listGroupsWithGeneralPermission

    public UserGroupSoapList listGroupsWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId, boolean includeInherited) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    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)
    Specified by:
      `listGroupsWithGeneralPermission` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - The current user session id
      `projectId` - Project for which permission is checked
      `operationString` - The string representation of the operation.
      `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:
      `RemoteException`

  - ### hasPermission

    public boolean hasPermission(String sessionId, String username, String projectId, String operationString, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Checks whether the given user has permission for an operation on a specified object
    Specified by:
      `hasPermission` in interface `ICollabNetSoap`
    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.
      `objectId` - the object for which we are doing the permission check.
    Returns:
      whether the given user has permission for an operation on a specified object
    Throws:
      `RemoteException`
    See Also:
      - `OperationConstants`

  - ### hasPermission2

    public boolean hasPermission2(String sessionId, String projectId, String operationString, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Checks whether the current user has permission for an operation on a specified object
    Specified by:
      `hasPermission2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the current user session id
      `projectId` - the project in which the operation is defined
      `operationString` - The string representation of the operation.
      `objectId` - the object for which we are doing the permission check.
    Returns:
      whether the current user has permission for an operation on a specified object
    Throws:
      `RemoteException`
    See Also:
      - `OperationConstants`

  - ### getProjectList

    public ProjectSoapList getProjectList(String sessionId, boolean fetchHierarchyPath) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of all projects visible to the user.
    Specified by:
      `getProjectList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `fetchHierarchyPath` - flag indicating whether to fetch the hierarchy path for each project
    Returns:
      List of projects
    Throws:
      `RemoteException`

  - ### getProjectListForUser

    public ProjectSoapList getProjectListForUser(String sessionId, String username, boolean fetchHierarchyPath, boolean includeGroupMembership) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of projects
    Specified by:
      `getProjectListForUser` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getSubprojectList

    public ProjectSoapList getSubprojectList(String sessionId, String projectId, boolean fetchHierarchyPath) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of the immediate sub projects of a project.
    Specified by:
      `getSubprojectList` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### createProject

    public ProjectSoapDO createProject(String sessionId, String name, String title, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates a project.
    Specified by:
      `createProject` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### createOrReplaceProjectTemplate

    public ProjectSoapDO createOrReplaceProjectTemplate(String sessionId, String projectId, String title, String description, String[] contentChoices, String templateId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates or replaces a template from an existing project
    Specified by:
      `createOrReplaceProjectTemplate` in interface `ICollabNetSoap`
    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:
      `RemoteException`
    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_TRACKER_CONTENT`
      - `ProjectSoapDO.INCLUDE_WIKI_CONTENT`
      - `ProjectSoapDO.INCLUDE_TEAMS`
      - `(Supported from 17.8)`
      - `(Supported from 17.8)`

  - ### createProjectFromTemplate

    public ProjectSoapDO createProjectFromTemplate(String sessionId, String templateId, String name, String title, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates a project from template.
    Specified by:
      `createProjectFromTemplate` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### listTemplates

    public ProjectSoapList listTemplates(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists project templates within the installation.
    Specified by:
      `listTemplates` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
    Returns:
      The list of template projects
    Throws:
      `RemoteException`

  - ### findProjects

    public ProjectSoapList findProjects(String sessionId, String queryString) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Finds a list of projects matching a search string.
    Specified by:
      `findProjects` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `queryString` - Query string.
    Returns:
      List of projects matching search criteria.
    Throws:
      `RemoteException`

  - ### lockProject

    public ProjectSoapDO lockProject(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Locks project. Thus making all the tools and their data read-only.
    Specified by:
      `lockProject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `projectId` - Project id.
    Returns:
      Project data.
    Throws:
      `RemoteException`

  - ### unLockProject

    public ProjectSoapDO unLockProject(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Un-Locks project. Restoring to the normal state where the objects are editable.
    Specified by:
      `unLockProject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `projectId` - Project id.
    Returns:
      Project data.
    Throws:
      `RemoteException`

  - ### getProjectData

    public ProjectSoapDO getProjectData(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a project object which includes the parent project ID, project hierarchy path and locked status flag.
    Specified by:
      `getProjectData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `projectId` - Project id.
    Returns:
      Project data.
    Throws:
      `RemoteException`

  - ### getProjectMemberList

    public ProjectMemberSoapList getProjectMemberList(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns project membership list.
    Specified by:
      `getProjectMemberList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Id of the project.
    Returns:
      Members of project.
    Throws:
      `RemoteException`

  - ### listProjectAdmins

    public UserSoapList listProjectAdmins(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns project administrators list.
    Specified by:
      `listProjectAdmins` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Id of the project.
    Returns:
      Administrators of the project.
    Throws:
      `RemoteException`

  - ### getUserGroupListForProject

    public UserGroupSoapList getUserGroupListForProject(String sessionId, String projectOrProjectGroupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of user groups that have a role in the project.
    Specified by:
      `getUserGroupListForProject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectOrProjectGroupId` - Project/ProjectGroup Id.
    Returns:
      UserGroups who have a role in the project.
    Throws:
      `RemoteException`

  - ### addProjectMember

    public void addProjectMember(String sessionId, String projectId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Makes a user a member of a project.
    Specified by:
      `addProjectMember` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Id project Id.
      `userName` - Name of the new user.
    Throws:
      `RemoteException`

  - ### addProjectGroupMember

    public void addProjectGroupMember(String sessionId, String projectGroupId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Makes a user a member of a project group.
    Specified by:
      `addProjectGroupMember` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectGroupId` - ProjectGroup id.
      `userName` - Name of the new user.
    Throws:
      `RemoteException`

  - ### removeProjectMember

    public void removeProjectMember(String sessionId, String projectId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Removes a user from a project.
    Specified by:
      `removeProjectMember` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - Id of the project.
      `userName` - Name of the new user.
    Throws:
      `RemoteException`

  - ### createUserGroup

    public UserGroupSoapDO createUserGroup(String sessionId, String fullName, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates a new user group with the specified parameters.
    Specified by:
      `createUserGroup` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getUserGroupData

    public UserGroupSoapDO getUserGroupData(String sessionId, String groupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the user group information.
    Specified by:
      `getUserGroupData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User's session id.
      `groupId` - User Group id.
    Returns:
      User Group data.
    Throws:
      `RemoteException`

  - ### setUserGroupData

    public void setUserGroupData(String sessionId, UserGroupSoapDO groupData) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the user group information.
    Specified by:
      `setUserGroupData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User's session id.
      `groupData` - User Group data.
    Throws:
      `RemoteException`

  - ### deleteUserGroup

    public void deleteUserGroup(String sessionId, String groupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Deletes a user group.
    Specified by:
      `deleteUserGroup` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `groupId` - The id of the user group to be deleted
    Throws:
      `RemoteException`

  - ### getUserGroupList

    public UserGroupSoapList getUserGroupList(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a list of all user groups on the system.
    Specified by:
      `getUserGroupList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
    Returns:
      List of user groups matching a filter.
    Throws:
      `RemoteException`

  - ### getUserGroupListForUser

    public UserGroupSoapList getUserGroupListForUser(String sessionId, String username) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a list of all user groups the user belongs.
    Specified by:
      `getUserGroupListForUser` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `username` - the name of the user
    Returns:
      List of user groups the user belongs.
    Throws:
      `RemoteException`

  - ### getUserGroupMembers

    public UserSoapList getUserGroupMembers(String sessionId, String groupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a list of active users who are members of a user group
    Specified by:
      `getUserGroupMembers` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `groupId` - the user group id
    Returns:
      List of members of a user group
    Throws:
      `RemoteException`

  - ### addUserGroupMember

    public void addUserGroupMember(String sessionId, String userGroupId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Adds a user to a user group. The user and user group must be existing already.
    Specified by:
      `addUserGroupMember` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### removeUserGroupMember

    public void removeUserGroupMember(String sessionId, String userGroupId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Removes a user from a user group.
    Specified by:
      `removeUserGroupMember` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `userGroupId` - User Group from which the user should be removed.
      `userName` - User to be removed.
    Throws:
      `RemoteException`

  - ### createUser

    public 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
    Description copied from interface: `ICollabNetSoap`
    Creates a new user with the specified parameters.
    Specified by:
      `createUser` in interface `ICollabNetSoap`
    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.
      `licenseType` - User's license type. Multiple license types can be given for a user as ALM
      `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:
      `RemoteException`

  - ### getUserData

    public UserSoapDO getUserData(String sessionId, String username) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the user details for the given username.
    Specified by:
      `getUserData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `username` - User name (login name)
    Returns:
      User data.
    Throws:
      `RemoteException`

  - ### getUserData2

    public User2SoapDO getUserData2(String sessionId, String username) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the user details for the given username.
    Specified by:
      `getUserData2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `username` - User name (login name)
    Returns:
      User data which includes user's profile picture link.
    Throws:
      `RemoteException`

  - ### getUserByEmail

    public UserSoapDO getUserByEmail(String sessionId, String email) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the user information for the given email address.
    Specified by:
      `getUserByEmail` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `email` - the email address of a registered user
    Returns:
      User data.
    Throws:
      `RemoteException`

  - ### getUserByName

    public UserSoapDO getUserByName(String sessionId, String fullname) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the user information for the given full name.
    Specified by:
      `getUserByName` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `fullname` - the full name of a user
    Returns:
      User data.
    Throws:
      `RemoteException`

  - ### getCurrentUserData

    public UserSoapDO getCurrentUserData(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the user details for a given user session id.
    Specified by:
      `getCurrentUserData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
    Returns:
      a UserSoapDO for a given user session id.
    Throws:
      `RemoteException`

  - ### setUserData2

    public void setUserData2(String sessionId, User2SoapDO userData) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the user information.
    Specified by:
      `setUserData2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `userData` - User data which includes user's profile picture link.
    Throws:
      `RemoteException`

  - ### setUserData

    public void setUserData(String sessionId, UserSoapDO userData) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the user information. NOTE: Only super-users are allowed to set user data.
    Specified by:
      `setUserData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `userData` - User data
    Throws:
      `RemoteException`

  - ### findUsers

    public UserSoapList findUsers(String sessionId, String queryString) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Finds a list of users matching a search string.
    Specified by:
      `findUsers` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `queryString` - Query string.
    Returns:
      List of users matching search criteria.
    Throws:
      `RemoteException`

  - ### getUserList

    public UserSoapList getUserList(String sessionId, SoapFilter soapFilter) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a list of all users on the system.
    Specified by:
      `getUserList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `soapFilter` - Search filter. See UserSoapDO.FILTER constants for supported filter names.
    Returns:
      List of users matching a filter.
    Throws:
      `RemoteException`

  - ### getUserList2

    public User2SoapList getUserList2(String sessionId, SoapFilter soapFilter) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets a list of all users on the system.
    Specified by:
      `getUserList2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `soapFilter` - Search filter. See UserSoapDO.FILTER constants for supported filter names.
    Returns:
      List of users matching a filter.
    Throws:
      `RemoteException`

  - ### getProjectAccessLevel

    public int getProjectAccessLevel(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the project's access level.
    Specified by:
      `getProjectAccessLevel` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session Id
      `projectId` - The project Id
    Returns:
      The project access level.
    Throws:
      `RemoteException`
    See Also:
      - `ProjectSoapDO.PUBLIC`
      - `ProjectSoapDO.GATED_COMMUNITY`
      - `ProjectSoapDO.PRIVATE`

  - ### setProjectAccessLevel

    public void setProjectAccessLevel(String sessionId, String projectId, int accessLevel) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the project access level.
    Specified by:
      `setProjectAccessLevel` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session Id
      `projectId` - The project Id
      `accessLevel` - The access level to set the project to
    Throws:
      `RemoteException`
    See Also:
      - `ICollabNetSoap.getConfigurationValue(String, String)`

  - ### getCommentList

    public CommentSoapList getCommentList(String sessionId, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets list of comments for object.
    Specified by:
      `getCommentList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `objectId` - Object id.
    Returns:
      List of comments.
    Throws:
      `RemoteException`

  - ### listAttachments

    public AttachmentSoapList listAttachments(String sessionId, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists the attachments associated with the object, the attachment itself is not part of the returned object.
    Specified by:
      `listAttachments` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### deleteAttachment

    public void deleteAttachment(String sessionId, String objectId, String attachmentId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Deletes the specified attachment of the specified object.
    Specified by:
      `deleteAttachment` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `objectId` - The id of the object from which attachment has to be deleted.
      `attachmentId` - The attachment id.
    Throws:
      `RemoteException`

  - ### createAssociation

    public void createAssociation(String sessionId, String originId, String targetId, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates an association between two objects.
    Specified by:
      `createAssociation` in interface `ICollabNetSoap`
    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
      `description` - the description for the association
    Throws:
      `RemoteException`

  - ### createAssociationWithTitles

    public void createAssociationWithTitles(String sessionId, String originId, String originTitle, String targetId, String targetTitle, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates an association between two objects with specified title.
    Specified by:
      `createAssociationWithTitles` in interface `ICollabNetSoap`
    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
      `description` - the description for the association
    Throws:
      `RemoteException`

  - ### changeIAObjectTitle

    public void changeIAObjectTitle(String sessionId, String pluggableObjectId, String pluggableObjectTitle) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Updates the title for Pluggable objects only.
    Specified by:
      `changeIAObjectTitle` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `pluggableObjectId` - The pluggable app object id
      `pluggableObjectTitle` - the pluggable object's title
    Throws:
      `RemoteException`

  - ### deleteAssociation

    public void deleteAssociation(String sessionId, String originId, String targetId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Deletes an association between two objects
    Specified by:
      `deleteAssociation` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### deleteProject

    public void deleteProject(String sessionId, String projectId, boolean noNotification, boolean forceDeleteEvenIfChildFound) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Deletes a project.
    Specified by:
      `deleteProject` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getAssociationList

    public AssociationSoapList getAssociationList(String sessionId, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists all of the associations for a given object.
    Specified by:
      `getAssociationList` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getAuditHistoryList

    public AuditHistorySoapList getAuditHistoryList(String sessionId, String objectId, boolean includeDerivedChanges) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the list of changes made to the specified object in reverse chronological order.
    Specified by:
      `getAuditHistoryList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - The current session id.
      `objectId` - ID of the object.
      `includeDerivedChanges` - whether we want to get the derived entries
    Returns:
      List of changes made to the specified object.
    Throws:
      `RemoteException`

  - ### getVersionInformationList

    public VersionInformationSoapList getVersionInformationList(String sessionId, String folderId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Obtains a list of versions and last modified dates for the objects residing in the specified folder.
    Specified by:
      `getVersionInformationList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - Soap session id
      `folderId` - Folder to obtain the list for
    Returns:
      The version information
    Throws:
      `RemoteException`

  - ### reindexObject

    public void reindexObject(String sessionId, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Re-indexes the contents of the specified project, folder, item or user.
    Specified by:
      `reindexObject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session ID (must be a system administrator to perform this operation)
      `objectId` - Project to re-index.
    Throws:
      `RemoteException`

  - ### getUserEffectiveMode

    public String getUserEffectiveMode(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets effective mode (ALM or SCM) for the current user
    Specified by:
      `getUserEffectiveMode` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - Session id.
    Returns:
      effective mode (ALM or SCM) for the current user
    Throws:
      `RemoteException`

  - ### isHostedMode

    public boolean isHostedMode(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Verifies if the TeamForge appserver is running in Hosted Mode.
    Specified by:
      `isHostedMode` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - Session id.
    Returns:
      true if the appserver is running in Hosted Mode.
    Throws:
      `RemoteException`

  - ### getProjectDiskUsage

    public long getProjectDiskUsage(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the filestorage disk utilization of a project specified by a project id
    Specified by:
      `getProjectDiskUsage` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the soap session key
      `projectId` - the id of the project
    Returns:
      the file storage disk usage of a project
    Throws:
      `RemoteException`

  - ### getProjectQuota

    public long getProjectQuota(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the disk quota for a project.
    Specified by:
      `getProjectQuota` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - The id of the current session.
      `projectId` - The id of the project.
    Returns:
      The disk quota for the project.
    Throws:
      `RemoteException`

  - ### setProjectQuota

    public void setProjectQuota(String sessionId, String projectId, long quota) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the disk quota for a project.
    Specified by:
      `setProjectQuota` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getConfigurationValue

    public String getConfigurationValue(String sessionId, String keyValue) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets Configuration value for the passed key.
    Specified by:
      `getConfigurationValue` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - The id of the current session.
      `keyValue` - of the configuration parameter sought for as String.
    Returns:
      The configuration value of the key requested.
    Throws:
      `RemoteException`

  - ### getProjectByPath

    public ProjectSoapDO getProjectByPath(String sessionId, String projectPath) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the project data for a given project path.
    Specified by:
      `getProjectByPath` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
      `projectPath` - path for which the project info. is requested
    Returns:
      a ProjectSoapDO for a given project path.
    Throws:
      `RemoteException`

  - ### listUsersWithGeneralPermission

    public UserSoapList listUsersWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of users who have some permission to perform the given operation
    Specified by:
      `listUsersWithGeneralPermission` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
      `projectId` - project for which permission is checked
      `operationString` - The string representation of the operation.
      `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:
      `RemoteException`

  - ### hasGeneralPermission

    public boolean hasGeneralPermission(String sessionId, String username, String projectId, String operationString, String objectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Checks if the user has general permission for the resource (specified by objectid).
    Specified by:
      `hasGeneralPermission` in interface `ICollabNetSoap`
    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.
      `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
    Throws:
      `RemoteException`

  - ### hasSitewideRolePermission

    public boolean hasSitewideRolePermission(String sessionId, String operationString) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Checks if the current user has the given site wide permission to perform the operation.
    Specified by:
      `hasSitewideRolePermission` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id
      `operationString` - The string representation of the operation.
    Returns:
      true if the user has the permission for the operation at Site-Wide scope, false otherwise.
    Throws:
      `RemoteException`

  - ### setParentProject

    public void setParentProject(String sessionId, String projectId, String parentProjectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the parent of a project.
    Removes the parent, if the given parentProjectId is null or empty.
    Specified by:
      `setParentProject` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getProjectHierarchyPaths

    public SoapNamedValues getProjectHierarchyPaths(String sessionId, String[] projectIds) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the hierarchy path of the given projects.
    Specified by:
      `getProjectHierarchyPaths` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
      `projectIds` - An array of project Ids.
    Returns:
      A name-value pair of project hierarchy paths
    Throws:
      `RemoteException`

  - ### getCurrentTime

    public long getCurrentTime(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the current server time in milliseconds.
    Specified by:
      `getCurrentTime` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id.
    Returns:
      the current server time in milliseconds
    Throws:
      `RemoteException`

  - ### canReceiveOwnUpdates

    public boolean canReceiveOwnUpdates(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns whether the current user receives notifications for the user's own updates.
    Specified by:
      `canReceiveOwnUpdates` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id.
    Returns:
      whether the user can receive notifications on own updates
    Throws:
      `RemoteException`

  - ### createProjectGroup

    public ProjectGroupSoapDO createProjectGroup(String sessionId, String title, String description) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates a Project Group.
    Specified by:
      `createProjectGroup` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### addProjectsToProjectGroup

    public void addProjectsToProjectGroup(String sessionId, String projectGroupId, String[] projectIds) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Adds the given projects to a project group.
    Specified by:
      `addProjectsToProjectGroup` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the user session id
      `projectGroupId` - the project group id
      `projectIds` - the project ids
    Throws:
      `RemoteException`

  - ### listProjectGroups

    public ProjectGroupSoapList listProjectGroups(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns a list of all projects groups.
    Specified by:
      `listProjectGroups` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session key.
    Returns:
      List of project groups
    Throws:
      `RemoteException`

  - ### getProjectGroupData

    public ProjectGroupSoapDO getProjectGroupData(String sessionId, String projectGroupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the Project Group Data by project group id.
    Specified by:
      `getProjectGroupData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
      `projectGroupId` - project group Id
    Returns:
      projectGroupSoapDO Project Group data
    Throws:
      `RemoteException`

  - ### setProjectGroupData

    public void setProjectGroupData(String sessionId, ProjectGroupSoapDO projectGroupData) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the project group's data with the data represented in the projectGroupData parameter.
    Specified by:
      `setProjectGroupData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
      `projectGroupData` - project group's ProjectGroupSoapDO
    Throws:
      `RemoteException`

  - ### addProjectGroupAdmins

    public void addProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Makes the users given in the usernames parameter as administrators of the Project Group
    Specified by:
      `addProjectGroupAdmins` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### removeProjectGroupAdmins

    public void removeProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Removes the users given in the usernames parameter from the administrator role of the Project Group
    Specified by:
      `removeProjectGroupAdmins` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### getMemberProjectsForProjectGroup

    public ProjectSoapList getMemberProjectsForProjectGroup(String sessionId, String projectGroupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the Project List for project group.
    Specified by:
      `getMemberProjectsForProjectGroup` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the user session id
      `projectGroupId` - the project group id
    Returns:
      ProjectList the list of projects.
    Throws:
      `RemoteException`

  - ### removeProjectsFromProjectGroup

    public void removeProjectsFromProjectGroup(String sessionId, String[] projectMemberIds, String projectGroupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Removes projects from project group
    Specified by:
      `removeProjectsFromProjectGroup` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session id
      `projectMemberIds` - project members in project group
      `projectGroupId` - project group id
    Throws:
      `RemoteException`

  - ### removeProjectGroupMember

    public void removeProjectGroupMember(String sessionId, String projectGroupId, String userName) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Removes a user from a project group.
    Specified by:
      `removeProjectGroupMember` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectGroupId` - Id of the project group.
      `userName` - Name of the new user.
    Throws:
      `RemoteException`

  - ### getProjectGroupMemberList

    public ProjectGroupMemberSoapList getProjectGroupMemberList(String sessionId, String projectGroupId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns project group membership list.
    Specified by:
      `getProjectGroupMemberList` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectGroupId` - Id of the project group.
    Returns:
      Members of project group.
    Throws:
      `RemoteException`

  - ### getProjectGroupsForProject

    public ProjectGroupSoapList getProjectGroupsForProject(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets ProjectGroupList by project
    Specified by:
      `getProjectGroupsForProject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - project id
    Returns:
      projectgroup list
    Throws:
      `RemoteException`

  - ### getProjectGroupsForProject1

    public ProjectGroupSoapList getProjectGroupsForProject1(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets ProjectGroupList by project and user should have view permission
    Specified by:
      `getProjectGroupsForProject1` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session id.
      `projectId` - project id
    Returns:
      list of projectgroups on which the user has access
    Throws:
      `RemoteException`

  - ### deleteProjectGroup

    public void deleteProjectGroup(String sessionId, String projectGroupId, boolean forceDeleteEvenIfMemberProjectFound) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Deletes a project group.
    Specified by:
      `deleteProjectGroup` in interface `ICollabNetSoap`
    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:
      `RemoteException`

  - ### listUsersWithPermissionOnObject

    public UserSoapList listUsersWithPermissionOnObject(String sessionId, String operationString, String objectId, int flag) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns the list of users who have the given permission on the given object.
    Specified by:
      `listUsersWithPermissionOnObject` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - User session
      `operationString` - The string representation of the operation.
      `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:
      `RemoteException`
    See Also:
      - `OperationConstants`
      - `UserSoapDO.WITHOUT_SUPERUSERS`
      - `UserSoapDO.WITH_SUPERUSERS`
      - `UserSoapDO.WITH_PROJECT_MEMBERS`
      - `UserSoapDO.WITH_ASSIGNED_GROUP_MEMBERS`
      - `UserSoapDO.WITHOUT_GROUP_MEMBERS`

  - ### getSessionId

    public String getSessionId(String oneTimeToken) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns current user session Id using one time token id
    Specified by:
      `getSessionId` in interface `ICollabNetSoap`
    Parameters:
      `oneTimeToken` - a one time token for login.
    Returns:
      Access token.
    Throws:
      `RemoteException`

  - ### getJSessionId

    public String getJSessionId(String oneTimeToken) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Returns current user Jsession Id using one time token id
    Specified by:
      `getJSessionId` in interface `ICollabNetSoap`
    Parameters:
      `oneTimeToken` - a one time token for login.
    Returns:
      User jsession Id.
    Throws:
      `RemoteException`

  - ### getWebAndSoapSessionId

    public String getWebAndSoapSessionId(String oneTimeToken) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the web and soap session id's separated by &
    Specified by:
      `getWebAndSoapSessionId` in interface `ICollabNetSoap`
    Parameters:
      `oneTimeToken` - a one time token for login.
    Returns:
      a string containing the web and soap session id's separated by &
    Throws:
      `RemoteException`

  - ### getBroadCastMessage

    public String getBroadCastMessage(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets broadcast message
    Specified by:
      `getBroadCastMessage` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the session id.
    Returns:
      current broadcast message
    Throws:
      `RemoteException`

  - ### getJSessionBySoapId

    public String getJSessionBySoapId(String soapId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets the JsessionID using soap Id.
    Specified by:
      `getJSessionBySoapId` in interface `ICollabNetSoap`
    Parameters:
      `soapId` - webservice soap id
    Returns:
      String jsession id
    Throws:
      `RemoteException`

  - ### getUserSessionBySoapId

    public String getUserSessionBySoapId(String soapId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    gets the access token using soap Id.
    Specified by:
      `getUserSessionBySoapId` in interface `ICollabNetSoap`
    Parameters:
      `soapId` - webservice soap id
    Returns:
      the access token
    Throws:
      `RemoteException`

  - ### createSiteWideLinkedApp

    public String createSiteWideLinkedApp(String sessionId, String title, String applicationUrl, String applicationType, boolean singleSignon) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Create a site-wide linked application and return the created application Id
    Specified by:
      `createSiteWideLinkedApp` in interface `ICollabNetSoap`
    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
      `singleSignon` - Whether single signon should be enabled.
    Returns:
      A linked application id representing the newly created application
    Throws:
      `RemoteException`

  - ### createProjectLinkedApp

    public String createProjectLinkedApp(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates linked application in a given project and return the created application Id
    Specified by:
      `createProjectLinkedApp` in interface `ICollabNetSoap`
    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
      `iconKey` - the key of 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.
      `singleSignon` - indicates whether single signon should be enabled.
    Returns:
      A linked application id representing the newly created application
    Throws:
      `RemoteException`

  - ### createProjectLinkedApp2

    public String createProjectLinkedApp2(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon, String toolId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Creates linked application in a given project and return the created application Id
    Specified by:
      `createProjectLinkedApp2` in interface `ICollabNetSoap`
    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
      `iconKey` - the key of 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.
      `singleSignon` - indicates whether single signon should be enabled.
      `toolId` - the id of tool in orchestrate
    Returns:
      A linked application id representing the newly created application
    Throws:
      `RemoteException`

  - ### getLinkedApplicationData

    public LinkedApplicationSoapDO getLinkedApplicationData(String sessionId, String linkedAppId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets Linked Application Data by Linked Application Id
    Specified by:
      `getLinkedApplicationData` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` -
      `linkedAppId` -
    Returns:
      Linked Application Soap Data
    Throws:
      `RemoteException`

  - ### getLinkedApplicationData2

    public LinkedApplication2SoapDO getLinkedApplicationData2(String sessionId, String linkedAppId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gets Linked Application Data by Linked Application Id
    Specified by:
      `getLinkedApplicationData2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` -
      `linkedAppId` -
    Returns:
      Linked Application2 Soap Data
    Throws:
      `RemoteException`

  - ### setLinkedApplicationData

    public void setLinkedApplicationData(String sessionId, LinkedApplicationSoapDO linkedApplicationSoapDO, String iconKey, String iconFileName, String iconMimeType) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the linked application.
    Specified by:
      `setLinkedApplicationData` in interface `ICollabNetSoap`
    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`

  - ### setLinkedApplicationData2

    public void setLinkedApplicationData2(String sessionId, LinkedApplication2SoapDO linkedApplication2SoapDO, String iconKey, String iconFileName, String iconMimeType) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Sets the linked application.
    Specified by:
      `setLinkedApplicationData2` in interface `ICollabNetSoap`
    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`

  - ### deleteLinkedApp

    public void deleteLinkedApp(String sessionId, String linkedAppId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Delete the linked application.
    Specified by:
      `deleteLinkedApp` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - the session id
      `linkedAppId` - - LinkedApplication Id which is requested to be deleted
    Throws:
      `RemoteException`

  - ### listSiteWideLinkedApps

    public LinkedApplicationSoapList listSiteWideLinkedApps(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists site-wide linked applications.
    Specified by:
      `listSiteWideLinkedApps` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session
    Returns:
      LinkedApplicationSoapList
    Throws:
      `RemoteException`

  - ### listProjectLinkedApps

    public LinkedApplicationSoapList listProjectLinkedApps(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists project-level linked applications for a given project.
    Specified by:
      `listProjectLinkedApps` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session
      `projectId` - id of the given project
    Returns:
      LinkedapplicationSoapList
    Throws:
      `RemoteException`

  - ### listProjectLinkedApps2

    public LinkedApplication2SoapList listProjectLinkedApps2(String sessionId, String projectId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Lists project-level linked applications for a given project.
    Specified by:
      `listProjectLinkedApps2` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - user session
      `projectId` - id of the given project
    Returns:
      LinkedapplicationSoapList
    Throws:
      `RemoteException`

  - ### isSoapRedirectPostOnlyMode

    public boolean isSoapRedirectPostOnlyMode(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Verifies if TeamForge is running in SoapRedirect Post-Only mode.
    Specified by:
      `isSoapRedirectPostOnlyMode` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - Session id.
    Returns:
      true if Teamforge is running in SoapRedirect Post-Only Mode.
    Throws:
      `RemoteException`

  - ### getOneTimeToken

    public String getOneTimeToken(String sessionId) throws RemoteException
    Description copied from interface: `ICollabNetSoap`
    Gives one time token for active sessionId.
    Specified by:
      `getOneTimeToken` in interface `ICollabNetSoap`
    Parameters:
      `sessionId` - Session id.
    Returns:
      one time token.
    Throws:
      `RemoteException`