com.jamasoftware.contour.soap.v3

Interface ContourSoapService

All Known Implementing Classes:

ContourSoapServiceImpl

public interface ContourSoapService

Method Summary

Methods

Modifier and Type	Method and Description
Boolean	addAttachmentToItem(WsAuth token, Long attachmentDocId, Long itemId)
WsChangeRequestAssociation	addChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation)
WsComment	addComment(WsAuth token, WsComment comment)
WsItem	addItem(WsAuth token, WsItem item)
WsItem[]	addItems(WsAuth token, WsItem[] items)
void	addLookup(WsAuth token, WsLookup lookup)
void	addOrganization(WsAuth token, WsOrganization organization)
WsProject	addProject(WsAuth token, WsProject project)
WsPropertyEntry	addPropertyEntry(WsAuth token, WsPropertyEntry propertyEntry)
WsPropertyList	addPropertyList(WsAuth token, WsPropertyList propertyList)
WsRelease	addRelease(WsAuth token, Integer projectId, WsRelease release)
Boolean	addSubscribersToItem(WsAuth token, Long itemId, WsUser[] users)
void	addUser(WsAuth token, WsUser user)
Boolean	clearSuspectLinksForItem(WsAuth token, Long itemId)
Boolean	clearSuspectLinksForProject(WsAuth token, Long projectId)
Boolean	closeChangeRequest(WsAuth token, Integer changeRequestItemId)
WsBaseline	createBaseline(WsAuth token, WsBaseline baseline)
WsBaseline	createBaselineFromFilter(WsAuth token, String baselineName, String description, WsFilter filter)
WsItem	createNewTestCycle(WsAuth token, Integer testPlanId, String cycleName, String cycleDescription, Date startDate, Date endDate, List<WsTestRunStatus> statusesToInclude, List<WsTestGroup> testGroupsToInclude)
WsRelationship[]	createRelationships(WsAuth token, WsRelationship[] listOfRelationships)
Boolean	deactivateBaseline(WsAuth token, WsBaseline baseline)
Boolean	deactivateItem(WsAuth token, Long itemId)
Boolean	deactivateLookup(WsAuth token, WsLookup lookupToDeactivate, WsLookup replacementLookup)
Boolean	deactivateProject(WsAuth token, WsProject project)
Boolean	deactivateUser(WsAuth token, Long userId)
Boolean	deleteAttachment(WsAuth token, Long attachmentDocId)
Boolean	deleteChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation)
Boolean	deleteComment(WsAuth token, Long commentId)
Boolean	deleteOrganization(WsAuth token, Long organizationId)
Boolean	deleteProject(WsAuth token, WsProject project)
Boolean	deletePropertyEntry(WsAuth token, WsPropertyEntry propertyEntry)
Boolean	deletePropertyList(WsAuth token, WsPropertyList propertylist)
Boolean	deleteRelationship(WsAuth token, WsRelationship relationship)
Boolean	deleteRelease(WsAuth token, Long releaseId, Long swapReleaseId)
WsTestRunStatus	executeTestRun(WsAuth token, Integer testRunId, Integer durationInMinutes, String actualResults, Boolean passedWithErrors, List<WsTestRunStep> steps)
void	executeWorkflowTransition(WsAuth token, Integer documentId, WsWorkflowTransition transition)
WsActivity[]	getActivities(WsAuth token, Long projectId, int start, int count)
WsAttachment	getAttachment(WsAuth token, Long attachmentDocId)
WsAttachment[]	getAttachments(WsAuth token, Long projectId)
WsAttachment[]	getAttachmentsForItem(WsAuth token, Long itemId)
List<WsWorkflowTransition>	getAvailableWorkflowTransitions(WsAuth token, Integer documentId)
WsBaseline	getBaseline(WsAuth token, Long baselineId)
WsBaseline[]	getBaselinesForProject(WsAuth token, Long projectId)
WsChangeRequestAssociation	getChangeRequestAssociation(WsAuth token, Long changeRequestAssociationId)
WsChangeRequestAssociation[]	getChangeRequestAssociations(WsAuth token, Integer changeRequestItemId)
WsItem[]	getChildrenOfItem(WsAuth token, Long itemId, Boolean recursive, int start, int count)
WsComment	getComment(WsAuth token, Long commentId)
WsComment[]	getComments(WsAuth token, Long itemId)
WsVersion	getCurrentVersionForItem(WsAuth token, Long itemId)
WsDocumentType	getDocumentType(WsAuth token, Long documentTypeId)
WsField[]	getDocumentTypeFields(WsAuth token, Long documentTypeId)
WsDocumentType[]	getDocumentTypes(WsAuth token, Long organizationId)
WsDocumentType[]	getDocumentTypesForProject(WsAuth token, Long projectId)
WsItem[]	getDownstreamRelated(WsAuth token, Long itemId)
WsRelationship[]	getDownstreamRelationships(WsAuth token, Long itemId)
WsExecutableTestRun	getExecutableTestRun(WsAuth token, Integer testRunId)
WsFilter	getFilter(WsAuth token, Long filterId)
WsFilter[]	getFiltersForProject(WsAuth token, Long projectId)
WsItem	getItem(WsAuth token, Long itemId)
String[]	getItemFieldNames(WsAuth token, Long itemId)
WsField[]	getItemFields(WsAuth token, Long itemId)
WsItem[]	getItemsForBaseline(WsAuth token, Long baselineId, Integer start, Integer count)
WsItem[]	getItemsForProject(WsAuth token, Long projectId, int start, int count)
WsItem[]	getItemsForProjectAndDocumentType(WsAuth token, Long projectId, Long documentTypeId, int start, int count)
WsItem[]	getItemsFromFilter(WsAuth token, WsFilter filter, Integer start, Integer count)
WsItem[]	getItemsFromTextSearch(WsAuth token, String searchTerms, Integer start, Integer count)
WsItem[]	getItemsWithAttachment(WsAuth token, Long attachmentDocId)
WsLookup	getLookup(WsAuth token, Integer lookupId)
WsLookup[]	getLookupsFromType(WsAuth token, Integer lookupTypeId)
WsLookupType	getLookupType(WsAuth token, Integer lookupTypeId)
Integer	getNumItemsFromFilter(WsAuth token, WsFilter filter)
Integer	getNumItemsFromTextSearch(WsAuth token, String searchTerms)
WsOrganization	getOrganization(WsAuth token, Long organizationId)
WsOrganization[]	getOrganizations(WsAuth token)
WsPermissions	getPermissionsByRefAndScope(WsAuth token, Integer refId, Integer scope)
WsProject	getProject(WsAuth token, Integer projectId)
WsProject[]	getProjects(WsAuth token)
WsPropertyEntry	getPropertyEntry(WsAuth token, Integer refId, Integer scope, String propertyName)
WsPropertyList	getPropertyList(WsAuth token, Integer refId, Integer scope)
WsRelationship	getRelationship(WsAuth token, Long relationshipId)
WsRelationship[]	getRelationshipsForProject(WsAuth token, Long projectId)
WsRelationship[]	getRelationshipsFromFilter(WsAuth token, WsFilter filter, Boolean downstream)
WsRelationshipType[]	getRelationshipTypeList(WsAuth token, Long organizationId)
WsRelease	getRelease(WsAuth token, Long releaseId)
WsRelease[]	getReleases(WsAuth token, WsProject project)
WsServerInfo	getServerInfo(WsAuth token)
WsUser[]	getSubscribersToAnItem(WsAuth token, Long itemId)
List<WsTestGroup>	getTestPlanGroups(WsAuth token, Integer testPlanId)
WsItem[]	getUpstreamRelated(WsAuth token, Long itemId)
WsRelationship[]	getUpstreamRelationships(WsAuth token, Long itemId)
String	getUrlForAttachment(WsAuth token, Long attachmentDocId)
String	getUrlForItem(WsAuth token, Long itemId)
WsUser	getUser(WsAuth token, Integer userId)
WsUser	getUserFromAuth(WsAuth token)
WsUser[]	getUsers(WsAuth token)
WsVersion	getVersion(WsAuth token, Long versionId)
WsVersion[]	getVersionsForItem(WsAuth token, Long itemId)
Boolean	isChangeRequest(WsAuth token, Integer itemId)
Boolean	isValidDocumentPlacement(WsAuth token, Long documentTypeId, Long parentId)
Boolean	moveDocument(WsAuth token, Long itemId, Long newParentId)
Boolean	removeAttachmentFromItem(WsAuth token, Long attachmentDocId, Long itemId)
WsComment	replyToComment(WsAuth token, String commentText, long commentToReplyTo)
Boolean	revokeSignatureFromBaseline(WsAuth token, Long baselineId, String revokeComments)
Boolean	signBaseline(WsAuth token, Long baselineId, String comments)
Boolean	testConnection(WsAuth token)
WsBaseline	updateBaseline(WsAuth token, Long baselineId, String newName, String newDescription)
WsChangeRequestAssociation	updateChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation)
WsComment	updateComment(WsAuth token, WsComment comment)
WsItem	updateItem(WsAuth token, WsItem item)
WsItem[]	updateItems(WsAuth token, WsItem[] item)
WsItem	updateItemValues(WsAuth token, Long itemId, WsField[] fields, String comments, WsUser[] notifyUsers)
WsLookup	updateLookup(WsAuth token, WsLookup lookup)
WsOrganization	updateOrganization(WsAuth token, WsOrganization organization)
WsProject	updateProject(WsAuth token, WsProject project)
WsPropertyEntry	updatePropertyEntry(WsAuth token, WsPropertyEntry wsPropertyEntry)
WsPropertyList	updatePropertyList(WsAuth token, WsPropertyList wsPropertylist)
WsRelationship	updateRelationship(WsAuth token, WsRelationship relationship)
WsRelease	updateRelease(WsAuth token, WsRelease release)
WsUser	updateUser(WsAuth token, WsUser user)

Method Detail

getServerInfo

WsServerInfo getServerInfo(WsAuth token)

testConnection

Boolean testConnection(WsAuth token)

getOrganizations

WsOrganization[] getOrganizations(WsAuth token)

getOrganization

WsOrganization getOrganization(WsAuth token,
                             Long organizationId)

deleteOrganization

Boolean deleteOrganization(WsAuth token,
                         Long organizationId)

addOrganization

void addOrganization(WsAuth token,
                   WsOrganization organization)

updateOrganization

WsOrganization updateOrganization(WsAuth token,
                                WsOrganization organization)

getProjects

WsProject[] getProjects(WsAuth token)

getProject

WsProject getProject(WsAuth token,
                   Integer projectId)

deleteProject

Boolean deleteProject(WsAuth token,
                    WsProject project)

deactivateProject

Boolean deactivateProject(WsAuth token,
                        WsProject project)

addProject

WsProject addProject(WsAuth token,
                   WsProject project)
                     throws WsException

Throws:

WsException

updateProject

WsProject updateProject(WsAuth token,
                      WsProject project)
                        throws WsException

Throws:

WsException

getRelease

WsRelease getRelease(WsAuth token,
                   Long releaseId)

getReleases

WsRelease[] getReleases(WsAuth token,
                      WsProject project)

deleteRelease

Boolean deleteRelease(WsAuth token,
                    Long releaseId,
                    Long swapReleaseId)

addRelease

WsRelease addRelease(WsAuth token,
                   Integer projectId,
                   WsRelease release)

updateRelease

WsRelease updateRelease(WsAuth token,
                      WsRelease release)

getItem

WsItem getItem(WsAuth token,
             Long itemId)

getUrlForItem

String getUrlForItem(WsAuth token,
                   Long itemId)

getItemsForProject

WsItem[] getItemsForProject(WsAuth token,
                          Long projectId,
                          int start,
                          int count)

getItemsForBaseline

WsItem[] getItemsForBaseline(WsAuth token,
                           Long baselineId,
                           Integer start,
                           Integer count)

getItemsForProjectAndDocumentType

WsItem[] getItemsForProjectAndDocumentType(WsAuth token,
                                         Long projectId,
                                         Long documentTypeId,
                                         int start,
                                         int count)

getItemsFromFilter

WsItem[] getItemsFromFilter(WsAuth token,
                          WsFilter filter,
                          Integer start,
                          Integer count)

getNumItemsFromFilter

Integer getNumItemsFromFilter(WsAuth token,
                            WsFilter filter)

getItemsFromTextSearch

WsItem[] getItemsFromTextSearch(WsAuth token,
                              String searchTerms,
                              Integer start,
                              Integer count)

getNumItemsFromTextSearch

Integer getNumItemsFromTextSearch(WsAuth token,
                                String searchTerms)

getItemFields

WsField[] getItemFields(WsAuth token,
                      Long itemId)

getItemFieldNames

String[] getItemFieldNames(WsAuth token,
                         Long itemId)

isValidDocumentPlacement

Boolean isValidDocumentPlacement(WsAuth token,
                               Long documentTypeId,
                               Long parentId)

moveDocument

Boolean moveDocument(WsAuth token,
                   Long itemId,
                   Long newParentId)

getVersion

WsVersion getVersion(WsAuth token,
                   Long versionId)

getVersionsForItem

WsVersion[] getVersionsForItem(WsAuth token,
                             Long itemId)

getCurrentVersionForItem

WsVersion getCurrentVersionForItem(WsAuth token,
                                 Long itemId)

addItems

WsItem[] addItems(WsAuth token,
                WsItem[] items)

addItem

WsItem addItem(WsAuth token,
             WsItem item)

deactivateItem

Boolean deactivateItem(WsAuth token,
                     Long itemId)

updateItems

WsItem[] updateItems(WsAuth token,
                   WsItem[] item)

updateItem

WsItem updateItem(WsAuth token,
                WsItem item)

updateItemValues

WsItem updateItemValues(WsAuth token,
                      Long itemId,
                      WsField[] fields,
                      String comments,
                      WsUser[] notifyUsers)

addSubscribersToItem

Boolean addSubscribersToItem(WsAuth token,
                           Long itemId,
                           WsUser[] users)

getSubscribersToAnItem

WsUser[] getSubscribersToAnItem(WsAuth token,
                              Long itemId)

getChildrenOfItem

WsItem[] getChildrenOfItem(WsAuth token,
                         Long itemId,
                         Boolean recursive,
                         int start,
                         int count)

getDocumentType

WsDocumentType getDocumentType(WsAuth token,
                             Long documentTypeId)

getDocumentTypes

WsDocumentType[] getDocumentTypes(WsAuth token,
                                Long organizationId)

getDocumentTypesForProject

WsDocumentType[] getDocumentTypesForProject(WsAuth token,
                                          Long projectId)

getDocumentTypeFields

WsField[] getDocumentTypeFields(WsAuth token,
                              Long documentTypeId)

getDownstreamRelated

WsItem[] getDownstreamRelated(WsAuth token,
                            Long itemId)

getUpstreamRelated

WsItem[] getUpstreamRelated(WsAuth token,
                          Long itemId)

getDownstreamRelationships

WsRelationship[] getDownstreamRelationships(WsAuth token,
                                          Long itemId)

getUpstreamRelationships

WsRelationship[] getUpstreamRelationships(WsAuth token,
                                        Long itemId)

getRelationship

WsRelationship getRelationship(WsAuth token,
                             Long relationshipId)

getRelationshipsForProject

WsRelationship[] getRelationshipsForProject(WsAuth token,
                                          Long projectId)

getRelationshipsFromFilter

WsRelationship[] getRelationshipsFromFilter(WsAuth token,
                                          WsFilter filter,
                                          Boolean downstream)

updateRelationship

WsRelationship updateRelationship(WsAuth token,
                                WsRelationship relationship)

deleteRelationship

Boolean deleteRelationship(WsAuth token,
                         WsRelationship relationship)

createRelationships

WsRelationship[] createRelationships(WsAuth token,
                                   WsRelationship[] listOfRelationships)

getRelationshipTypeList

WsRelationshipType[] getRelationshipTypeList(WsAuth token,
                                           Long organizationId)

getBaseline

WsBaseline getBaseline(WsAuth token,
                     Long baselineId)

getBaselinesForProject

WsBaseline[] getBaselinesForProject(WsAuth token,
                                  Long projectId)

signBaseline

Boolean signBaseline(WsAuth token,
                   Long baselineId,
                   String comments)

revokeSignatureFromBaseline

Boolean revokeSignatureFromBaseline(WsAuth token,
                                  Long baselineId,
                                  String revokeComments)

createBaseline

WsBaseline createBaseline(WsAuth token,
                        WsBaseline baseline)

createBaselineFromFilter

WsBaseline createBaselineFromFilter(WsAuth token,
                                  String baselineName,
                                  String description,
                                  WsFilter filter)

deactivateBaseline

Boolean deactivateBaseline(WsAuth token,
                         WsBaseline baseline)

updateBaseline

WsBaseline updateBaseline(WsAuth token,
                        Long baselineId,
                        String newName,
                        String newDescription)

getFilter

WsFilter getFilter(WsAuth token,
                 Long filterId)

getFiltersForProject

WsFilter[] getFiltersForProject(WsAuth token,
                              Long projectId)

getUsers

WsUser[] getUsers(WsAuth token)

getUser

WsUser getUser(WsAuth token,
             Integer userId)

getUserFromAuth

WsUser getUserFromAuth(WsAuth token)

deactivateUser

Boolean deactivateUser(WsAuth token,
                     Long userId)

addUser

void addUser(WsAuth token,
           WsUser user)

updateUser

WsUser updateUser(WsAuth token,
                WsUser user)

getComment

WsComment getComment(WsAuth token,
                   Long commentId)

getComments

WsComment[] getComments(WsAuth token,
                      Long itemId)

addComment

WsComment addComment(WsAuth token,
                   WsComment comment)

replyToComment

WsComment replyToComment(WsAuth token,
                       String commentText,
                       long commentToReplyTo)

updateComment

WsComment updateComment(WsAuth token,
                      WsComment comment)

deleteComment

Boolean deleteComment(WsAuth token,
                    Long commentId)

getActivities

WsActivity[] getActivities(WsAuth token,
                         Long projectId,
                         int start,
                         int count)

clearSuspectLinksForItem

Boolean clearSuspectLinksForItem(WsAuth token,
                               Long itemId)

clearSuspectLinksForProject

Boolean clearSuspectLinksForProject(WsAuth token,
                                  Long projectId)

addPropertyEntry

WsPropertyEntry addPropertyEntry(WsAuth token,
                               WsPropertyEntry propertyEntry)

addPropertyList

WsPropertyList addPropertyList(WsAuth token,
                             WsPropertyList propertyList)

deletePropertyEntry

Boolean deletePropertyEntry(WsAuth token,
                          WsPropertyEntry propertyEntry)

deletePropertyList

Boolean deletePropertyList(WsAuth token,
                         WsPropertyList propertylist)

getPropertyEntry

WsPropertyEntry getPropertyEntry(WsAuth token,
                               Integer refId,
                               Integer scope,
                               String propertyName)

getPropertyList

WsPropertyList getPropertyList(WsAuth token,
                             Integer refId,
                             Integer scope)

updatePropertyEntry

WsPropertyEntry updatePropertyEntry(WsAuth token,
                                  WsPropertyEntry wsPropertyEntry)

updatePropertyList

WsPropertyList updatePropertyList(WsAuth token,
                                WsPropertyList wsPropertylist)

addAttachmentToItem

Boolean addAttachmentToItem(WsAuth token,
                          Long attachmentDocId,
                          Long itemId)

getUrlForAttachment

String getUrlForAttachment(WsAuth token,
                         Long attachmentDocId)

getAttachment

WsAttachment getAttachment(WsAuth token,
                         Long attachmentDocId)

getAttachments

WsAttachment[] getAttachments(WsAuth token,
                            Long projectId)

getItemsWithAttachment

WsItem[] getItemsWithAttachment(WsAuth token,
                              Long attachmentDocId)

getAttachmentsForItem

WsAttachment[] getAttachmentsForItem(WsAuth token,
                                   Long itemId)

deleteAttachment

Boolean deleteAttachment(WsAuth token,
                       Long attachmentDocId)

removeAttachmentFromItem

Boolean removeAttachmentFromItem(WsAuth token,
                               Long attachmentDocId,
                               Long itemId)

addLookup

void addLookup(WsAuth token,
             WsLookup lookup)

deactivateLookup

Boolean deactivateLookup(WsAuth token,
                       WsLookup lookupToDeactivate,
                       WsLookup replacementLookup)

getLookup

WsLookup getLookup(WsAuth token,
                 Integer lookupId)

getLookupType

WsLookupType getLookupType(WsAuth token,
                         Integer lookupTypeId)

getLookupsFromType

WsLookup[] getLookupsFromType(WsAuth token,
                            Integer lookupTypeId)

updateLookup

WsLookup updateLookup(WsAuth token,
                    WsLookup lookup)

getChangeRequestAssociation

WsChangeRequestAssociation getChangeRequestAssociation(WsAuth token,
                                                     Long changeRequestAssociationId)

isChangeRequest

Boolean isChangeRequest(WsAuth token,
                      Integer itemId)

getChangeRequestAssociations

WsChangeRequestAssociation[] getChangeRequestAssociations(WsAuth token,
                                                        Integer changeRequestItemId)

addChangeRequestAssociation

WsChangeRequestAssociation addChangeRequestAssociation(WsAuth token,
                                                     WsChangeRequestAssociation changeRequestAssociation)

updateChangeRequestAssociation

WsChangeRequestAssociation updateChangeRequestAssociation(WsAuth token,
                                                        WsChangeRequestAssociation changeRequestAssociation)

deleteChangeRequestAssociation

Boolean deleteChangeRequestAssociation(WsAuth token,
                                     WsChangeRequestAssociation changeRequestAssociation)

closeChangeRequest

Boolean closeChangeRequest(WsAuth token,
                         Integer changeRequestItemId)

getPermissionsByRefAndScope

WsPermissions getPermissionsByRefAndScope(WsAuth token,
                                        Integer refId,
                                        Integer scope)

getAvailableWorkflowTransitions

List<WsWorkflowTransition> getAvailableWorkflowTransitions(WsAuth token,
                                                         Integer documentId)

executeWorkflowTransition

void executeWorkflowTransition(WsAuth token,
                             Integer documentId,
                             WsWorkflowTransition transition)

getExecutableTestRun

WsExecutableTestRun getExecutableTestRun(WsAuth token,
                                       Integer testRunId)

executeTestRun

WsTestRunStatus executeTestRun(WsAuth token,
                             Integer testRunId,
                             Integer durationInMinutes,
                             String actualResults,
                             Boolean passedWithErrors,
                             List<WsTestRunStep> steps)

getTestPlanGroups

List<WsTestGroup> getTestPlanGroups(WsAuth token,
                                  Integer testPlanId)

createNewTestCycle

WsItem createNewTestCycle(WsAuth token,
                        Integer testPlanId,
                        String cycleName,
                        String cycleDescription,
                        Date startDate,
                        Date endDate,
                        List<WsTestRunStatus> statusesToInclude,
                        List<WsTestGroup> testGroupsToInclude)