com.jamasoftware.contour.ws.v2
Class ContourSoapServiceImpl

java.lang.Object
  com.jamasoftware.contour.ws.v2.ContourSoapServiceImpl

All Implemented Interfaces:

com.jamasoftware.contour.ws.v2.ContourSoapService

public class ContourSoapServiceImpl
extends java.lang.Object
implements com.jamasoftware.contour.ws.v2.ContourSoapService

Web Services for Jama Contour.

Constructor Summary

ContourSoapServiceImpl()

Method Summary

boolean	addAttachmentToItem(WsAuth token, java.lang.Long attachmentDocId, java.lang.Long itemId) Adds an existing Attachment to an Item.
void	addComment(WsAuth token, WsComment wsComment) Adds a new Comment based on the scope provided in the WsComment.
WsItem	addItem(WsAuth token, WsItem item) Adds a new Item.
WsItem[]	addItems(WsAuth token, WsItem[] items) Adds multiple Items.
void	addLookup(WsAuth token, WsLookup wsLookup) Adds a new Lookup value.
WsModule	addModule(WsAuth token, WsModule module) Adds a new Module.
void	addOrganization(WsAuth token, WsOrganization organization) Adds a new Organization.
WsProject	addProject(WsAuth token, WsProject project) Adds a new Project.
void	addPropertyEntry(WsAuth token, WsPropertyEntry wsPropertyEntry) Adds a new Property Entry.
void	addPropertyList(WsAuth token, WsPropertyList wsPropertyList) Adds a new list of Property Entries.
WsRelease	addRelease(WsAuth token, java.lang.Integer projectId, WsRelease release) Adds a new Release.
void	addSubscribersToItem(WsAuth token, java.lang.Long itemId, WsUser[] users) Subscribes Users to an Item.
void	addUser(WsAuth token, WsUser wsUser) Adds a new User.
void	clearSuspectLinksForItem(WsAuth token, java.lang.Long itemId) Clears the suspect links for an Item.
void	clearSuspectLinksForProject(WsAuth token, java.lang.Long projectId) Clears the suspect links for a Project.
boolean	createBaseline(WsAuth token, WsBaseline wsBaseline) Creates a Baseline.
boolean	createBaselineFromFilter(WsAuth token, java.lang.String baselineName, java.lang.String description, WsFilter filter) Creates a Baseline from a Filter.
void	createRelationships(WsAuth token, WsRelationship[] listOfRelationships) Creates multiple Relationships.
boolean	deactivateBaseline(WsAuth token, WsBaseline wsBaseline) Deactivates a Baseline.
void	deactivateItem(WsAuth token, java.lang.Long itemId) Deactivates the Item.
void	deactivateModule(WsAuth token, java.lang.Long moduleId) Deactivates the Module.
void	deactivateProject(WsAuth token, WsProject project) Deactivates the Project.
void	deactivateUser(WsAuth token, java.lang.Long userId) Deactivates the User.
void	deleteAttachment(WsAuth token, java.lang.Long attachmentId) Deletes an Attachment from the server.
void	deleteComment(WsAuth token, java.lang.Long commentId) Deletes a Comment.
void	deleteOrganization(WsAuth token, java.lang.Long organizationId) Deletes the Organization.
void	deleteProject(WsAuth token, WsProject project) Deletes the Project.
void	deletePropertyEntry(WsAuth token, WsPropertyEntry wsPropertyEntry) Deletes a property entry.
void	deletePropertyList(WsAuth token, WsPropertyList wsPropertylist) Deletes a list of Property Entries.
void	deleteRelease(WsAuth token, java.lang.Long releaseId, java.lang.Long swapReleaseId) Deletes the Release.
WsActivity[]	getActivities(WsAuth token, java.lang.Long projectId, int count, int start) Gets the latest entries in a Project's Activity Stream.
WsAttachment	getAttachment(WsAuth token, java.lang.Long attachmentDocId) Gets an Attachment.
WsAttachment[]	getAttachments(WsAuth token, java.lang.Long projectId) Gets all the Attachments in a Project.
WsAttachment[]	getAttachmentsForItem(WsAuth token, java.lang.Long itemId) Gets all Attachments attached to a specified Item.
WsBaseline	getBaseline(WsAuth token, java.lang.Long baselineId) Gets a Baseline.
WsBaseline[]	getBaselinesForProject(WsAuth token, java.lang.Long projectId) Gets all the Baselines in a Project.
WsItem[]	getChildrenOfItem(WsAuth token, java.lang.Long itemId, java.lang.Boolean recursive, int start, int count) Gets the children of an Item/Folder.
WsComment	getComment(WsAuth token, java.lang.Long commentId) Gets a Comment.
WsComment[]	getComments(WsAuth token, java.lang.Long itemId) Gets all Comments from an Item.
WsItem[]	getDownstreamRelated(WsAuth token, java.lang.Long itemId) Gets all Items downstream of an Item.
WsFilter	getFilter(WsAuth token, java.lang.Long filterId) Gets a Filter.
WsFilter[]	getFiltersForModule(WsAuth token, java.lang.Long moduleId) Gets all Filters for a Module.
WsFilter[]	getFiltersForProject(WsAuth token, java.lang.Long projectId) Gets all Filters for a Project.
WsItem	getItem(WsAuth token, java.lang.Long itemId) Gets an Item.
java.lang.String[]	getItemFieldNames(WsAuth token, java.lang.Long itemId) Returns an array of the field names for an Item.
WsField[]	getItemFields(WsAuth token, java.lang.Long itemId) Returns an array of all WsFields for an Item.
WsItem[]	getItemsForBaseline(WsAuth token, java.lang.Long baselineId, int start, int count) Gets all the Items in a Baseline.
WsItem[]	getItemsForModule(WsAuth token, java.lang.Long moduleId, int start, int count) Gets all the Items in a Module.
WsItem[]	getItemsForProject(WsAuth token, java.lang.Long projectId, int start, int count) Gets all the Items in a Project.
WsItem[]	getItemsFromFilterWithLimit(WsAuth token, WsFilter filter, int start, int count) Gets all the Items based on a Filter.
WsItem[]	getItemsFromTextSearch(WsAuth token, java.lang.String searchTerms, int start, int count) Gets all the Items based on a text search.
WsItem[]	getItemsWithAttachment(WsAuth token, java.lang.Long attachmentDocId) Gets all Items that have a specified Attachment attached to it.
WsLookup	getLookup(WsAuth token, java.lang.Integer lookupId) Gets a lookup value.
WsModule	getModule(WsAuth token, java.lang.Integer moduleId) Gets a Module.
WsModule[]	getModules(WsAuth token, java.lang.Integer projectId) Gets all Modules in a Project.
WsOrganization	getOrganization(WsAuth token, java.lang.Long organizationId) Gets an Organization.
WsOrganization[]	getOrganizations(WsAuth token) Gets all Organizations in this Contour installation.
WsProject	getProject(WsAuth token, java.lang.Integer projectId) Gets a Project.
WsProject[]	getProjects(WsAuth token) Gets all Projects in the current Organization.
WsPropertyEntry	getPropertyEntry(WsAuth token, java.lang.Integer refId, java.lang.Integer scope, java.lang.String propertyName) Gets a Property Entry.
WsPropertyList	getPropertyList(WsAuth token, java.lang.Integer refId, java.lang.Integer scope) Gets a list of Property Entries.
WsRelease	getRelease(WsAuth token, long releaseId) Gets a Release.
WsRelease[]	getReleases(WsAuth token, WsProject project) Gets all the Releases for a Project.
WsServerInfo	getServerInfo(WsAuth token) Gets basic info about the server Contour is installed on.
WsUser[]	getSubscribersToAnItem(WsAuth token, java.lang.Long itemId) Gets Users that are subscribed to an Item.
WsItem[]	getUpstreamRelated(WsAuth token, java.lang.Long itemId) Gets all the upstream related Items.
java.lang.String	getUrlForAttachment(WsAuth token, java.lang.Long attachmentDocId) Gets the URL for an Attachment.
java.lang.String	getUrlForItem(WsAuth token, java.lang.Long itemId) Gets the URL for an Item.
WsUser	getUser(WsAuth token, java.lang.Integer userId) Gets a User.
WsUser	getUserFromAuth(WsAuth token) Gets the User that is being used for authentication.
WsUser[]	getUsers(WsAuth token) Gets all the Users for the Organization.
WsVersion[]	getVersionsForItem(WsAuth token, java.lang.Long itemId) Gets all the Versions for an Item.
void	removeAttachmentFromItem(WsAuth token, java.lang.Long attachmentId, java.lang.Long itemId) Removes the association between an Attachment and an Item.
void	removeLookup(WsAuth token, WsLookup lookupToRemove, WsLookup replacementLookup) Removes an existing lookup value.
void	replyToComment(WsAuth token, java.lang.String commentText, long commentToReplyTo) Replies to an existing Comment.
boolean	revokeSignatureFromBaseline(WsAuth token, java.lang.Long baselineId, java.lang.String revokeComments) Revokes an Electronic Signature from a Baseline.
boolean	signBaseline(WsAuth token, java.lang.Long baselineId, java.lang.String comments) Electronically signs a Baseline.
java.lang.Boolean	testConnection(WsAuth token) Tests that a successful connection has been made.
boolean	updateBaseline(WsAuth token, java.lang.Long baselineId, java.lang.String newName, java.lang.String newDescription) Updates an existing Baseline.
WsComment	updateComment(WsAuth token, WsComment comment) Updates an existing Comment.
WsItem	updateItem(WsAuth token, WsItem item) Updates an existing Item.
WsItem[]	updateItems(WsAuth token, WsItem[] items) Updates existing Items.
WsItem	updateItemValues(WsAuth token, java.lang.Long itemId, WsField[] fieldValues, java.lang.String comments, WsUser[] notifyUsers) Updates the specified values for an existing Item.
void	updateLookup(WsAuth token, WsLookup wsLookup) Updates an existing lookup value.
WsModule	updateModule(WsAuth token, WsModule module) Updates an existing Module.
WsOrganization	updateOrganization(WsAuth token, WsOrganization organization) Updates an existing Organization.
WsProject	updateProject(WsAuth token, WsProject project) Updates an existing Project.
void	updatePropertyEntry(WsAuth token, WsPropertyEntry wsPropertyEntry) Updates an existing Property Entry.
void	updatePropertyList(WsAuth token, WsPropertyList wsPropertylist) Updates a list of existing Property Entries.
WsRelease	updateRelease(WsAuth token, WsRelease release) Updates an existing Release.
void	updateUser(WsAuth token, WsUser user) Updates an existing User.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContourSoapServiceImpl

public ContourSoapServiceImpl()

Method Detail

addAttachmentToItem

public boolean addAttachmentToItem(WsAuth token,
                                   java.lang.Long attachmentDocId,
                                   java.lang.Long itemId)
                            throws java.lang.Exception

Adds an existing Attachment to an Item.

Specified by:

addAttachmentToItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

itemId - id of the item to add the attachment to

Returns:

whether or not the attachment was successfully added

Throws:

java.lang.Exception

addComment

public void addComment(WsAuth token,
                       WsComment wsComment)
                throws java.lang.Exception

Adds a new Comment based on the scope provided in the WsComment. Currently only WsScope.DOCUMENT is supported.

Specified by:

addComment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsComment - the comment to add

Throws:

java.lang.Exception

addItem

public WsItem addItem(WsAuth token,
                      WsItem item)
               throws java.lang.Exception

Adds a new Item.

Specified by:

addItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

item - an item to add

Returns:

the item added@

Throws:

java.lang.Exception

addItems

public WsItem[] addItems(WsAuth token,
                         WsItem[] items)
                  throws java.lang.Exception

Adds multiple Items.

Specified by:

addItems in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

items - a list of items to add

Returns:

an array of the items with the new id's created

Throws:

java.lang.Exception

addLookup

public void addLookup(WsAuth token,
                      WsLookup wsLookup)

Adds a new Lookup value.

Specified by:

addLookup in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsLookup - the lookup to be added

addModule

public WsModule addModule(WsAuth token,
                          WsModule module)

Adds a new Module.

Specified by:

addModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

module - the module to add

Returns:

the module added

Throws:

java.lang.Exception

addOrganization

public void addOrganization(WsAuth token,
                            WsOrganization organization)

Adds a new Organization.

Specified by:

addOrganization in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

organization - the organization to add

Throws:

java.lang.Exception

addProject

public WsProject addProject(WsAuth token,
                            WsProject project)

Adds a new Project.

Specified by:

addProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

project - the project to add

Returns:

the project added

Throws:

java.lang.Exception

addPropertyEntry

public void addPropertyEntry(WsAuth token,
                             WsPropertyEntry wsPropertyEntry)

Adds a new Property Entry.

Specified by:

addPropertyEntry in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to be added

addPropertyList

public void addPropertyList(WsAuth token,
                            WsPropertyList wsPropertyList)

Adds a new list of Property Entries.

Specified by:

addPropertyList in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyList - A list of property entries to be added

addRelease

public WsRelease addRelease(WsAuth token,
                            java.lang.Integer projectId,
                            WsRelease release)

Adds a new Release.

Specified by:

addRelease in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - the id of the project to add the release to

release - the release to add

Returns:

the released added

Throws:

java.lang.Exception

addSubscribersToItem

public void addSubscribersToItem(WsAuth token,
                                 java.lang.Long itemId,
                                 WsUser[] users)
                          throws java.lang.Exception

Subscribes Users to an Item.

Specified by:

addSubscribersToItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - the item to be subscribed to

users - the list of users to add subscriptions for

Throws:

java.lang.Exception

addUser

public void addUser(WsAuth token,
                    WsUser wsUser)
             throws java.lang.Exception

Adds a new User.

Specified by:

addUser in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsUser - the user to add

Throws:

java.lang.Exception

clearSuspectLinksForItem

public void clearSuspectLinksForItem(WsAuth token,
                                     java.lang.Long itemId)

Clears the suspect links for an Item.

Specified by:

clearSuspectLinksForItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item to clear suspect links from

clearSuspectLinksForProject

public void clearSuspectLinksForProject(WsAuth token,
                                        java.lang.Long projectId)
                                 throws java.lang.Exception

Clears the suspect links for a Project.

Specified by:

clearSuspectLinksForProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - the id of the project to clear suspect links from

Throws:

java.lang.Exception

createBaseline

public boolean createBaseline(WsAuth token,
                              WsBaseline wsBaseline)
                       throws java.lang.Exception

Creates a Baseline.

Specified by:

createBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth token

wsBaseline - the baseline to create

Returns:

the created baseline

Throws:

java.lang.Exception

createBaselineFromFilter

public boolean createBaselineFromFilter(WsAuth token,
                                        java.lang.String baselineName,
                                        java.lang.String description,
                                        WsFilter filter)
                                 throws java.lang.Exception

Creates a Baseline from a Filter.

The filter can be an ad-hoc filter with no id, or an existing filter. If the filter id is null it will be treated as ad-hoc. If the filter id is set Contour will attempt to use an existing filter with that id. Use start and count to page the results.

Specified by:

createBaselineFromFilter in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

baselineName - name of the baseline to create

description - description of the baseline to create

filter - filter to be used to create the baseline

Returns:

whether or not the filter was successfully created

Throws:

java.lang.Exception

createRelationships

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

Creates multiple Relationships.

Specified by:

createRelationships in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

listOfRelationships - the relationships to be created

deactivateBaseline

public boolean deactivateBaseline(WsAuth token,
                                  WsBaseline wsBaseline)
                           throws java.lang.Exception

Deactivates a Baseline.

Specified by:

deactivateBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsBaseline - baseline to deactivate

Returns:

whether or not the baseline was successfully deactivated

Throws:

java.lang.Exception

deactivateItem

public void deactivateItem(WsAuth token,
                           java.lang.Long itemId)

Deactivates the Item.

Specified by:

deactivateItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item to be deactivated

deactivateModule

public void deactivateModule(WsAuth token,
                             java.lang.Long moduleId)

Deactivates the Module.

Specified by:

deactivateModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

moduleId - the id of the module to be deactivated

deactivateProject

public void deactivateProject(WsAuth token,
                              WsProject project)

Deactivates the Project.

Specified by:

deactivateProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be deactivated

deactivateUser

public void deactivateUser(WsAuth token,
                           java.lang.Long userId)

Deactivates the User.

Specified by:

deactivateUser in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

userId - the id of the user to deactivate

deleteAttachment

public void deleteAttachment(WsAuth token,
                             java.lang.Long attachmentId)

Deletes an Attachment from the server. (Caution: Irreversible)

Specified by:

deleteAttachment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentId - id of the attachment to delete

deleteComment

public void deleteComment(WsAuth token,
                          java.lang.Long commentId)
                   throws java.lang.Exception

Deletes a Comment. (Caution: Irreversible)

Specified by:

deleteComment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - for the WsAuth item

commentId - id of the comment to delete

Throws:

java.lang.Exception

deleteOrganization

public void deleteOrganization(WsAuth token,
                               java.lang.Long organizationId)

Deletes the Organization. (Caution: Irreversible)

Specified by:

deleteOrganization in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

organizationId - the id of the organization to be deleted

deleteProject

public void deleteProject(WsAuth token,
                          WsProject project)

Deletes the Project. (Caution: Irreversible)

Specified by:

deleteProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be deleted

deletePropertyEntry

public void deletePropertyEntry(WsAuth token,
                                WsPropertyEntry wsPropertyEntry)

Deletes a property entry. (Caution: Irreversible)

Specified by:

deletePropertyEntry in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to be deleted

deletePropertyList

public void deletePropertyList(WsAuth token,
                               WsPropertyList wsPropertylist)

Deletes a list of Property Entries. (Caution: Irreversible)

Specified by:

deletePropertyList in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertylist - A list of property entries to be deleted

deleteRelease

public void deleteRelease(WsAuth token,
                          java.lang.Long releaseId,
                          java.lang.Long swapReleaseId)

Deletes the Release. (Caution: Irreversible)

Specified by:

deleteRelease in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

releaseId - the release to be deleted

swapReleaseId - the release to move any items to. Can be null.

getActivities

public WsActivity[] getActivities(WsAuth token,
                                  java.lang.Long projectId,
                                  int count,
                                  int start)
                           throws java.lang.Exception

Gets the latest entries in a Project's Activity Stream. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getActivities in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - the id of the project to get the activity stream from

count - number of results to return

start - index of results to start at

Returns:

an array of WsActivitys

Throws:

java.lang.Exception

getAttachment

public WsAttachment getAttachment(WsAuth token,
                                  java.lang.Long attachmentDocId)

Gets an Attachment.

Specified by:

getAttachment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

Returns:

WsAttachment

getAttachments

public WsAttachment[] getAttachments(WsAuth token,
                                     java.lang.Long projectId)
                              throws java.lang.Exception

Gets all the Attachments in a Project.

Specified by:

getAttachments in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get attachments from

Returns:

an array of WsAttachments

Throws:

java.lang.Exception

getAttachmentsForItem

public WsAttachment[] getAttachmentsForItem(WsAuth token,
                                            java.lang.Long itemId)
                                     throws java.lang.Exception

Gets all Attachments attached to a specified Item.

Specified by:

getAttachmentsForItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item to get attachments from

Returns:

an array of WsAttachments

Throws:

java.lang.Exception

getBaseline

public WsBaseline getBaseline(WsAuth token,
                              java.lang.Long baselineId)
                       throws java.lang.Exception

Gets a Baseline.

Specified by:

getBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

baselineId - the id of the baseline to get

Returns:

the baseline

Throws:

java.lang.Exception

getBaselinesForProject

public WsBaseline[] getBaselinesForProject(WsAuth token,
                                           java.lang.Long projectId)
                                    throws java.lang.Exception

Gets all the Baselines in a Project.

Specified by:

getBaselinesForProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - the project to get baselines from

Returns:

an array of baselines

Throws:

java.lang.Exception

getChildrenOfItem

public WsItem[] getChildrenOfItem(WsAuth token,
                                  java.lang.Long itemId,
                                  java.lang.Boolean recursive,
                                  int start,
                                  int count)
                           throws java.lang.Exception

Gets the children of an Item/Folder.

Specified by:

getChildrenOfItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the parent item/folder

recursive - whether or not the results should be recursive (get grandchildren, great-grandchildren, etc...)

start - index of results to start at

count - number of results to return

Returns:

children of the parent item/folder

Throws:

java.lang.Exception

getComment

public WsComment getComment(WsAuth token,
                            java.lang.Long commentId)
                     throws java.lang.Exception

Gets a Comment.

Specified by:

getComment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

commentId - id of the comment

Returns:

WsComment

Throws:

java.lang.Exception

getComments

public WsComment[] getComments(WsAuth token,
                               java.lang.Long itemId)
                        throws java.lang.Exception

Gets all Comments from an Item.

Specified by:

getComments in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item to get comments from

Returns:

all comments on the item

Throws:

java.lang.Exception

getDownstreamRelated

public WsItem[] getDownstreamRelated(WsAuth token,
                                     java.lang.Long itemId)
                              throws java.lang.Exception

Gets all Items downstream of an Item.

Specified by:

getDownstreamRelated in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item to get downstream relationships of

Returns:

all items downstream of the source item

Throws:

java.lang.Exception

getFilter

public WsFilter getFilter(WsAuth token,
                          java.lang.Long filterId)

Gets a Filter.

Specified by:

getFilter in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

filterId - id of the filter to get

Returns:

the filter

getFiltersForModule

public WsFilter[] getFiltersForModule(WsAuth token,
                                      java.lang.Long moduleId)

Gets all Filters for a Module.

Specified by:

getFiltersForModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

moduleId - id of the module to get filters from

Returns:

an array of filters from the source module

getFiltersForProject

public WsFilter[] getFiltersForProject(WsAuth token,
                                       java.lang.Long projectId)

Gets all Filters for a Project.

Specified by:

getFiltersForProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get filters from

Returns:

an array of filters from the source project

getItem

public WsItem getItem(WsAuth token,
                      java.lang.Long itemId)
               throws java.lang.Exception

Gets an Item.

Specified by:

getItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item

Returns:

the item

Throws:

java.lang.Exception

getItemFieldNames

public java.lang.String[] getItemFieldNames(WsAuth token,
                                            java.lang.Long itemId)
                                     throws java.lang.Exception

Returns an array of the field names for an Item.

Specified by:

getItemFieldNames in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

an array of field names

Throws:

java.lang.Exception

getItemFields

public WsField[] getItemFields(WsAuth token,
                               java.lang.Long itemId)
                        throws java.lang.Exception

Returns an array of all WsFields for an Item.

Specified by:

getItemFields in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

an array of WsFields

Throws:

java.lang.Exception

getItemsForBaseline

public WsItem[] getItemsForBaseline(WsAuth token,
                                    java.lang.Long baselineId,
                                    int start,
                                    int count)
                             throws java.lang.Exception

Gets all the Items in a Baseline. Use start and count to page the results.

Specified by:

getItemsForBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

baselineId - the id of the baseline

start - index of results to start at

count - number of results to return

Returns:

an array of items

Throws:

java.lang.Exception

getItemsForModule

public WsItem[] getItemsForModule(WsAuth token,
                                  java.lang.Long moduleId,
                                  int start,
                                  int count)
                           throws java.lang.Exception

Gets all the Items in a Module. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getItemsForModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

moduleId - the id of the module

start - index of results to start at

count - number of results to return

Returns:

an array of items

Throws:

java.lang.Exception

getItemsForProject

public WsItem[] getItemsForProject(WsAuth token,
                                   java.lang.Long projectId,
                                   int start,
                                   int count)
                            throws java.lang.Exception

Gets all the Items in a Project. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getItemsForProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - the id of the project

start - index of results to start at

count - number of results to return

Returns:

an array of items

Throws:

java.lang.Exception

getItemsFromFilterWithLimit

public WsItem[] getItemsFromFilterWithLimit(WsAuth token,
                                            WsFilter filter,
                                            int start,
                                            int count)
                                     throws java.lang.Exception

Gets all the Items based on a Filter.

The filter can be an ad-hoc filter with no id, or an existing filter. If the filter id is null it will be treated as ad-hoc. If the filter id is set Contour will attempt to use an existing filter with that id. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getItemsFromFilterWithLimit in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

filter - the WsFilter to use

start - the location to start

count - the maximum number of results to return

Returns:

a list of WsItems

Throws:

java.lang.Exception

getItemsFromTextSearch

public WsItem[] getItemsFromTextSearch(WsAuth token,
                                       java.lang.String searchTerms,
                                       int start,
                                       int count)
                                throws java.lang.Exception

Gets all the Items based on a text search. Keyword or Lucene syntax. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getItemsFromTextSearch in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

searchTerms - the search query

start - index of results to start at

count - number of results to return

Returns:

an array of items

Throws:

java.lang.Exception

See Also:

Lucene Syntax

getItemsWithAttachment

public WsItem[] getItemsWithAttachment(WsAuth token,
                                       java.lang.Long attachmentDocId)
                                throws java.lang.Exception

Gets all Items that have a specified Attachment attached to it.

Specified by:

getItemsWithAttachment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

Returns:

an array of WsItems

Throws:

java.lang.Exception

getLookup

public WsLookup getLookup(WsAuth token,
                          java.lang.Integer lookupId)

Gets a lookup value.

Specified by:

getLookup in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

lookupId - id of the lookup to get

Returns:

WsLookup

getModule

public WsModule getModule(WsAuth token,
                          java.lang.Integer moduleId)

Gets a Module.

Specified by:

getModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

moduleId - id of the module to get

Returns:

the module

getModules

public WsModule[] getModules(WsAuth token,
                             java.lang.Integer projectId)

Gets all Modules in a Project.

Specified by:

getModules in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get modules from

Returns:

an array of WsModules

getOrganization

public WsOrganization getOrganization(WsAuth token,
                                      java.lang.Long organizationId)

Gets an Organization.

Specified by:

getOrganization in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

organizationId - id of the organization

Returns:

WsOrganization

getOrganizations

public WsOrganization[] getOrganizations(WsAuth token)

Gets all Organizations in this Contour installation.

Specified by:

getOrganizations in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

an array of WsOrganizations

getProject

public WsProject getProject(WsAuth token,
                            java.lang.Integer projectId)

Gets a Project.

Specified by:

getProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project

Returns:

WsProject

getProjects

public WsProject[] getProjects(WsAuth token)

Gets all Projects in the current Organization.

Specified by:

getProjects in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

an array of WsProjects

getPropertyEntry

public WsPropertyEntry getPropertyEntry(WsAuth token,
                                        java.lang.Integer refId,
                                        java.lang.Integer scope,
                                        java.lang.String propertyName)

Gets a Property Entry.

Specified by:

getPropertyEntry in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

scope - the scope of the object associated with the property entry (Scopes are defined in WsScope

refId - the id of the object associated with the property entry

propertyName - the name of the property to get

Returns:

WsPropertyEntry

getPropertyList

public WsPropertyList getPropertyList(WsAuth token,
                                      java.lang.Integer refId,
                                      java.lang.Integer scope)

Gets a list of Property Entries.

Specified by:

getPropertyList in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

scope - the scope of the object associated with the property entries (Scopes are defined in WsScope

refId - the id of the object associated with the property entries

Returns:

an array of WsPropertyEntrys

getRelease

public WsRelease getRelease(WsAuth token,
                            long releaseId)

Gets a Release.

Specified by:

getRelease in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

releaseId - id of the release

Returns:

WsRelease

getReleases

public WsRelease[] getReleases(WsAuth token,
                               WsProject project)

Gets all the Releases for a Project.

Specified by:

getReleases in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

project - the project that contains the releases

Returns:

a list of WsRelease

getServerInfo

public WsServerInfo getServerInfo(WsAuth token)

Gets basic info about the server Contour is installed on.

Specified by:

getServerInfo in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

WsServerInfo

getSubscribersToAnItem

public WsUser[] getSubscribersToAnItem(WsAuth token,
                                       java.lang.Long itemId)

Gets Users that are subscribed to an Item.

Specified by:

getSubscribersToAnItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

a list of WsUsers

getUpstreamRelated

public WsItem[] getUpstreamRelated(WsAuth token,
                                   java.lang.Long itemId)
                            throws java.lang.Exception

Gets all the upstream related Items.

Specified by:

getUpstreamRelated in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

a list of WsItems

Throws:

java.lang.Exception

getUrlForAttachment

public java.lang.String getUrlForAttachment(WsAuth token,
                                            java.lang.Long attachmentDocId)

Gets the URL for an Attachment.

Specified by:

getUrlForAttachment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

Returns:

A string of the URL to access the attachment file

getUrlForItem

public java.lang.String getUrlForItem(WsAuth token,
                                      java.lang.Long itemId)
                               throws java.lang.Exception

Gets the URL for an Item.

Specified by:

getUrlForItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item

Returns:

URL of the item

Throws:

java.lang.Exception

getUser

public WsUser getUser(WsAuth token,
                      java.lang.Integer userId)

Gets a User.

Specified by:

getUser in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

userId - id of the user

Returns:

WsUser

getUserFromAuth

public WsUser getUserFromAuth(WsAuth token)

Gets the User that is being used for authentication.

Specified by:

getUserFromAuth in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

WsUser

getUsers

public WsUser[] getUsers(WsAuth token)

Gets all the Users for the Organization.

Specified by:

getUsers in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

a list of WsUsers

getVersionsForItem

public WsVersion[] getVersionsForItem(WsAuth token,
                                      java.lang.Long itemId)
                               throws java.lang.Exception

Gets all the Versions for an Item.

Specified by:

getVersionsForItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id for the item

Returns:

an array of WsUsers

Throws:

java.lang.Exception

removeAttachmentFromItem

public void removeAttachmentFromItem(WsAuth token,
                                     java.lang.Long attachmentId,
                                     java.lang.Long itemId)
                              throws java.lang.Exception

Removes the association between an Attachment and an Item.

Specified by:

removeAttachmentFromItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

attachmentId - id of the item that represents the attachment

itemId - id of the item to remove attachment from

Throws:

java.lang.Exception

removeLookup

public void removeLookup(WsAuth token,
                         WsLookup lookupToRemove,
                         WsLookup replacementLookup)

Removes an existing lookup value. (Caution: Irreversible)

Specified by:

removeLookup in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

lookupToRemove - the lookup to be removed

replacementLookup - the lookup to replace all references to the removed lookup (Can be null)

replyToComment

public void replyToComment(WsAuth token,
                           java.lang.String commentText,
                           long commentToReplyTo)
                    throws java.lang.Exception

Replies to an existing Comment.

Specified by:

replyToComment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

commentText - the text of the comment to be posted

commentToReplyTo - the id of the comment to be replied to

Throws:

java.lang.Exception

revokeSignatureFromBaseline

public boolean revokeSignatureFromBaseline(WsAuth token,
                                           java.lang.Long baselineId,
                                           java.lang.String revokeComments)
                                    throws java.lang.Exception

Revokes an Electronic Signature from a Baseline.

Specified by:

revokeSignatureFromBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth token

baselineId - the id of the baseline to revoke the signature from

revokeComments - revoke comments, can be null

Returns:

whether or not the signature was revoked

Throws:

java.lang.Exception

signBaseline

public boolean signBaseline(WsAuth token,
                            java.lang.Long baselineId,
                            java.lang.String comments)
                     throws java.lang.Exception

Electronically signs a Baseline.

Specified by:

signBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth token

baselineId - the id of the baseline to sign

comments - signature comments, can be null

Returns:

whether or not the baseline was signed

Throws:

java.lang.Exception

testConnection

public java.lang.Boolean testConnection(WsAuth token)

Tests that a successful connection has been made. An Exception will be thrown if the connection is unsuccessful.

Specified by:

testConnection in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

Returns:

whether or not a connection has been made

updateBaseline

public boolean updateBaseline(WsAuth token,
                              java.lang.Long baselineId,
                              java.lang.String newName,
                              java.lang.String newDescription)
                       throws java.lang.Exception

Updates an existing Baseline.

Specified by:

updateBaseline in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

baselineId - id of the baseline to update

newName - new name of the baseline, will not update if null

newDescription - new description of the baseline, will not update if null

Returns:

whether or not the baseline was successfully updated

Throws:

java.lang.Exception

updateComment

public WsComment updateComment(WsAuth token,
                               WsComment comment)
                        throws java.lang.Exception

Updates an existing Comment.

Specified by:

updateComment in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

comment - the updated comment

Returns:

the updated WsComment

Throws:

java.lang.Exception

updateItem

public WsItem updateItem(WsAuth token,
                         WsItem item)
                  throws java.lang.Exception

Updates an existing Item.

Specified by:

updateItem in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

item - the item to be updated

Returns:

the updated WsItem

Throws:

java.lang.Exception

updateItems

public WsItem[] updateItems(WsAuth token,
                            WsItem[] items)
                     throws java.lang.Exception

Updates existing Items.

Specified by:

updateItems in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

items - the items to be updated

Returns:

an array of the updated WsItems

Throws:

java.lang.Exception

updateItemValues

public WsItem updateItemValues(WsAuth token,
                               java.lang.Long itemId,
                               WsField[] fieldValues,
                               java.lang.String comments,
                               WsUser[] notifyUsers)
                        throws java.lang.Exception

Updates the specified values for an existing Item. This is useful when there are only a few changes to make.

Specified by:

updateItemValues in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item that will be changed

fieldValues - the values to be changed

comments - to be included as part of the change.

notifyUsers - a list of user to be notified of the change.

Returns:

the updated WsItem

Throws:

java.lang.Exception

updateLookup

public void updateLookup(WsAuth token,
                         WsLookup wsLookup)

Updates an existing lookup value.

Specified by:

updateLookup in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsLookup - the lookup to be updated

updateModule

public WsModule updateModule(WsAuth token,
                             WsModule module)

Updates an existing Module.

Specified by:

updateModule in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

module - the module to be updated

Returns:

the updated WsModule

updateOrganization

public WsOrganization updateOrganization(WsAuth token,
                                         WsOrganization organization)

Updates an existing Organization.

Specified by:

updateOrganization in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

organization - the organization to be updated

Returns:

the updated WsOrganization

updateProject

public WsProject updateProject(WsAuth token,
                               WsProject project)

Updates an existing Project.

Specified by:

updateProject in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be updated

Returns:

the updated WsProject

updatePropertyEntry

public void updatePropertyEntry(WsAuth token,
                                WsPropertyEntry wsPropertyEntry)

Updates an existing Property Entry.

Specified by:

updatePropertyEntry in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to update

updatePropertyList

public void updatePropertyList(WsAuth token,
                               WsPropertyList wsPropertylist)

Updates a list of existing Property Entries.

Specified by:

updatePropertyList in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

wsPropertylist - a list of property entries to be updated

updateRelease

public WsRelease updateRelease(WsAuth token,
                               WsRelease release)

Updates an existing Release.

Specified by:

updateRelease in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

release - the release to be updated

Returns:

the updated WsRelease

updateUser

public void updateUser(WsAuth token,
                       WsUser user)

Updates an existing User.

Specified by:

updateUser in interface com.jamasoftware.contour.ws.v2.ContourSoapService

Parameters:

token - the WsAuth item

user - the user to be updated