CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.remoting
Interface RemoteApi

All Superinterfaces:
java.rmi.Remote

public interface RemoteApi
extends java.rmi.Remote

Defines the CodeBeamer RemoteService API. Please note: All methods throw an IllegalStateException if no RemoteSession is active or has expired


Method Summary
 void addUserToRole(java.lang.String token, java.lang.Integer userId, java.lang.Integer projectId, java.lang.Integer roleId)
          Adds the user to an existing portal-scope or project-scope role.
 ArtifactDto createAndUploadArtifact(java.lang.String token, ArtifactDto artifact, byte[] data, java.lang.String comment, java.lang.String commentFormat)
          Creates a new file-type artifact and initializes its binary content.
 ArtifactDto createArtifact(java.lang.String token, ArtifactDto artifact)
          Creates a new artifact.
 ArtifactCommentDto createArtifactComment(java.lang.String token, ArtifactCommentDto comment)
          Creates a new artifact comment.
 AssociationDto createAssociation(java.lang.String token, AssociationDto association)
          Creates a new association.
 BuildDto createBuild(java.lang.String token, BuildDto build)
          Creates a new build.
 ForumDto createForum(java.lang.String token, ForumDto forum)
          Creates a new forum.
 ForumDto createForumFromTemplate(java.lang.String token, ForumDto forum, java.lang.Integer templateForumId)
          Creates a new forum based on another forum as template.
 ForumPostDto createForumPost(java.lang.String token, ForumPostDto post)
          Creates a new forum post.
 LabelDto createLabel(java.lang.String token, LabelDto label)
          Creates a new label.
 ProjectDto createProject(java.lang.String token, ProjectDto project)
          Creates a new project.
 ProjectDto createProjectFromTemplate(java.lang.String token, ProjectDto project, java.lang.Integer templateProjectId)
          Creates a new project from template.
 TrackerDto createTracker(java.lang.String token, TrackerDto tracker)
          Creates a new tracker.
 TrackerDto createTrackerFromTemplate(java.lang.String token, TrackerDto tracker, java.lang.Integer templateTrackerId)
          Creates a new tracker based on another tracker as template.
 TrackerItemDto createTrackerItem(java.lang.String token, TrackerItemDto item)
          Creates a new tracker item.
 TrackerItemAttachmentDto createTrackerItemAttachment(java.lang.String token, TrackerItemAttachmentDto attachment)
          Creates a new tracker item attachment.
 TrackerItemCommentDto createTrackerItemComment(java.lang.String token, TrackerItemCommentDto comment)
          Creates a new tracker item comment.
 void createTrackerItemHistory(java.lang.String token, TrackerItemHistoryEntryDto[] history)
          Creates a batch of tracker item history entries at once
 void createTrackerItemHistoryEntry(java.lang.String token, TrackerItemHistoryEntryDto historyEntry)
          Creates a tracker item history entry.
 UserDto createUser(java.lang.String token, UserDto user)
          Creates a new user account.
 WikiPageDto createWikiPage(java.lang.String token, WikiPageDto wikiPage, java.lang.String content, java.lang.String comment, java.lang.String commentFormat)
          Creates a new wiki page.
 WikiPageDto createWikiPage(java.lang.String token, WikiPageDto wikiPage, java.lang.String content, java.lang.String comment, java.lang.String commentFormat, boolean rewriteLinks)
          Creates a new wiki page with optional link rewriting.
 WikiPageCommentDto createWikiPageComment(java.lang.String token, WikiPageCommentDto comment)
          Creates a new wiki page comment.
 WorkingSetDto createWorkingSet(java.lang.String token, WorkingSetDto workingSet, java.lang.Integer[] projectIds)
          Creates new working set.
 void deleteArtifact(java.lang.String token, java.lang.Integer artifactId)
          Deletes an existing artifact.
 void deleteArtifactComment(java.lang.String token, java.lang.Integer commentId)
          Deletes an existing artifact comment.
 void deleteAssociation(java.lang.String token, java.lang.Integer associationId)
          Deletes an existing association.
 void deleteBuild(java.lang.String token, java.lang.Integer buildId)
          Deletes an existing build.
 void deleteForum(java.lang.String token, java.lang.Integer forumId)
          Deletes an existing forum.
 void deleteForumPost(java.lang.String token, java.lang.Integer forumPostId)
          Deletes an existing forum post.
 void deleteLabel(java.lang.String token, java.lang.Integer labelId)
          Deletes an existing label.
 void deleteProject(java.lang.String token, java.lang.Integer projectId)
          Deletes an existing project.
 void deleteTracker(java.lang.String token, java.lang.Integer trackerId)
          Deletes an existing tracker.
 void deleteTrackerChoiceOptions(java.lang.String token, java.lang.Integer trackerId)
          Deletes the choice options for all the fields in the tracker with the given identifier.
 void deleteTrackerItem(java.lang.String token, java.lang.Integer trackerItemId)
          Deletes an existing tracker item.
 void deleteTrackerItemAttachment(java.lang.String token, java.lang.Integer attachmentId)
          Deletes an existing tracker item attachment.
 void deleteTrackerItemComment(java.lang.String token, java.lang.Integer commentId)
          Deletes an existing tracker item comment.
 void deleteUser(java.lang.String token, java.lang.Integer userId)
          Deletes an existing user account.
 void deleteWikiPage(java.lang.String token, java.lang.Integer wikiPageId)
          Deletes an existing wiki page.
 void deleteWikiPageComment(java.lang.String token, java.lang.Integer commentId)
          Deletes an existing wiki page comment.
 void deleteWorkingSet(java.lang.String token, java.lang.Integer workingSetId)
          Deletes an existing working set.
 byte[] downloadArtifact(java.lang.String token, java.lang.Integer artifactId)
          Returns the binary content of a file-type artifact or null otherwise.
 byte[] downloadArtifactRevision(java.lang.String token, java.lang.Integer artifactId, java.lang.String revision)
          Returns the binary content of a file-type artifact given revision or null otherwise.
 java.lang.String downloadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, boolean render)
          Returns the content of the latest revision of a wiki page.
 byte[] downloadWikiPageInExternalFormat(java.lang.String token, java.lang.Integer wikiPageId)
          Returns the content of the latest revision of a wiki page in external format.
 byte[] executeAndDownloadReport(java.lang.String token, java.lang.Integer reportId, int format, boolean exportComments, boolean exportDescriptions, java.lang.String recordSeparator, java.lang.String fieldSeparator)
          Executes the report with the given identifier and returns the binary representation of report file.
 BuildLogDto executeBuildById(java.lang.String token, java.lang.Integer buildId)
          Executes the build with the given identifier.
 TrackerItemDto[][] executeReport(java.lang.String token, java.lang.Integer reportId)
          Executes the report with the given identifier.
 AssociationDto[] findAllAssociations(java.lang.String token)
          Returns all the associations related to any kind of entities.
 LabelDto[] findAllPrivateLabels(java.lang.String token)
          Returns all the private labels of the given user.
 ProjectDto[] findAllProjects(java.lang.String token)
          Returns all the projects.
 LabelDto[] findAllPublicLabels(java.lang.String token)
          Returns all the public labels.
 TrackerDto[] findAllTrackers(java.lang.String token)
          Returns all the trackers.
 UserDto[] findAllUsers(java.lang.String token)
          Returns all the user accounts.
 TrackerItemDto[] findAllUserTrackerItems(java.lang.String token)
          Returns all the tracker items related to (assigned to or submitted by) the given user.
 WorkingSetDto[] findAllWorkingSets(java.lang.String token)
          Returns all working sets available for the user.
 ArtifactDto findArtifactById(java.lang.String token, java.lang.Integer artifactId)
          Returns the artifact with the given identifier.
 ArtifactCommentDto findArtifactCommentById(java.lang.String token, java.lang.Integer commentId)
          Returns the artifact comment with the given identifier.
 ArtifactCommentDto[] findArtifactCommentsByArtifactId(java.lang.String token, java.lang.Integer artifactId)
          Returns all the artifact comments from the given artifact.
 ArtifactHistoryEntryDto[] findArtifactHistory(java.lang.String token, java.lang.Integer artifactId)
          Returns the history records of the given artifact, beginning with the most recent one.
 ArtifactDto[] findArtifactsByParentArtifact(java.lang.String token, java.lang.Integer parentArtifactId)
          Returns all the artifacts that are children of the given directory-type artifact.
 AssociationDto findAssociationById(java.lang.String token, java.lang.Integer associationId)
          Returns the association with the given identifier.
 AssociationDto[] findAssociationsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId, boolean bidirectional)
          Returns the associations related to the given entity.
 BuildDto findBuildById(java.lang.String token, java.lang.Integer buildId)
          Returns the build with the given identifier.
 BuildLogDto[] findBuildLogsByBuildId(java.lang.String token, java.lang.Integer buildId, long startTime)
          Returns the most recent build log of the build with the given identifier.
 BuildDto[] findBuildsByProjectId(java.lang.String token, java.lang.Integer projectId)
          Returns all the builds that belong to the project with the given identifier.
 BuildStatsDto findBuildStatsByBuildId(java.lang.String token, java.lang.Integer buildId)
          Returns the statistics for the given build.
 BuildStatsDto findBuildStatsByProjectId(java.lang.String token, java.lang.Integer projectId)
          Returns the aggregated build statistics for the given project.
 ScmChangeSetDto[] findCommitsByTrackerItem(java.lang.String token, java.lang.Integer trackerItemId)
          Returns all change-sets related to the tracker item with the given identifier.
 ScmChangeSetDto[] findCommitsByTrackerItems(java.lang.String token, java.lang.Integer[] trackerItemIds)
          Returns all change-sets related to the tracker items with the given IDs.
 EntityLabelDto[] findEntititesByLabel(java.lang.String token, java.lang.Integer labelId)
          Returns all the entities which the given label is assigned to.
 EntityReferenceDto[] findEntityReferencesBySource(java.lang.String token, java.lang.Integer fromTypeId, java.lang.Integer fromId)
          Returns the entity references with the given source end.
 EntityReferenceDto[] findEntityReferencesByTarget(java.lang.String token, java.lang.Integer toTypeId, java.lang.Integer toId)
          Returns the entity references with the given target end.
 ForumDto findForumById(java.lang.String token, java.lang.Integer forumId)
          Returns the forum with the given identifier.
 ForumPostDto findForumPostById(java.lang.String token, java.lang.Integer forumPostId)
          Returns the forum post with the given identifier.
 ForumPostDto[] findForumPostsByForum(java.lang.String token, java.lang.Integer forumId, int maxCount)
          Returns the most recent forum posts that were posted to the forum with the given identifier.
 ForumDto[] findForumsByProject(java.lang.String token, java.lang.Integer projectId)
          Returns all the forums that belong to the project with the given identifier.
 LabelDto findLabelById(java.lang.String token, java.lang.Integer labelId)
          Returns the label with the given identifier.
 EntityLabelDto[] findLabelsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId)
          Returns all the labels assigned to the given entity: these include all the public labels, and all the private labels of the current remote user.
 PermissionDto findPermissionByName(java.lang.String token, java.lang.String permissionName)
          Returns the permission with the given name.
 PermissionDto[] findPermissionsByNames(java.lang.String token, java.lang.String[] permissionNames)
          Returns the permissions with the given names.
 ReferableDto[] findPossibleReferenceFieldValues(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer fieldId)
          Get the possible values for a reference/dynamic choice field.
 ProjectDto findProjectById(java.lang.String token, java.lang.Integer projectId)
          Returns the project with the given identifier.
 ProjectDto findProjectByName(java.lang.String token, java.lang.String projectName)
          Returns the project with the given name.
 ProjectDto[] findProjectsByWorkingSet(java.lang.String token, java.lang.Integer workingSetId)
          Returns all projects defined in the working sets.
 ArtifactDto[] findReportsByProject(java.lang.String token, java.lang.Integer projectId)
          Returns all reports in the project with the given identifier.
 RoleDto[] findRolesByProject(java.lang.String token, java.lang.Integer projectId)
          Returns all the roles defined for the portal or for the project with the given identifier.
 RoleDto[] findRolesByProjectAndUser(java.lang.String token, java.lang.Integer projectId, java.lang.Integer userId)
          Returns all the roles that user is assigned to on portal-scope or in the project with the given identifier.
 SourceFileDto findSourceFileById(java.lang.String token, java.lang.Integer sourceFileId)
          Returns the source code file with the given identifier.
 SourceFileDto findSourceFileByProjectAndPath(java.lang.String token, java.lang.Integer projectId, java.lang.String path)
          Returns the source code file with the given path, in the project with the given identifier.
 SourceFileDto[] findSourceFilesByProject(java.lang.String token, java.lang.Integer projectId)
          Returns all the source code files in the project with the given identifier.
 SourceFileDto[] findSourceFilesByProjectsAndFileNamePattern(java.lang.String token, java.lang.Integer[] projectIds, java.lang.String likePattern)
          Returns the source files that match the like-expression search criteria in the specified projects.
 ForumStatsDto findStatsByForumId(java.lang.String token, java.lang.Integer forumId)
          Returns the basic statistics of the forum with the given identifier for the currently signed-in user or null if the forum is not accessible.
 TrackerStatsDto findStatsByTrackerId(java.lang.String token, java.lang.Integer trackerId)
          Returns the basic statistics of the tracker with the given identifier for the currently signed-in user or null if the tracker is not accessible.
 ArtifactDto[] findTopArtifactsByProject(java.lang.String token, java.lang.Integer projectId)
          Returns the top-level artifacts (items in the "root") of the given project.
 WikiPageDto[] findTopWikiPagesByProject(java.lang.String token, java.lang.Integer projectId)
          Returns the top-level wiki pages (pages in the "root") of the given project.
 TrackerDto findTrackerById(java.lang.String token, java.lang.Integer trackerId)
          Returns the tracker with the given identifier.
 TrackerChoiceOptionDto[] findTrackerChoiceOptions(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer fieldId)
          Returns the possible choices for a field in the given tracker or zero-length array if there are no choice options for the field.
 TrackerItemAttachmentDto findTrackerItemAttachmentById(java.lang.String token, java.lang.Integer attachmentId)
          Returns the tracker item attachment with the given identifier.
 TrackerItemAttachmentDto[] findTrackerItemAttachmentsByTrackerItemId(java.lang.String token, java.lang.Integer trackerItemId)
          Returns all the tracker item attachments from the given tracker item.
 TrackerItemDto findTrackerItemById(java.lang.String token, java.lang.Integer trackerItemId)
          Returns the tracker item with the given identifier.
 TrackerItemCommentDto findTrackerItemCommentById(java.lang.String token, java.lang.Integer commentId)
          Returns the tracker item comment with the given identifier.
 TrackerItemCommentDto[] findTrackerItemCommentsByTrackerItemId(java.lang.String token, java.lang.Integer trackerItemId)
          Returns all the tracker item comments from the given tracker item.
 TrackerItemHistoryEntryDto[] findTrackerItemHistory(java.lang.String token, java.lang.Integer trackerItemId)
          Returns the history records of the given tracker item, beginning with the most recent one.
 TrackerItemDto[] findTrackerItemsByTrackerId(java.lang.String token, java.lang.Integer trackerId)
          Returns all the tracker items from the given tracker.
 TrackerItemDto[] findTrackerItemsByTrackerIdAndUserId(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer userId)
          Returns all the tracker items from the given tracker, submitted by and/or assigned to the given user.
 TrackerStatsDto[] findTrackerItemStatsByTrackers(java.lang.String token, java.lang.Integer[] trackerIds)
          Returns tracker item statistics related to given trackers and to the current user.
 TrackerLayoutDto findTrackerLayout(java.lang.String token, java.lang.Integer trackerId)
          Returns the layout of the tracker with the given identifier.
 TrackerDto[] findTrackersByProject(java.lang.String token, java.lang.Integer projectId)
          Returns all the trackers that belong to the project with the given identifier.
 UserDto findUserById(java.lang.String token, java.lang.Integer userId)
          Returns the user account with the given identifier.
 PermissionDto[] findUserPermissions(java.lang.String token)
          Returns all global permissions that are granted for the current user.
 PermissionDto[] findUserPermissionsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId)
          Returns all permissions on the given entity that are granted for the current user.
 UserDto[] findUsersByIds(java.lang.String token, java.lang.Integer[] userIds)
          Returns the user accounts with the given identifiers.
 UserDto[] findUsersByProject(java.lang.String token, java.lang.Integer projectId, boolean includeLinkedRoles)
          Returns all the user accounts who are stakeholders in the project with the given identifier.
 UserTrackerItemStatsDto findUserTrackerItemStats(java.lang.String token)
          Returns tracker item statistics related to the current user.
 WikiPageDto findWikiPageById(java.lang.String token, java.lang.Integer wikiPageId)
          Returns the wiki page with the given identifier.
 WikiPageDto findWikiPageByProjectAndName(java.lang.String token, java.lang.Integer projectId, java.lang.String name)
          Returns the wiki page with the given name in the project with the given identifier or null if not found.
 WikiPageCommentDto findWikiPageCommentById(java.lang.String token, java.lang.Integer commentId)
          Returns the wiki page comment with the given identifier.
 WikiPageCommentDto[] findWikiPageCommentsByWikiPageId(java.lang.String token, java.lang.Integer wikiPageId)
          Returns all the wiki page comments from the given wiki page.
 ArtifactHistoryEntryDto[] findWikiPageHistory(java.lang.String token, java.lang.Integer wikiPageId)
          Returns the history records of the given wiki page, beginning with the most recent one.
 WikiPageDto[] findWikiPagesByParentWikiPage(java.lang.String token, java.lang.Integer parentWikiPageId)
          Returns all the wiki pages that are children of the given wiki page.
 WorkingSetDto findWorkingSetById(java.lang.String token, java.lang.Integer workingSetId)
          Returns a working set by the given id.
 ProjectPreferencesDto getProjectPreferences(java.lang.String token, java.lang.Integer projectId)
          Returns the preferences of the project with the given identifier.
 java.util.List<ProjectDto> getSelectedWorkingSetProjects(java.lang.String token)
          Get the projects in the currently selected workingset.
 ServerInfo getServerInfo()
          Returns general information about the remote server.
 java.lang.String getSessionLastRequestId(java.lang.String token)
          Returns the unique identifier of the last request in this session
 UserDto getSessionUser(java.lang.String token)
          Returns the user who is currently logged in
 boolean hasUserPermission(java.lang.String token, java.lang.Integer permissionId)
          Returns whether the current user has a global permission granted.
 boolean hasUserPermissionOnEntity(java.lang.String token, java.lang.Integer permissionId, java.lang.Integer entityTypeId, java.lang.Integer entityId)
          Returns whether the current user has a permission on the given entity granted.
 BinaryStreamDto loadArtifactCommentBlob(java.lang.String token, java.lang.Integer abstractCommentDtoId)
          Load the blob info from the ArtifactCommentDto's table
 BinaryStreamDto loadForumPostBlob(java.lang.String token, java.lang.Integer forumPostId)
          Load the blob info from the ForumPostDto's table
 BinaryStreamDto loadTrackerItemAttachmentBlob(java.lang.String token, java.lang.Integer trackerItemAttachmentDtoId)
          Load the blob info from the TrackerItemAttachmentDto's table
 java.lang.String login(java.lang.String username, java.lang.String password)
          This is the very first method the client has to call.
 void logout(java.lang.String token)
          Terminates the remote session.
 void removeTrackerItem(java.lang.String token, java.lang.Integer trackerItemId)
          Logically deletes an existing tracker item.
 void removeUserFromRole(java.lang.String token, java.lang.Integer userId, java.lang.Integer projectId, java.lang.Integer roleId)
          Removes the user from a portal-scope or project-scope role (but will not delete the role).
 java.lang.String renderContent(java.lang.String token, java.lang.String wikiMarkupText)
          Renders wiki markup text into HTML markup output.
 void saveArtifactCommentBlob(java.lang.String token, java.lang.Integer abstractCommentDtoId, BinaryStreamDto binaryStreamDto)
          Save blob data to the ArtifactCommentDto's table
 void saveForumPostBlob(java.lang.String token, java.lang.Integer forumPostId, BinaryStreamDto binaryStreamDto)
          Save blob data to the ForumPostDto's table
 void saveTrackerItemAttachmentBlob(java.lang.String token, java.lang.Integer trackerItemAttachmentDtoId, BinaryStreamDto binaryStreamDto)
          Save blob data to the TrackerItemAttachmentDto's table
 void selectWorkingSet(java.lang.String token, java.lang.Integer workingSetId)
          Select a workingSet.
 void setArtifactLock(java.lang.String token, java.lang.Integer artifactId, boolean lock)
          Sets or releases a hard lock for the given artifact.
 void setArtifactLock(java.lang.String token, java.lang.Integer artifactId, boolean lock, boolean hard)
          Sets or releases a soft- or hard lock for the given artifact.
 void setEntityLabels(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId, LabelDto[] labels)
          Sets the labels assigned to the given entity.
 void setProjectPreferences(java.lang.String token, ProjectPreferencesDto projectPreferences)
          Sets the preferences for the given project.
 void setTrackerChoiceOptions(java.lang.String token, java.util.List choiceOptions)
          Creates new choice options.
 void updateArtifact(java.lang.String token, ArtifactDto artifact)
          Updates an existing artifact.
 void updateArtifactComment(java.lang.String token, ArtifactCommentDto comment)
          Updates an existing artifact comment.
 void updateAssociation(java.lang.String token, AssociationDto association)
          Updates an existing association.
 void updateBuild(java.lang.String token, BuildDto build)
          Updates an existing build.
 void updateForumPost(java.lang.String token, ForumPostDto post)
          Updates an existing forum post.
 void updateLabel(java.lang.String token, LabelDto label)
          Updates an existing label.
 void updateProject(java.lang.String token, ProjectDto project)
          Updates an existing project.
 void updateTracker(java.lang.String token, TrackerDto tracker)
          Updates an existing tracker.
 void updateTrackerItem(java.lang.String token, TrackerItemDto item)
          Updates an existing tracker item.
 void updateTrackerItemAsModified(java.lang.String token, TrackerItemDto item)
          Updates the modifiedAt and modifietAt properties an existing tracker item.
 void updateTrackerItemAttachment(java.lang.String token, TrackerItemAttachmentDto attachment)
          Updates an existing tracker item attachment.
 void updateTrackerItemComment(java.lang.String token, TrackerItemCommentDto comment)
          Updates an existing tracker item comment.
 void updateTrackerLayout(java.lang.String token, TrackerLayoutDto trackerLayout)
          Updates the layout of an existing tracker.
 void updateUser(java.lang.String token, UserDto user)
          Updates an existing user account.
 void updateWikiPage(java.lang.String token, WikiPageDto wikiPage)
          Updates an existing wiki page.
 void updateWikiPageComment(java.lang.String token, WikiPageCommentDto comment)
          Updates an existing wiki page comment.
 void updateWorkingSet(java.lang.String token, WorkingSetDto workingSet, java.lang.Integer[] projectIds)
          Updates an existing working set.
 void uploadArtifact(java.lang.String token, java.lang.Integer artifactId, byte[] data, java.lang.String comment, java.lang.String commentFormat, java.lang.String checksum)
          Stores binary content to a file-type artifact.
 void uploadArtifactTemporary(java.lang.String token, java.lang.Integer artifactId, byte[] data, java.lang.String checksum)
          Uploads artifact content to the temporary space.
 void uploadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, java.lang.String content, java.lang.String comment, java.lang.String commentFormat)
          Saves new content to an existing wiki page.
 void uploadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, java.lang.String content, java.lang.String comment, java.lang.String commentFormat, boolean rewriteLinks)
          Saves new content to an existing wiki page with optional link rewriting.
 void uploadWikiPageInExternalFormat(java.lang.String token, java.lang.Integer wikiPageId, byte[] content, java.lang.String comment, java.lang.String commentFormat, java.lang.String checksum)
          Stores new content to an existing wiki page.
 

Method Detail

getServerInfo

ServerInfo getServerInfo()
Returns general information about the remote server. This method can be called without a valid login


login

java.lang.String login(java.lang.String username,
                       java.lang.String password)
This is the very first method the client has to call. It opens a new remote session identitied by a unique token, which then needs to be passed to any API method call.

Returns:
the token that identifies this remote session if successful
Throws:
java.security.AccessControlException - if login is denied

logout

void logout(java.lang.String token)
Terminates the remote session. After calling this, the token is not valid anymore.


getSessionUser

UserDto getSessionUser(java.lang.String token)
Returns the user who is currently logged in

Throws:
java.lang.IllegalStateException - if no active session exists

getSessionLastRequestId

java.lang.String getSessionLastRequestId(java.lang.String token)
Returns the unique identifier of the last request in this session

Throws:
java.lang.IllegalStateException - if no active session exists

createUser

UserDto createUser(java.lang.String token,
                   UserDto user)
                   throws ChangeVetoedException
Creates a new user account.

Returns:
the user account created, with its new identifier.
Throws:
ChangeVetoedException

deleteUser

void deleteUser(java.lang.String token,
                java.lang.Integer userId)
                throws ChangeVetoedException
Deletes an existing user account.

Parameters:
userId - identifier of the user account.
Throws:
ChangeVetoedException

updateUser

void updateUser(java.lang.String token,
                UserDto user)
                throws ChangeVetoedException
Updates an existing user account.

Throws:
ChangeVetoedException

findAllUsers

UserDto[] findAllUsers(java.lang.String token)
Returns all the user accounts. Passwords are not returned for security reasons.


findUserById

UserDto findUserById(java.lang.String token,
                     java.lang.Integer userId)
Returns the user account with the given identifier. Password is not returned for security reasons.

Parameters:
userId - identifier of the user account.

findUsersByIds

UserDto[] findUsersByIds(java.lang.String token,
                         java.lang.Integer[] userIds)
Returns the user accounts with the given identifiers. Password is not returned for security reasons.

Parameters:
userIds - identifiers of the user accounts.

findUsersByProject

UserDto[] findUsersByProject(java.lang.String token,
                             java.lang.Integer projectId,
                             boolean includeLinkedRoles)
Returns all the user accounts who are stakeholders in the project with the given identifier.

Parameters:
projectId - identifier of the project.
includeLinkedRoles - if false then only actual members will be returned. If true then the result includes also those users who are not members, but can access the project through their group membership.

createProject

ProjectDto createProject(java.lang.String token,
                         ProjectDto project)
                         throws AccessRightsException,
                                ChangeVetoedException
Creates a new project.

Returns:
the project created, with its new identifier.
Throws:
AccessRightsException
ChangeVetoedException

createProjectFromTemplate

ProjectDto createProjectFromTemplate(java.lang.String token,
                                     ProjectDto project,
                                     java.lang.Integer templateProjectId)
                                     throws AccessRightsException,
                                            ChangeVetoedException
Creates a new project from template.

Parameters:
templateProjectId - the template project identifier.
Returns:
the project created, with its new identifier.
Throws:
AccessRightsException
ChangeVetoedException

deleteProject

void deleteProject(java.lang.String token,
                   java.lang.Integer projectId)
                   throws AccessRightsException,
                          ChangeVetoedException
Deletes an existing project.

Parameters:
projectId - identifier of the project.
Throws:
AccessRightsException
ChangeVetoedException

updateProject

void updateProject(java.lang.String token,
                   ProjectDto project)
                   throws AccessRightsException,
                          ChangeVetoedException
Updates an existing project.

Parameters:
project - the project to be updated.
Throws:
AccessRightsException
ChangeVetoedException

getProjectPreferences

ProjectPreferencesDto getProjectPreferences(java.lang.String token,
                                            java.lang.Integer projectId)
Returns the preferences of the project with the given identifier.

Parameters:
projectId - identifier of the project.

setProjectPreferences

void setProjectPreferences(java.lang.String token,
                           ProjectPreferencesDto projectPreferences)
                           throws AccessRightsException
Sets the preferences for the given project.

Throws:
AccessRightsException

findAllProjects

ProjectDto[] findAllProjects(java.lang.String token)
Returns all the projects.


findProjectById

ProjectDto findProjectById(java.lang.String token,
                           java.lang.Integer projectId)
Returns the project with the given identifier.

Parameters:
projectId - identifier of the project.

findProjectByName

ProjectDto findProjectByName(java.lang.String token,
                             java.lang.String projectName)
Returns the project with the given name.

Parameters:
projectName - name of the project.

addUserToRole

void addUserToRole(java.lang.String token,
                   java.lang.Integer userId,
                   java.lang.Integer projectId,
                   java.lang.Integer roleId)
Adds the user to an existing portal-scope or project-scope role.

Parameters:
userId - identifier of the user account to add to the role.
projectId - if null, role will be treated as portal-scope.

removeUserFromRole

void removeUserFromRole(java.lang.String token,
                        java.lang.Integer userId,
                        java.lang.Integer projectId,
                        java.lang.Integer roleId)
Removes the user from a portal-scope or project-scope role (but will not delete the role).

Parameters:
userId - identifier of the user account to remove from the role.
projectId - if null, role will be treated as portal-scope.

findRolesByProject

RoleDto[] findRolesByProject(java.lang.String token,
                             java.lang.Integer projectId)
Returns all the roles defined for the portal or for the project with the given identifier.

Parameters:
projectId - if null, portal-scope roles will be returned.

findRolesByProjectAndUser

RoleDto[] findRolesByProjectAndUser(java.lang.String token,
                                    java.lang.Integer projectId,
                                    java.lang.Integer userId)
Returns all the roles that user is assigned to on portal-scope or in the project with the given identifier.

Parameters:
projectId - if null, portal-scope roles will be returned.

findPermissionByName

PermissionDto findPermissionByName(java.lang.String token,
                                   java.lang.String permissionName)
Returns the permission with the given name.

Parameters:
permissionName - see the constants in PermissionDto.

findPermissionsByNames

PermissionDto[] findPermissionsByNames(java.lang.String token,
                                       java.lang.String[] permissionNames)
Returns the permissions with the given names.

Parameters:
permissionNames - see the constants in PermissionDto.

hasUserPermission

boolean hasUserPermission(java.lang.String token,
                          java.lang.Integer permissionId)
Returns whether the current user has a global permission granted. "Global" means permissions that are not related to a specific entity: for example, "system administration" or "user account phone view".


hasUserPermissionOnEntity

boolean hasUserPermissionOnEntity(java.lang.String token,
                                  java.lang.Integer permissionId,
                                  java.lang.Integer entityTypeId,
                                  java.lang.Integer entityId)
Returns whether the current user has a permission on the given entity granted.

Parameters:
entityTypeId - is one of the constants defined in GroupType.

findUserPermissions

PermissionDto[] findUserPermissions(java.lang.String token)
Returns all global permissions that are granted for the current user. "Global" means permissions that are not related to a specific entity: for example, "system administration" or "user account phone view".


findUserPermissionsByEntity

PermissionDto[] findUserPermissionsByEntity(java.lang.String token,
                                            java.lang.Integer entityTypeId,
                                            java.lang.Integer entityId)
Returns all permissions on the given entity that are granted for the current user. It returns only the permissions that are specific to the entity: for example, "document view" and "document edit" in case of a document.

Parameters:
entityTypeId - is one of the constants defined in GroupType.

createArtifact

ArtifactDto createArtifact(java.lang.String token,
                           ArtifactDto artifact)
                           throws AccessRightsException,
                                  ArtifactNameConflictException,
                                  DocumentSccException,
                                  ChangeVetoedException
Creates a new artifact.

Returns:
the artifact created, with its new identifier.
Throws:
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException

createAndUploadArtifact

ArtifactDto createAndUploadArtifact(java.lang.String token,
                                    ArtifactDto artifact,
                                    byte[] data,
                                    java.lang.String comment,
                                    java.lang.String commentFormat)
                                    throws AccessRightsException,
                                           ArtifactNameConflictException,
                                           DocumentSccException,
                                           ChangeVetoedException
Creates a new file-type artifact and initializes its binary content.

Parameters:
data - binary content of the artifact.
Returns:
the artifact created, with its new identifier.
Throws:
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
See Also:
DescriptionFormat

deleteArtifact

void deleteArtifact(java.lang.String token,
                    java.lang.Integer artifactId)
                    throws java.lang.IllegalArgumentException,
                           AccessRightsException,
                           ChangeVetoedException
Deletes an existing artifact.

Parameters:
artifactId - identifier of the artifact.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

updateArtifact

void updateArtifact(java.lang.String token,
                    ArtifactDto artifact)
                    throws AccessRightsException,
                           ArtifactNameConflictException,
                           DocumentSccException,
                           ChangeVetoedException
Updates an existing artifact.

Throws:
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
See Also:
uploadArtifact(String, Integer, byte[], String, String, String)

uploadArtifact

void uploadArtifact(java.lang.String token,
                    java.lang.Integer artifactId,
                    byte[] data,
                    java.lang.String comment,
                    java.lang.String commentFormat,
                    java.lang.String checksum)
                    throws AccessRightsException,
                           ArtifactNameConflictException,
                           DocumentSccException,
                           ChangeVetoedException
Stores binary content to a file-type artifact.

Parameters:
artifactId - identifier of the artifact.
data - binary content of the artifact.
comment - checkin comment.
commentFormat - checkin comment format.
checksum - is a MD5 data checksum, or null
Throws:
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
See Also:
DescriptionFormat

uploadArtifactTemporary

void uploadArtifactTemporary(java.lang.String token,
                             java.lang.Integer artifactId,
                             byte[] data,
                             java.lang.String checksum)
                             throws DocumentSccException,
                                    AccessRightsException
Uploads artifact content to the temporary space.

Parameters:
artifactId -
data -
checksum - is a MD5 data checksum, or null
Throws:
DocumentSccException
AccessRightsException

downloadArtifact

byte[] downloadArtifact(java.lang.String token,
                        java.lang.Integer artifactId)
                        throws DocumentSccException
Returns the binary content of a file-type artifact or null otherwise.

Parameters:
artifactId - identifier of the artifact.
Throws:
DocumentSccException

downloadArtifactRevision

byte[] downloadArtifactRevision(java.lang.String token,
                                java.lang.Integer artifactId,
                                java.lang.String revision)
                                throws DocumentSccException
Returns the binary content of a file-type artifact given revision or null otherwise.

Parameters:
artifactId - identifier of the artifact.
revision - revision number.
Throws:
DocumentSccException

findTopArtifactsByProject

ArtifactDto[] findTopArtifactsByProject(java.lang.String token,
                                        java.lang.Integer projectId)
Returns the top-level artifacts (items in the "root") of the given project.

Parameters:
projectId - identifier of the project.

findArtifactsByParentArtifact

ArtifactDto[] findArtifactsByParentArtifact(java.lang.String token,
                                            java.lang.Integer parentArtifactId)
Returns all the artifacts that are children of the given directory-type artifact.

Parameters:
parentArtifactId - identifier of the parent directory-type artifact

findArtifactById

ArtifactDto findArtifactById(java.lang.String token,
                             java.lang.Integer artifactId)
Returns the artifact with the given identifier.

Parameters:
artifactId - identifier of the artifact.

findArtifactHistory

ArtifactHistoryEntryDto[] findArtifactHistory(java.lang.String token,
                                              java.lang.Integer artifactId)
Returns the history records of the given artifact, beginning with the most recent one.

Parameters:
artifactId - identifier of the artifact.

setArtifactLock

void setArtifactLock(java.lang.String token,
                     java.lang.Integer artifactId,
                     boolean lock)
Sets or releases a hard lock for the given artifact.

Parameters:
artifactId - identifier of the artifact.
lock - is whether to lock (true) or unlock (false) it.

setArtifactLock

void setArtifactLock(java.lang.String token,
                     java.lang.Integer artifactId,
                     boolean lock,
                     boolean hard)
Sets or releases a soft- or hard lock for the given artifact.

Parameters:
artifactId - identifier of the artifact.
lock - is whether to lock (true) or unlock (false) it.
hard - is whether to work on a hard- (true) or soft lock (false).

createArtifactComment

ArtifactCommentDto createArtifactComment(java.lang.String token,
                                         ArtifactCommentDto comment)
Creates a new artifact comment.

Parameters:
comment - encapsulates also the binary content (attachment) of the comment.
Returns:
the artifact comment created, with its new identifier.

deleteArtifactComment

void deleteArtifactComment(java.lang.String token,
                           java.lang.Integer commentId)
Deletes an existing artifact comment.

Parameters:
commentId - identifier of the artifact comment.

updateArtifactComment

void updateArtifactComment(java.lang.String token,
                           ArtifactCommentDto comment)
Updates an existing artifact comment.

Parameters:
comment - encapsulates also the binary content (attachment) of the comment.

findArtifactCommentById

ArtifactCommentDto findArtifactCommentById(java.lang.String token,
                                           java.lang.Integer commentId)
Returns the artifact comment with the given identifier.

Parameters:
commentId - identifier of the artifact comment.

findArtifactCommentsByArtifactId

ArtifactCommentDto[] findArtifactCommentsByArtifactId(java.lang.String token,
                                                      java.lang.Integer artifactId)
Returns all the artifact comments from the given artifact.

Parameters:
artifactId - identifier of the artifact.

createTracker

TrackerDto createTracker(java.lang.String token,
                         TrackerDto tracker)
                         throws java.lang.IllegalArgumentException,
                                AccessRightsException,
                                ChangeVetoedException
Creates a new tracker.

Returns:
the tracker created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

createTrackerFromTemplate

TrackerDto createTrackerFromTemplate(java.lang.String token,
                                     TrackerDto tracker,
                                     java.lang.Integer templateTrackerId)
                                     throws java.lang.IllegalArgumentException,
                                            AccessRightsException,
                                            ChangeVetoedException
Creates a new tracker based on another tracker as template.

Parameters:
templateTrackerId - the template tracker identifier.
Returns:
the tracker created with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

deleteTracker

void deleteTracker(java.lang.String token,
                   java.lang.Integer trackerId)
                   throws java.lang.IllegalArgumentException,
                          AccessRightsException,
                          ChangeVetoedException
Deletes an existing tracker.

Parameters:
trackerId - identifier of the tracker.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

updateTracker

void updateTracker(java.lang.String token,
                   TrackerDto tracker)
                   throws java.lang.IllegalArgumentException,
                          AccessRightsException,
                          ChangeVetoedException
Updates an existing tracker.

Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

findAllTrackers

TrackerDto[] findAllTrackers(java.lang.String token)
Returns all the trackers.


findTrackerById

TrackerDto findTrackerById(java.lang.String token,
                           java.lang.Integer trackerId)
Returns the tracker with the given identifier.

Parameters:
trackerId - identifier of the tracker.

findTrackersByProject

TrackerDto[] findTrackersByProject(java.lang.String token,
                                   java.lang.Integer projectId)
Returns all the trackers that belong to the project with the given identifier.

Parameters:
projectId - identifier of the project.

updateTrackerLayout

void updateTrackerLayout(java.lang.String token,
                         TrackerLayoutDto trackerLayout)
                         throws AccessRightsException
Updates the layout of an existing tracker.

Throws:
AccessRightsException

findTrackerLayout

TrackerLayoutDto findTrackerLayout(java.lang.String token,
                                   java.lang.Integer trackerId)
Returns the layout of the tracker with the given identifier.

Parameters:
trackerId - identifier of the tracker.

setTrackerChoiceOptions

void setTrackerChoiceOptions(java.lang.String token,
                             java.util.List choiceOptions)
                             throws AccessRightsException
Creates new choice options.

Parameters:
choiceOptions - is a List of TrackerChoiceOptionDto objects.
Throws:
AccessRightsException

deleteTrackerChoiceOptions

void deleteTrackerChoiceOptions(java.lang.String token,
                                java.lang.Integer trackerId)
                                throws AccessRightsException
Deletes the choice options for all the fields in the tracker with the given identifier.

Throws:
AccessRightsException

findTrackerChoiceOptions

TrackerChoiceOptionDto[] findTrackerChoiceOptions(java.lang.String token,
                                                  java.lang.Integer trackerId,
                                                  java.lang.Integer fieldId)
Returns the possible choices for a field in the given tracker or zero-length array if there are no choice options for the field.

Parameters:
trackerId - identifier of the tracker.
fieldId - identifier of the field. See the constants in TrackerLayoutLabelDto.

findPossibleReferenceFieldValues

ReferableDto[] findPossibleReferenceFieldValues(java.lang.String token,
                                                java.lang.Integer trackerId,
                                                java.lang.Integer fieldId)
                                                throws AccessRightsException
Get the possible values for a reference/dynamic choice field. For simple choice fields use the findTrackerChoiceOptions() method instead. TODO: be careful, the result data can be huge (like all issues in a tracker)!

Parameters:
trackerId - The identifier of the tracker
fieldId - identifier of the field. See the constants in TrackerLayoutLabelDto.
Returns:
All ReferableDtos as possible values, will an empty array if no reference values found.
Throws:
java.lang.IllegalArgumentException - If the tracker or field is not found, or when the field is not a dynamic-choice field.
AccessRightsException - Thrown if the user has no permission to edit this field, thus not returning possible values

findStatsByTrackerId

TrackerStatsDto findStatsByTrackerId(java.lang.String token,
                                     java.lang.Integer trackerId)
Returns the basic statistics of the tracker with the given identifier for the currently signed-in user or null if the tracker is not accessible.

Parameters:
trackerId - identifier of the tracker.

createTrackerItem

TrackerItemDto createTrackerItem(java.lang.String token,
                                 TrackerItemDto item)
                                 throws java.lang.IllegalArgumentException,
                                        AccessRightsException,
                                        ChangeVetoedException,
                                        java.util.concurrent.TimeoutException
Creates a new tracker item. The properties inaccessible by the remote user are ignored.

Returns:
the tracker item created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException

deleteTrackerItem

void deleteTrackerItem(java.lang.String token,
                       java.lang.Integer trackerItemId)
                       throws java.lang.IllegalArgumentException,
                              AccessRightsException,
                              ChangeVetoedException,
                              java.util.concurrent.TimeoutException
Deletes an existing tracker item.

Parameters:
trackerItemId - identifier of the tracker item.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException
See Also:
removeTrackerItem(String, Integer)

updateTrackerItem

void updateTrackerItem(java.lang.String token,
                       TrackerItemDto item)
                       throws java.lang.IllegalArgumentException,
                              AccessRightsException,
                              ChangeVetoedException,
                              java.util.concurrent.TimeoutException
Updates an existing tracker item. The properties inaccessible by the remote user are ignored.

Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException

updateTrackerItemAsModified

void updateTrackerItemAsModified(java.lang.String token,
                                 TrackerItemDto item)
                                 throws java.lang.IllegalArgumentException,
                                        AccessRightsException
Updates the modifiedAt and modifietAt properties an existing tracker item. It requires System Administrator access rights. The properties inaccessible by the remote user are ignored.

Throws:
java.lang.IllegalArgumentException
AccessRightsException

removeTrackerItem

void removeTrackerItem(java.lang.String token,
                       java.lang.Integer trackerItemId)
                       throws java.lang.IllegalArgumentException,
                              AccessRightsException,
                              ChangeVetoedException,
                              java.util.concurrent.TimeoutException
Logically deletes an existing tracker item. Its record won't be physically deleted from the database.

Throws:
java.util.concurrent.TimeoutException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
See Also:
deleteTrackerItem(String, Integer)

findAllUserTrackerItems

TrackerItemDto[] findAllUserTrackerItems(java.lang.String token)
Returns all the tracker items related to (assigned to or submitted by) the given user.


findTrackerItemsByTrackerId

TrackerItemDto[] findTrackerItemsByTrackerId(java.lang.String token,
                                             java.lang.Integer trackerId)
Returns all the tracker items from the given tracker. The properties inaccessible by the remote user are not returned.

Parameters:
trackerId - identifier of the tracker.

findTrackerItemById

TrackerItemDto findTrackerItemById(java.lang.String token,
                                   java.lang.Integer trackerItemId)
Returns the tracker item with the given identifier. The properties inaccessible by the remote user are not returned.

Parameters:
trackerItemId - identifier of the tracker item.

findTrackerItemsByTrackerIdAndUserId

TrackerItemDto[] findTrackerItemsByTrackerIdAndUserId(java.lang.String token,
                                                      java.lang.Integer trackerId,
                                                      java.lang.Integer userId)
Returns all the tracker items from the given tracker, submitted by and/or assigned to the given user. The properties inaccessible by the remote user are not returned.

Parameters:
trackerId - identifier of the tracker.
userId - identifier of the user.

createTrackerItemHistoryEntry

void createTrackerItemHistoryEntry(java.lang.String token,
                                   TrackerItemHistoryEntryDto historyEntry)
Creates a tracker item history entry.

Parameters:
historyEntry - the history entry to create

createTrackerItemHistory

void createTrackerItemHistory(java.lang.String token,
                              TrackerItemHistoryEntryDto[] history)
Creates a batch of tracker item history entries at once

Parameters:
history - is the array of tracker item history entries to create

findTrackerItemHistory

TrackerItemHistoryEntryDto[] findTrackerItemHistory(java.lang.String token,
                                                    java.lang.Integer trackerItemId)
Returns the history records of the given tracker item, beginning with the most recent one.

Parameters:
trackerItemId - identifier of the tracker item.

findUserTrackerItemStats

UserTrackerItemStatsDto findUserTrackerItemStats(java.lang.String token)
Returns tracker item statistics related to the current user.


findTrackerItemStatsByTrackers

TrackerStatsDto[] findTrackerItemStatsByTrackers(java.lang.String token,
                                                 java.lang.Integer[] trackerIds)
Returns tracker item statistics related to given trackers and to the current user.


createTrackerItemComment

TrackerItemCommentDto createTrackerItemComment(java.lang.String token,
                                               TrackerItemCommentDto comment)
                                               throws java.lang.IllegalArgumentException,
                                                      AccessRightsException,
                                                      ChangeVetoedException
Creates a new tracker item comment.

Returns:
the tracker item comment created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

deleteTrackerItemComment

void deleteTrackerItemComment(java.lang.String token,
                              java.lang.Integer commentId)
                              throws java.lang.IllegalArgumentException,
                                     AccessRightsException,
                                     ChangeVetoedException
Deletes an existing tracker item comment.

Parameters:
commentId - identifier of the tracker item comment.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

updateTrackerItemComment

void updateTrackerItemComment(java.lang.String token,
                              TrackerItemCommentDto comment)
                              throws java.lang.IllegalArgumentException,
                                     AccessRightsException,
                                     ChangeVetoedException
Updates an existing tracker item comment.

Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

findTrackerItemCommentById

TrackerItemCommentDto findTrackerItemCommentById(java.lang.String token,
                                                 java.lang.Integer commentId)
                                                 throws AccessRightsException
Returns the tracker item comment with the given identifier.

Parameters:
commentId - identifier of the tracker item comment.
Throws:
AccessRightsException

findTrackerItemCommentsByTrackerItemId

TrackerItemCommentDto[] findTrackerItemCommentsByTrackerItemId(java.lang.String token,
                                                               java.lang.Integer trackerItemId)
                                                               throws AccessRightsException
Returns all the tracker item comments from the given tracker item.

Parameters:
trackerItemId - identifier of the tracker item.
Throws:
AccessRightsException

createTrackerItemAttachment

TrackerItemAttachmentDto createTrackerItemAttachment(java.lang.String token,
                                                     TrackerItemAttachmentDto attachment)
                                                     throws java.lang.IllegalArgumentException,
                                                            AccessRightsException
Creates a new tracker item attachment.

Parameters:
attachment - encapsulates also the binary content of the attachment.
Returns:
the tracker item attachment created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException

deleteTrackerItemAttachment

void deleteTrackerItemAttachment(java.lang.String token,
                                 java.lang.Integer attachmentId)
                                 throws java.lang.IllegalArgumentException,
                                        AccessRightsException,
                                        ChangeVetoedException
Deletes an existing tracker item attachment.

Parameters:
attachmentId - identifier of the tracker item attachment.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

updateTrackerItemAttachment

void updateTrackerItemAttachment(java.lang.String token,
                                 TrackerItemAttachmentDto attachment)
                                 throws java.lang.IllegalArgumentException,
                                        AccessRightsException,
                                        ChangeVetoedException
Updates an existing tracker item attachment.

Parameters:
attachment - encapsulates also the binary content of the attachment.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

findTrackerItemAttachmentById

TrackerItemAttachmentDto findTrackerItemAttachmentById(java.lang.String token,
                                                       java.lang.Integer attachmentId)
                                                       throws AccessRightsException
Returns the tracker item attachment with the given identifier.

Parameters:
attachmentId - identifier of the tracker item attachment.
Throws:
AccessRightsException

findTrackerItemAttachmentsByTrackerItemId

TrackerItemAttachmentDto[] findTrackerItemAttachmentsByTrackerItemId(java.lang.String token,
                                                                     java.lang.Integer trackerItemId)
                                                                     throws AccessRightsException
Returns all the tracker item attachments from the given tracker item.

Parameters:
trackerItemId - identifier of the tracker item.
Throws:
AccessRightsException

createAssociation

AssociationDto createAssociation(java.lang.String token,
                                 AssociationDto association)
                                 throws ChangeVetoedException
Creates a new association.

Returns:
the association created, with its new identifier.
Throws:
ChangeVetoedException

deleteAssociation

void deleteAssociation(java.lang.String token,
                       java.lang.Integer associationId)
                       throws ChangeVetoedException
Deletes an existing association.

Parameters:
associationId - identifier of the association.
Throws:
ChangeVetoedException

updateAssociation

void updateAssociation(java.lang.String token,
                       AssociationDto association)
                       throws ChangeVetoedException
Updates an existing association.

Throws:
ChangeVetoedException

findAllAssociations

AssociationDto[] findAllAssociations(java.lang.String token)
Returns all the associations related to any kind of entities.


findAssociationById

AssociationDto findAssociationById(java.lang.String token,
                                   java.lang.Integer associationId)
Returns the association with the given identifier.

Parameters:
associationId - identifier of the association.

findAssociationsByEntity

AssociationDto[] findAssociationsByEntity(java.lang.String token,
                                          java.lang.Integer entityTypeId,
                                          java.lang.Integer entityId,
                                          boolean bidirectional)
Returns the associations related to the given entity.

Parameters:
entityTypeId - is one of the constants defined in GroupType.
bidirectional - if true then both the arriving and leaving associations of the given entity will be returned, if false then only the leaving ones.

createBuild

BuildDto createBuild(java.lang.String token,
                     BuildDto build)
Creates a new build.

Returns:
the build created, with its new identifier.

deleteBuild

void deleteBuild(java.lang.String token,
                 java.lang.Integer buildId)
Deletes an existing build.

Parameters:
buildId - identifier of the build.

updateBuild

void updateBuild(java.lang.String token,
                 BuildDto build)
Updates an existing build.


findBuildsByProjectId

BuildDto[] findBuildsByProjectId(java.lang.String token,
                                 java.lang.Integer projectId)
Returns all the builds that belong to the project with the given identifier.

Parameters:
projectId - identifier of the project.

findBuildById

BuildDto findBuildById(java.lang.String token,
                       java.lang.Integer buildId)
Returns the build with the given identifier.

Parameters:
buildId - identifier of the build.

findBuildLogsByBuildId

BuildLogDto[] findBuildLogsByBuildId(java.lang.String token,
                                     java.lang.Integer buildId,
                                     long startTime)
Returns the most recent build log of the build with the given identifier.

Parameters:
buildId - identifier of the build.
startTime - start time for the build logs: all logs that are equal or more recent are returned. If 0, all logs will be returned. If -1, then the very latest log will be returned.
See Also:
executeBuildById(String, Integer)

findBuildStatsByBuildId

BuildStatsDto findBuildStatsByBuildId(java.lang.String token,
                                      java.lang.Integer buildId)
Returns the statistics for the given build.

Parameters:
buildId - identifier of the build.

findBuildStatsByProjectId

BuildStatsDto findBuildStatsByProjectId(java.lang.String token,
                                        java.lang.Integer projectId)
Returns the aggregated build statistics for the given project.

Parameters:
projectId - identifier of the project.

executeBuildById

BuildLogDto executeBuildById(java.lang.String token,
                             java.lang.Integer buildId)
Executes the build with the given identifier. This is syncronous method call: it will return only when the build is completed and the build log is available. This can take long for certain builds. If a build is already in the build queue, the second schedule request will be ignored.

Parameters:
buildId - identifier of the build.
Returns:
the resulted build log.

findSourceFileById

SourceFileDto findSourceFileById(java.lang.String token,
                                 java.lang.Integer sourceFileId)
Returns the source code file with the given identifier.

Parameters:
sourceFileId - identifier of the source code file.

findSourceFileByProjectAndPath

SourceFileDto findSourceFileByProjectAndPath(java.lang.String token,
                                             java.lang.Integer projectId,
                                             java.lang.String path)
Returns the source code file with the given path, in the project with the given identifier.

Parameters:
projectId - identifier of the project.
path - full path of the source code file.

findSourceFilesByProject

SourceFileDto[] findSourceFilesByProject(java.lang.String token,
                                         java.lang.Integer projectId)
Returns all the source code files in the project with the given identifier.

Parameters:
projectId - identifier of the project.

findSourceFilesByProjectsAndFileNamePattern

SourceFileDto[] findSourceFilesByProjectsAndFileNamePattern(java.lang.String token,
                                                            java.lang.Integer[] projectIds,
                                                            java.lang.String likePattern)
Returns the source files that match the like-expression search criteria in the specified projects.

Parameters:
projectIds - List of Integer objects, identifiers of the projects to search in. Pass null if you want to search in all the projects.
likePattern - case-insensitive pattern that has the same semantics like the patterns used in standard SQL LIKE conditions.

findCommitsByTrackerItem

ScmChangeSetDto[] findCommitsByTrackerItem(java.lang.String token,
                                           java.lang.Integer trackerItemId)
Returns all change-sets related to the tracker item with the given identifier.

Parameters:
trackerItemId - identifier of the tracker item.

findCommitsByTrackerItems

ScmChangeSetDto[] findCommitsByTrackerItems(java.lang.String token,
                                            java.lang.Integer[] trackerItemIds)
Returns all change-sets related to the tracker items with the given IDs.

Parameters:
trackerItemIds - identifiers of the tracker items.

createForum

ForumDto createForum(java.lang.String token,
                     ForumDto forum)
                     throws AccessRightsException,
                            ChangeVetoedException
Creates a new forum.

Returns:
the forum created, with its new identifier.
Throws:
AccessRightsException
ChangeVetoedException

createForumFromTemplate

ForumDto createForumFromTemplate(java.lang.String token,
                                 ForumDto forum,
                                 java.lang.Integer templateForumId)
                                 throws AccessRightsException,
                                        ChangeVetoedException
Creates a new forum based on another forum as template.

Parameters:
templateForumId - identifier of the template forum.
Returns:
the forum created, with its new identifier.
Throws:
AccessRightsException
ChangeVetoedException

deleteForum

void deleteForum(java.lang.String token,
                 java.lang.Integer forumId)
                 throws AccessRightsException,
                        ChangeVetoedException
Deletes an existing forum.

Parameters:
forumId - identifier of the forum.
Throws:
AccessRightsException
ChangeVetoedException

findForumById

ForumDto findForumById(java.lang.String token,
                       java.lang.Integer forumId)
Returns the forum with the given identifier.

Parameters:
forumId - identifier of the forum.

findForumsByProject

ForumDto[] findForumsByProject(java.lang.String token,
                               java.lang.Integer projectId)
Returns all the forums that belong to the project with the given identifier.

Parameters:
projectId - identifier of the project.

findStatsByForumId

ForumStatsDto findStatsByForumId(java.lang.String token,
                                 java.lang.Integer forumId)
Returns the basic statistics of the forum with the given identifier for the currently signed-in user or null if the forum is not accessible.

Parameters:
forumId - identifier of the forum.

createForumPost

ForumPostDto createForumPost(java.lang.String token,
                             ForumPostDto post)
                             throws java.lang.IllegalArgumentException,
                                    AccessRightsException,
                                    ChangeVetoedException
Creates a new forum post.

Returns:
the forum post created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

deleteForumPost

void deleteForumPost(java.lang.String token,
                     java.lang.Integer forumPostId)
                     throws java.lang.IllegalArgumentException,
                            AccessRightsException,
                            ChangeVetoedException
Deletes an existing forum post.

Parameters:
forumPostId - identifier of the forum post.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

updateForumPost

void updateForumPost(java.lang.String token,
                     ForumPostDto post)
                     throws java.lang.IllegalArgumentException,
                            AccessRightsException,
                            ChangeVetoedException
Updates an existing forum post.

Parameters:
post - the forum post to be updated.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException

findForumPostById

ForumPostDto findForumPostById(java.lang.String token,
                               java.lang.Integer forumPostId)
Returns the forum post with the given identifier.

Parameters:
forumPostId - identifier of the forum post.

findForumPostsByForum

ForumPostDto[] findForumPostsByForum(java.lang.String token,
                                     java.lang.Integer forumId,
                                     int maxCount)
Returns the most recent forum posts that were posted to the forum with the given identifier.

Parameters:
forumId - identifier of the forum.
maxCount - upper limit for the count of posts returned.

findReportsByProject

ArtifactDto[] findReportsByProject(java.lang.String token,
                                   java.lang.Integer projectId)
Returns all reports in the project with the given identifier.

Returns:
ArtifactDto objects that represent report definition documents.

executeReport

TrackerItemDto[][] executeReport(java.lang.String token,
                                 java.lang.Integer reportId)
Executes the report with the given identifier.

Returns:
two-dimensional array where the first index is the group, and the second index is the tracker-item-in-the-group.

executeAndDownloadReport

byte[] executeAndDownloadReport(java.lang.String token,
                                java.lang.Integer reportId,
                                int format,
                                boolean exportComments,
                                boolean exportDescriptions,
                                java.lang.String recordSeparator,
                                java.lang.String fieldSeparator)
                                throws ObjectNotExistsException
Executes the report with the given identifier and returns the binary representation of report file.

Parameters:
format - ReportType
exportComments - whether to include tracker item comments in the output.
exportDescriptions - whether to include detailed tracker item descriptions in the output.
recordSeparator - what string to output between two records. Used only with CSV format, ignored otherwise.
fieldSeparator - what string to output between two fields. Used only with CSV format, ignored otherwise.
Returns:
binary content that represents the report output.
Throws:
ObjectNotExistsException

createWikiPage

WikiPageDto createWikiPage(java.lang.String token,
                           WikiPageDto wikiPage,
                           java.lang.String content,
                           java.lang.String comment,
                           java.lang.String commentFormat)
                           throws java.lang.IllegalArgumentException,
                                  AccessRightsException,
                                  ArtifactNameConflictException,
                                  DocumentSccException,
                                  ChangeVetoedException
Creates a new wiki page.

Parameters:
content - content of the wiki page, in wiki markup format.
Returns:
the wiki page created, with its new identifier.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException

createWikiPage

WikiPageDto createWikiPage(java.lang.String token,
                           WikiPageDto wikiPage,
                           java.lang.String content,
                           java.lang.String comment,
                           java.lang.String commentFormat,
                           boolean rewriteLinks)
                           throws java.lang.IllegalArgumentException,
                                  AccessRightsException,
                                  ArtifactNameConflictException,
                                  DocumentSccException,
                                  ChangeVetoedException
Creates a new wiki page with optional link rewriting.

Parameters:
rewriteLinks - whether to detect and rewrite interwiki links and resolve absolute URLs to relative ones. Note: when you turn link rewriting off, interal incoming and outgoing links will not be detected, either. Also, the first update on the web interface will rewrite the links automatically.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
See Also:
createWikiPage(String, WikiPageDto, String, String, String)

updateWikiPage

void updateWikiPage(java.lang.String token,
                    WikiPageDto wikiPage)
                    throws java.lang.IllegalArgumentException,
                           AccessRightsException,
                           ArtifactNameConflictException,
                           DocumentSccException,
                           ChangeVetoedException
Updates an existing wiki page.

Parameters:
wikiPage - the wiki page to be updated.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException

deleteWikiPage

void deleteWikiPage(java.lang.String token,
                    java.lang.Integer wikiPageId)
                    throws java.lang.IllegalArgumentException,
                           AccessRightsException,
                           DocumentSccException,
                           ChangeVetoedException
Deletes an existing wiki page.

Parameters:
wikiPageId - identifier of the wiki page.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
DocumentSccException
ChangeVetoedException

uploadWikiPage

void uploadWikiPage(java.lang.String token,
                    java.lang.Integer wikiPageId,
                    java.lang.String content,
                    java.lang.String comment,
                    java.lang.String commentFormat)
                    throws java.lang.IllegalArgumentException,
                           AccessRightsException,
                           ArtifactNameConflictException,
                           DocumentSccException,
                           ChangeVetoedException
Saves new content to an existing wiki page. This will result in adding a new revision to the given page.

Parameters:
content - content of the wiki page, in wiki markup format.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException

uploadWikiPageInExternalFormat

void uploadWikiPageInExternalFormat(java.lang.String token,
                                    java.lang.Integer wikiPageId,
                                    byte[] content,
                                    java.lang.String comment,
                                    java.lang.String commentFormat,
                                    java.lang.String checksum)
                                    throws java.lang.IllegalArgumentException,
                                           AccessRightsException,
                                           ArtifactNameConflictException,
                                           DocumentSccException,
                                           ChangeVetoedException
Stores new content to an existing wiki page. This will result in adding a new revision to the given page.

Parameters:
content - content of the wiki page, in wiki markup format.
Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException

uploadWikiPage

void uploadWikiPage(java.lang.String token,
                    java.lang.Integer wikiPageId,
                    java.lang.String content,
                    java.lang.String comment,
                    java.lang.String commentFormat,
                    boolean rewriteLinks)
                    throws java.lang.IllegalArgumentException,
                           AccessRightsException,
                           ArtifactNameConflictException,
                           DocumentSccException,
                           ChangeVetoedException
Saves new content to an existing wiki page with optional link rewriting.

Throws:
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
See Also:
uploadWikiPage(String, Integer, String, String, String), createWikiPage(String, WikiPageDto, String, String, String, boolean)

downloadWikiPage

java.lang.String downloadWikiPage(java.lang.String token,
                                  java.lang.Integer wikiPageId,
                                  boolean render)
                                  throws DocumentSccException
Returns the content of the latest revision of a wiki page.

Parameters:
render - if true it the page content will be returned as rendered HTML, otherwise it will be returned as wiki markup.
Throws:
DocumentSccException

downloadWikiPageInExternalFormat

byte[] downloadWikiPageInExternalFormat(java.lang.String token,
                                        java.lang.Integer wikiPageId)
                                        throws DocumentSccException
Returns the content of the latest revision of a wiki page in external format.

Throws:
DocumentSccException

findWikiPageById

WikiPageDto findWikiPageById(java.lang.String token,
                             java.lang.Integer wikiPageId)
Returns the wiki page with the given identifier.

Parameters:
wikiPageId - identifier of the wiki page.

findWikiPageByProjectAndName

WikiPageDto findWikiPageByProjectAndName(java.lang.String token,
                                         java.lang.Integer projectId,
                                         java.lang.String name)
Returns the wiki page with the given name in the project with the given identifier or null if not found.


findTopWikiPagesByProject

WikiPageDto[] findTopWikiPagesByProject(java.lang.String token,
                                        java.lang.Integer projectId)
Returns the top-level wiki pages (pages in the "root") of the given project.

Parameters:
projectId - identifier of the project.

findWikiPagesByParentWikiPage

WikiPageDto[] findWikiPagesByParentWikiPage(java.lang.String token,
                                            java.lang.Integer parentWikiPageId)
Returns all the wiki pages that are children of the given wiki page.

Parameters:
parentWikiPageId - identifier of the parent wiki page

findWikiPageHistory

ArtifactHistoryEntryDto[] findWikiPageHistory(java.lang.String token,
                                              java.lang.Integer wikiPageId)
Returns the history records of the given wiki page, beginning with the most recent one.

Parameters:
wikiPageId - identifier of the wiki page.

renderContent

java.lang.String renderContent(java.lang.String token,
                               java.lang.String wikiMarkupText)
Renders wiki markup text into HTML markup output.

Parameters:
wikiMarkupText - the wiki markup text to transform to HTML.
Returns:
the HTML output.

createWikiPageComment

WikiPageCommentDto createWikiPageComment(java.lang.String token,
                                         WikiPageCommentDto comment)
Creates a new wiki page comment.

Parameters:
comment - encapsulates also the binary content (attachment) of the comment.
Returns:
the wiki page comment created, with its new identifier.

deleteWikiPageComment

void deleteWikiPageComment(java.lang.String token,
                           java.lang.Integer commentId)
Deletes an existing wiki page comment.

Parameters:
commentId - identifier of the wiki page comment.

updateWikiPageComment

void updateWikiPageComment(java.lang.String token,
                           WikiPageCommentDto comment)
Updates an existing wiki page comment.

Parameters:
comment - encapsulates also the binary content (attachment) of the comment.

findWikiPageCommentById

WikiPageCommentDto findWikiPageCommentById(java.lang.String token,
                                           java.lang.Integer commentId)
Returns the wiki page comment with the given identifier.

Parameters:
commentId - identifier of the wiki page comment.

findWikiPageCommentsByWikiPageId

WikiPageCommentDto[] findWikiPageCommentsByWikiPageId(java.lang.String token,
                                                      java.lang.Integer wikiPageId)
Returns all the wiki page comments from the given wiki page.

Parameters:
wikiPageId - identifier of the wiki page.

createLabel

LabelDto createLabel(java.lang.String token,
                     LabelDto label)
                     throws AccessRightsException
Creates a new label.

Returns:
the label created, with its new identifier.
Throws:
AccessRightsException

updateLabel

void updateLabel(java.lang.String token,
                 LabelDto label)
                 throws AccessRightsException
Updates an existing label.

Parameters:
label - the label to be updated.
Throws:
AccessRightsException

deleteLabel

void deleteLabel(java.lang.String token,
                 java.lang.Integer labelId)
                 throws AccessRightsException
Deletes an existing label.

Parameters:
labelId - identifier of the label.
Throws:
AccessRightsException

findAllPublicLabels

LabelDto[] findAllPublicLabels(java.lang.String token)
Returns all the public labels.


findAllPrivateLabels

LabelDto[] findAllPrivateLabels(java.lang.String token)
Returns all the private labels of the given user.


findLabelById

LabelDto findLabelById(java.lang.String token,
                       java.lang.Integer labelId)
Returns the label with the given identifier.

Parameters:
labelId - identifier of the label.

setEntityLabels

void setEntityLabels(java.lang.String token,
                     java.lang.Integer entityTypeId,
                     java.lang.Integer entityId,
                     LabelDto[] labels)
                     throws AccessRightsException
Sets the labels assigned to the given entity.

Throws:
AccessRightsException

findLabelsByEntity

EntityLabelDto[] findLabelsByEntity(java.lang.String token,
                                    java.lang.Integer entityTypeId,
                                    java.lang.Integer entityId)
Returns all the labels assigned to the given entity: these include all the public labels, and all the private labels of the current remote user.

Parameters:
entityTypeId - is one of the constants defined in GroupType.

findEntititesByLabel

EntityLabelDto[] findEntititesByLabel(java.lang.String token,
                                      java.lang.Integer labelId)
Returns all the entities which the given label is assigned to.


findEntityReferencesBySource

EntityReferenceDto[] findEntityReferencesBySource(java.lang.String token,
                                                  java.lang.Integer fromTypeId,
                                                  java.lang.Integer fromId)
Returns the entity references with the given source end.

Parameters:
fromTypeId - is one of the constants defined in GroupType.

findEntityReferencesByTarget

EntityReferenceDto[] findEntityReferencesByTarget(java.lang.String token,
                                                  java.lang.Integer toTypeId,
                                                  java.lang.Integer toId)
Returns the entity references with the given target end.

Parameters:
toTypeId - is one of the constants defined in GroupType.

createWorkingSet

WorkingSetDto createWorkingSet(java.lang.String token,
                               WorkingSetDto workingSet,
                               java.lang.Integer[] projectIds)
                               throws AccessRightsException
Creates new working set.

Parameters:
projectIds - the list of project id to be included inside.
Throws:
AccessRightsException

updateWorkingSet

void updateWorkingSet(java.lang.String token,
                      WorkingSetDto workingSet,
                      java.lang.Integer[] projectIds)
                      throws AccessRightsException
Updates an existing working set.

Throws:
AccessRightsException

deleteWorkingSet

void deleteWorkingSet(java.lang.String token,
                      java.lang.Integer workingSetId)
                      throws AccessRightsException
Deletes an existing working set.

Throws:
AccessRightsException

findAllWorkingSets

WorkingSetDto[] findAllWorkingSets(java.lang.String token)
Returns all working sets available for the user.

Returns:
empty array if no working sets defined.

findWorkingSetById

WorkingSetDto findWorkingSetById(java.lang.String token,
                                 java.lang.Integer workingSetId)
                                 throws AccessRightsException
Returns a working set by the given id.

Returns:
empty array if no working sets defined.
Throws:
AccessRightsException

findProjectsByWorkingSet

ProjectDto[] findProjectsByWorkingSet(java.lang.String token,
                                      java.lang.Integer workingSetId)
Returns all projects defined in the working sets.

Parameters:
workingSetId - the working set id.
Returns:
empty array if working set not found.
See Also:
findAllWorkingSets(String)

selectWorkingSet

void selectWorkingSet(java.lang.String token,
                      java.lang.Integer workingSetId)
Select a workingSet.

Parameters:
token - The token
workingSetId - The id of workingset, or null if you want to remove all previous workingset selection.

getSelectedWorkingSetProjects

java.util.List<ProjectDto> getSelectedWorkingSetProjects(java.lang.String token)
Get the projects in the currently selected workingset.

Parameters:
token -
Returns:
The list of projects (ProjectDtos)

loadForumPostBlob

BinaryStreamDto loadForumPostBlob(java.lang.String token,
                                  java.lang.Integer forumPostId)
Load the blob info from the ForumPostDto's table

Parameters:
forumPostId -
Returns:
The Dto contains the blob data and some minimal information too

saveForumPostBlob

void saveForumPostBlob(java.lang.String token,
                       java.lang.Integer forumPostId,
                       BinaryStreamDto binaryStreamDto)
Save blob data to the ForumPostDto's table

Parameters:
forumPostId -
binaryStreamDto -

loadArtifactCommentBlob

BinaryStreamDto loadArtifactCommentBlob(java.lang.String token,
                                        java.lang.Integer abstractCommentDtoId)
Load the blob info from the ArtifactCommentDto's table

Parameters:
abstractCommentDtoId -
Returns:
The Dto contains the blob data and some minimal information too

saveArtifactCommentBlob

void saveArtifactCommentBlob(java.lang.String token,
                             java.lang.Integer abstractCommentDtoId,
                             BinaryStreamDto binaryStreamDto)
Save blob data to the ArtifactCommentDto's table

Parameters:
abstractCommentDtoId -
binaryStreamDto -

loadTrackerItemAttachmentBlob

BinaryStreamDto loadTrackerItemAttachmentBlob(java.lang.String token,
                                              java.lang.Integer trackerItemAttachmentDtoId)
Load the blob info from the TrackerItemAttachmentDto's table

Parameters:
trackerItemAttachmentDtoId -
Returns:
The Dto contains the blob data and some minimal information too

saveTrackerItemAttachmentBlob

void saveTrackerItemAttachmentBlob(java.lang.String token,
                                   java.lang.Integer trackerItemAttachmentDtoId,
                                   BinaryStreamDto binaryStreamDto)
Save blob data to the TrackerItemAttachmentDto's table

Parameters:
trackerItemAttachmentDtoId -
binaryStreamDto -

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.