com.jamasoftware.contour.ws.v3
Class ContourSoapServiceImpl

java.lang.Object
  com.jamasoftware.contour.dwr.impl.DwrServiceSupport
      com.jamasoftware.contour.ws.v3.ContourSoapServiceImpl

All Implemented Interfaces:

ContourSoapService

@Transactional
public class ContourSoapServiceImpl
extends com.jamasoftware.contour.dwr.impl.DwrServiceSupport
implements ContourSoapService

Web Services for Jama Contour.

Field Summary

Fields inherited from class com.jamasoftware.contour.dwr.impl.DwrServiceSupport

aclManager, domainObjectAccessor, logger

Constructor Summary

ContourSoapServiceImpl()

Method Summary

java.lang.Boolean	addAttachmentToItem(WsAuth token, java.lang.Long attachmentDocId, java.lang.Long itemId) Adds an existing Attachment to an Item.
WsChangeRequestAssociation	addChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation) Adds a new Change Request Association.
WsComment	addComment(WsAuth token, WsComment comment) Adds a new Comment based on the scope provided in the WsComment.
WsFilter	addFilter(WsAuth token, WsFilter filter) Deprecated.
WsItem	addItem(WsAuth token, WsItem item) Adds a new Item.
WsItem[]	addItems(WsAuth token, WsItem[] items) Adds multiple Items.
void	addLookup(WsAuth token, WsLookup lookup) Adds a new Lookup value.
WsModule	addModule(WsAuth token, WsModule module) Deprecated.
void	addOrganization(WsAuth token, WsOrganization organization) Adds a new Organization.
WsProject	addProject(WsAuth token, WsProject project) Adds a new Project.
WsPropertyEntry	addPropertyEntry(WsAuth token, WsPropertyEntry propertyEntry) Adds a new Property Entry.
WsPropertyList	addPropertyList(WsAuth token, WsPropertyList propertyList) Adds a new list of Property Entries.
WsRelease	addRelease(WsAuth token, java.lang.Integer projectId, WsRelease release) Adds a new Release.
java.lang.Boolean	addSubscribersToItem(WsAuth token, java.lang.Long itemId, WsUser[] users) Subscribes Users to an Item.
void	addUser(WsAuth token, WsUser wsUser) Adds a new User.
java.lang.Boolean	clearSuspectLinksForItem(WsAuth token, java.lang.Long itemId) Clears the suspect links for an Item.
java.lang.Boolean	clearSuspectLinksForProject(WsAuth token, java.lang.Long projectId) Clears the suspect links for a Project.
java.lang.Boolean	closeChangeRequest(WsAuth token, java.lang.Integer changeRequestItemId) Closes a Change Request.
WsBaseline	createBaseline(WsAuth token, WsBaseline baseline) Creates a Baseline.
WsBaseline	createBaselineFromFilter(WsAuth token, java.lang.String baselineName, java.lang.String description, WsFilter filter) Creates a Baseline from a Filter.
WsRelationship[]	createRelationships(WsAuth token, WsRelationship[] listOfRelationships) Creates multiple Relationships.
java.lang.Boolean	deactivateBaseline(WsAuth token, WsBaseline baseline) Deactivates a Baseline.
java.lang.Boolean	deactivateItem(WsAuth token, java.lang.Long itemId) Deactivates the Item.
java.lang.Boolean	deactivateLookup(WsAuth token, WsLookup lookupToDeactivate, WsLookup replacementLookup) Deactivates an existing lookup value.
java.lang.Boolean	deactivateModule(WsAuth token, java.lang.Long moduleId) Deprecated.
java.lang.Boolean	deactivateProject(WsAuth token, WsProject project) Deactivates the Project.
java.lang.Boolean	deactivateUser(WsAuth token, java.lang.Long userId) Deactivates the User.
java.lang.Boolean	deleteAttachment(WsAuth token, java.lang.Long attachmentId) Deletes an Attachment from the server.
java.lang.Boolean	deleteChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation) Deletes a Change Request Association.
java.lang.Boolean	deleteComment(WsAuth token, java.lang.Long commentId) Deletes a Comment.
java.lang.Boolean	deleteFilter(WsAuth token, WsFilter filter) Deprecated.
java.lang.Boolean	deleteOrganization(WsAuth token, java.lang.Long organizationId) Deletes the Organization.
java.lang.Boolean	deleteProject(WsAuth token, WsProject project) Deletes the Project.
java.lang.Boolean	deletePropertyEntry(WsAuth token, WsPropertyEntry propertyEntry) Deletes a property entry.
java.lang.Boolean	deletePropertyList(WsAuth token, WsPropertyList propertyList) Deletes a list of Property Entries.
java.lang.Boolean	deleteRelationship(WsAuth token, WsRelationship relationship) Deletes a relationship between two items.
java.lang.Boolean	deleteRelease(WsAuth token, java.lang.Long releaseId, java.lang.Long swapReleaseId) Deletes the Release.
WsActivity[]	getActivities(WsAuth token, java.lang.Long projectId, int start, int count) 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.
WsChangeRequestAssociation	getChangeRequestAssociation(WsAuth token, java.lang.Long changeRequestAssociationId) Gets a Change Request Association.
WsChangeRequestAssociation[]	getChangeRequestAssociations(WsAuth token, java.lang.Integer changeRequestItemId) Gets all the Change Request Associations associated with a Change Request.
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.
WsVersion	getCurrentVersionForItem(WsAuth token, java.lang.Long itemId) Gets the current Version of an Item.
WsDocumentType	getDocumentType(WsAuth token, java.lang.Long documentTypeId) Gets a document type.
WsField[]	getDocumentTypeFields(WsAuth token, java.lang.Long documentTypeId) Gets the fields associated with a document type.
WsDocumentType[]	getDocumentTypes(WsAuth token, java.lang.Long organizationId) Gets all the document types in an organization.
WsDocumentType[]	getDocumentTypesForProject(WsAuth token, java.lang.Long projectId) Gets all the document types that are applicable to a project.
WsItem[]	getDownstreamRelated(WsAuth token, java.lang.Long itemId) Gets all Items downstream of an Item.
WsRelationship[]	getDownstreamRelationships(WsAuth token, java.lang.Long itemId) Gets the downstream relationships of an item.
WsFilter	getFilter(WsAuth token, java.lang.Long filterId) Gets a Filter.
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, java.lang.Integer start, java.lang.Integer count) Gets all the Items in a Baseline.
WsItem[]	getItemsForProject(WsAuth token, java.lang.Long projectId, int start, int count) Gets all the Items in a Project.
WsItem[]	getItemsForProjectAndDocumentType(WsAuth token, java.lang.Long projectId, java.lang.Long documentTypeId, int start, int count) Gets all the Items in a WsProject that are of a given WsDocumentType.
WsItem[]	getItemsFromFilter(WsAuth token, WsFilter filter, java.lang.Integer start, java.lang.Integer count) Gets all the Items based on a Filter.
WsItem[]	getItemsFromTextSearch(WsAuth token, java.lang.String searchTerms, java.lang.Integer start, java.lang.Integer 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.
WsLookup[]	getLookupsFromType(WsAuth token, java.lang.Integer lookupTypeId) Gets all lookup values associated with a lookup type.
WsLookupType	getLookupType(WsAuth token, java.lang.Integer lookupTypeId) Gets a lookup type value.
WsModule	getModule(WsAuth token, java.lang.Integer moduleId) Deprecated.
WsModule	getModuleForProjectAndDocumentType(WsAuth token, java.lang.Integer projectId, java.lang.Integer documentTypeId) Deprecated.
WsModule[]	getModules(WsAuth token, java.lang.Integer projectId) Deprecated.
java.lang.Integer	getNumItemsFromFilter(WsAuth token, WsFilter filter) Gets the number of items in the result of a filter.
java.lang.Integer	getNumItemsFromTextSearch(WsAuth token, java.lang.String searchTerms) Gets the number of items in the result of a text search.
WsOrganization	getOrganization(WsAuth token, java.lang.Long organizationId) Gets an Organization.
WsOrganization[]	getOrganizations(WsAuth token) Gets all Organizations in this Contour installation.
WsPermissions	getPermissionsByRefAndScope(WsAuth token, java.lang.Integer refId, java.lang.Integer scope) Gets the current user's permissions for a given object.
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.
WsRelationship	getRelationship(WsAuth token, java.lang.Long relationshipId) Gets a relationship.
WsRelationship[]	getRelationshipsForProject(WsAuth token, java.lang.Long projectId) Gets all relationships in a project.
WsRelationship[]	getRelationshipsFromFilter(WsAuth token, WsFilter filter, java.lang.Boolean downstream) Gets all relationships of items that match the given filter.
WsRelationshipType[]	getRelationshipTypeList(WsAuth token, java.lang.Long organizationId) Gets all relationship types in an organization.
WsRelease	getRelease(WsAuth token, java.lang.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.
WsRelationship[]	getUpstreamRelationships(WsAuth token, java.lang.Long itemId) Gets the upstream relationships of an item.
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	getVersion(WsAuth token, java.lang.Long versionId) Gets a Version.
WsVersion[]	getVersionsForItem(WsAuth token, java.lang.Long itemId) Gets all the Versions for an Item.
java.lang.Boolean	isChangeRequest(WsAuth token, java.lang.Integer itemId) Does this item contain the Change Request component?
java.lang.Boolean	isValidDocumentPlacement(WsAuth token, java.lang.Long documentTypeId, java.lang.Long parentId) Returns whether or not an item of the given document type can be placed as a child of an item.
java.lang.Boolean	moveDocument(WsAuth token, java.lang.Long itemId, java.lang.Long newParentId) Moves a document from it's current position in the explorer tree to be under another document.
java.lang.Boolean	removeAttachmentFromItem(WsAuth token, java.lang.Long attachmentId, java.lang.Long itemId) Removes the association between an Attachment and an Item.
WsComment	replyToComment(WsAuth token, java.lang.String commentText, long commentToReplyTo) Replies to an existing Comment.
java.lang.Boolean	revokeSignatureFromBaseline(WsAuth token, java.lang.Long baselineId, java.lang.String revokeComments) Revokes an Electronic Signature from a Baseline.
void	setItemService(com.jamasoftware.contour.ws.v3.service.WsItemService itemService)
void	setWsActivityService(com.jamasoftware.contour.ws.v3.service.WsActivityService wsActivityService)
void	setWsAttachmentService(com.jamasoftware.contour.ws.v3.service.WsAttachmentService wsAttachmentService)
void	setWsBaselineService(com.jamasoftware.contour.ws.v3.service.WsBaselineService wsBaselineService)
void	setWsChangeRequestAssociationService(com.jamasoftware.contour.ws.v3.service.WsChangeRequestAssociationService wsChangeRequestAssociationService)
void	setWsCommentService(com.jamasoftware.contour.ws.v3.service.WsCommentService wsCommentService)
void	setWsDocumentTypeService(com.jamasoftware.contour.ws.v3.service.WsDocumentTypeService wsDocumentTypeService)
void	setWsFilterService(com.jamasoftware.contour.ws.v3.service.WsFilterService wsFilterService)
void	setWsLookupService(com.jamasoftware.contour.ws.v3.service.WsLookupService wsLookupService)
void	setWsOrganizationService(com.jamasoftware.contour.ws.v3.service.WsOrganizationService wsOrganizationService)
void	setWsProjectService(com.jamasoftware.contour.ws.v3.service.WsProjectService wsProjectService)
void	setWsPropertyService(com.jamasoftware.contour.ws.v3.service.WsPropertyService wsPropertyService)
void	setWsRelationshipService(com.jamasoftware.contour.ws.v3.service.WsRelationshipService wsRelationshipService)
void	setWsReleaseService(com.jamasoftware.contour.ws.v3.service.WsReleaseService wsReleaseService)
void	setWsSubscriptionService(com.jamasoftware.contour.ws.v3.service.WsSubscriptionService wsSubscriptionService)
void	setWsUserService(com.jamasoftware.contour.ws.v3.service.WsUserService wsUserService)
void	setWsVersionService(com.jamasoftware.contour.ws.v3.service.WsVersionService wsVersionService)
java.lang.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.
WsBaseline	updateBaseline(WsAuth token, java.lang.Long baselineId, java.lang.String newName, java.lang.String newDescription) Updates an existing Baseline.
WsChangeRequestAssociation	updateChangeRequestAssociation(WsAuth token, WsChangeRequestAssociation changeRequestAssociation) Updates a Change Request Association.
WsComment	updateComment(WsAuth token, WsComment comment) Updates an existing Comment.
WsFilter	updateFilter(WsAuth token, WsFilter filter) Deprecated.
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[] fields, java.lang.String comments, WsUser[] notifyUsers) Updates the specified values for an existing Item.
WsLookup	updateLookup(WsAuth token, WsLookup lookup) Updates an existing lookup value.
WsModule	updateModule(WsAuth token, WsModule module) Deprecated.
WsOrganization	updateOrganization(WsAuth token, WsOrganization organization) Updates an existing Organization.
WsProject	updateProject(WsAuth token, WsProject project) Updates an existing Project.
WsPropertyEntry	updatePropertyEntry(WsAuth token, WsPropertyEntry propertyEntry) Updates an existing Property Entry.
WsPropertyList	updatePropertyList(WsAuth token, WsPropertyList propertyList) Updates a list of existing Property Entries.
WsRelationship	updateRelationship(WsAuth token, WsRelationship relationship) Updates a relationship.
WsRelease	updateRelease(WsAuth token, WsRelease release) Updates an existing Release.
WsUser	updateUser(WsAuth token, WsUser user) Updates an existing User.

Methods inherited from class com.jamasoftware.contour.dwr.impl.DwrServiceSupport

authorize, authorizeContourItem, authorizeCurrentOrganization, authorizeOrganization, authorizeProject, authorizeProject, authorizeUser, canAdminContourItem, canAdminCurrentOrganization, canAdminDocumentType, canAdminLookup, canAdminLookupType, canAdminOrganization, canAdminProject, canAdminProject, canAdminScopedObject, canAdminScopedObject, canAdminUser, canAdminUser, canReadAttachment, canReadAttachment, canReadAttachmentDto, canReadBaseLine, canReadBaseLine, canReadContourItem, canReadCurrentOrganization, canReadDocumentType, canReadOrganization, canReadProject, canReadProject, canReadRelationship, canReadRelease, canReadReleaseType, canReadScopedObject, canReadScopedObject, canReadUser, canReadVersion, canWriteAttachment, canWriteAttachment, canWriteAttachmentDto, canWriteBaseLine, canWriteBaseLine, canWriteContourItem, canWriteLookupType, canWriteProject, canWriteRelationship, canWriteRelease, canWriteReleaseType, canWriteScopedObject, canWriteScopedObject, canWriteVersion, checkCondition, checkRootUser, checkRootUserOrOrgAdmin, checkUserIsLoggedIn, checkUserLogin, getLoggedInUser, getObject, hasPermission, isUserLoggedin, sameAsCurrentOrg, setAclManager, setDomainObjectAccessor

Methods inherited from class java.lang.Object

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

Constructor Detail

ContourSoapServiceImpl

public ContourSoapServiceImpl()

Method Detail

addComment

public WsComment addComment(WsAuth token,
                            WsComment comment)

Adds a new Comment based on the scope provided in the WsComment. Currently only WsScope.DOCUMENT is supported. Comment text should be in plain-text format.

Specified by:

addComment in interface ContourSoapService

Parameters:

token - the WsAuth item

comment - the comment to add

Returns:

the added comment

Throws:

java.lang.Exception

replyToComment

public WsComment replyToComment(WsAuth token,
                                java.lang.String commentText,
                                long commentToReplyTo)

Replies to an existing Comment. Comment text should be in plain-text format.

Specified by:

replyToComment in interface 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

Returns:

the added comment

Throws:

java.lang.Exception

getItem

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

Gets an Item.

Specified by:

getItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item

Returns:

the item

Throws:

java.lang.Exception

getUrlForItem

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

Gets the URL for an Item.

Specified by:

getUrlForItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item

Returns:

URL of the item

Throws:

java.lang.Exception

addItems

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

Adds multiple Items.

Specified by:

addItems in interface 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

addItem

public WsItem addItem(WsAuth token,
                      WsItem item)

Adds a new Item.

Specified by:

addItem in interface ContourSoapService

Parameters:

token - the WsAuth item

item - an item to add

Returns:

the item added@

Throws:

java.lang.Exception

addOrganization

public void addOrganization(WsAuth token,
                            WsOrganization organization)

Adds a new Organization.

Specified by:

addOrganization in interface 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 ContourSoapService

Parameters:

token - the WsAuth item

project - the project to add

Returns:

the project added

Throws:

java.lang.Exception

addRelease

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

Adds a new Release.

Specified by:

addRelease in interface 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 java.lang.Boolean addSubscribersToItem(WsAuth token,
                                              java.lang.Long itemId,
                                              WsUser[] users)

Subscribes Users to an Item.

Specified by:

addSubscribersToItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the item to be subscribed to

users - the list of users to add subscriptions for

Returns:

whether or not the subscribers were successfully added to the item

Throws:

java.lang.Exception

addUser

public void addUser(WsAuth token,
                    WsUser wsUser)

Adds a new User.

Specified by:

addUser in interface ContourSoapService

Parameters:

token - the WsAuth item

wsUser - the user to add

Throws:

java.lang.Exception

clearSuspectLinksForItem

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

Clears the suspect links for an Item.

Specified by:

clearSuspectLinksForItem in interface ContourSoapService

Parameters:

token - the WsAuth item

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

Returns:

whether or not the suspect links for the item were cleared successfully

Throws:

java.lang.Exception

clearSuspectLinksForProject

public java.lang.Boolean clearSuspectLinksForProject(WsAuth token,
                                                     java.lang.Long projectId)

Clears the suspect links for a Project.

Specified by:

clearSuspectLinksForProject in interface ContourSoapService

Parameters:

token - the WsAuth item

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

Returns:

whether or not the suspect links for the project were cleared successfully

Throws:

java.lang.Exception

createRelationships

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

Creates multiple Relationships.

Specified by:

createRelationships in interface ContourSoapService

Parameters:

token - the WsAuth item

listOfRelationships - the relationships to be created

Returns:

the added relationships

Throws:

java.lang.Exception

deleteRelationship

public java.lang.Boolean deleteRelationship(WsAuth token,
                                            WsRelationship relationship)

Deletes a relationship between two items. (Caution: Irreversible)

Specified by:

deleteRelationship in interface ContourSoapService

Parameters:

token - the WsAuth item

relationship - the relationship to delete

Returns:

whether or not the relationship was successfully deleted

Throws:

java.lang.Exception

getDownstreamRelationships

public WsRelationship[] getDownstreamRelationships(WsAuth token,
                                                   java.lang.Long itemId)

Gets the downstream relationships of an item.

Specified by:

getDownstreamRelationships in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item to get downstream relationships of

Returns:

an array of WsRelationships

Throws:

java.lang.Exception

getRelationship

public WsRelationship getRelationship(WsAuth token,
                                      java.lang.Long relationshipId)

Gets a relationship.

Specified by:

getRelationship in interface ContourSoapService

Parameters:

token - the WsAuth item

relationshipId - the id of the relationship to get

Returns:

WsRelationship

Throws:

java.lang.Exception

getRelationshipsForProject

public WsRelationship[] getRelationshipsForProject(WsAuth token,
                                                   java.lang.Long projectId)

Gets all relationships in a project.

Specified by:

getRelationshipsForProject in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get relationships from

Returns:

an array of WsRelationships

Throws:

java.lang.Exception

getRelationshipsFromFilter

@Transactional(readOnly=true)
public WsRelationship[] getRelationshipsFromFilter(WsAuth token,
                                                                 WsFilter filter,
                                                                 java.lang.Boolean downstream)

Gets all relationships of items that match the given filter.

Specified by:

getRelationshipsFromFilter in interface ContourSoapService

Parameters:

token - the WsAuth item

filter - the filter to match items with

downstream - true to get downstream relationships, false to get upstream relationships

Returns:

an array of WsRelationships

Throws:

java.lang.Exception

getUpstreamRelationships

public WsRelationship[] getUpstreamRelationships(WsAuth token,
                                                 java.lang.Long itemId)

Gets the upstream relationships of an item.

Specified by:

getUpstreamRelationships in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item to get upstream relationships of

Returns:

an array of WsRelationships

Throws:

java.lang.Exception

updateRelationship

public WsRelationship updateRelationship(WsAuth token,
                                         WsRelationship relationship)

Updates a relationship.

Specified by:

updateRelationship in interface ContourSoapService

Parameters:

token - the WsAuth item

relationship - the relationship to update

Returns:

the updated relationship

Throws:

java.lang.Exception

getRelationshipTypeList

public WsRelationshipType[] getRelationshipTypeList(WsAuth token,
                                                    java.lang.Long organizationId)

Gets all relationship types in an organization.

Specified by:

getRelationshipTypeList in interface ContourSoapService

Parameters:

token - the WsAuth item

organizationId - id of the organization to get relationship types from

Returns:

an array of WsRelationshipTypes

Throws:

java.lang.Exception

deactivateItem

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

Deactivates the Item.

Specified by:

deactivateItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - the id of the item to be deactivated

Returns:

whether or not the item was successfully deactivated

Throws:

java.lang.Exception

deleteOrganization

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

Deletes the Organization. (Caution: Irreversible)

Specified by:

deleteOrganization in interface ContourSoapService

Parameters:

token - the WsAuth item

organizationId - the id of the organization to be deleted

Returns:

whether or not the organization was successfully deleted

Throws:

java.lang.Exception

deleteProject

public java.lang.Boolean deleteProject(WsAuth token,
                                       WsProject project)

Deletes the Project. (Caution: Irreversible)

Specified by:

deleteProject in interface ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be deleted

Returns:

whether or not the project was successfully deleted

Throws:

java.lang.Exception

deactivateProject

public java.lang.Boolean deactivateProject(WsAuth token,
                                           WsProject project)

Deactivates the Project.

Specified by:

deactivateProject in interface ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be deactivated

Returns:

whether or not the project was successfully deactivated

Throws:

java.lang.Exception

deleteRelease

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

Deletes the Release. (Caution: Irreversible)

Specified by:

deleteRelease in interface ContourSoapService

Parameters:

token - the WsAuth item

releaseId - the release to be deleted

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

Returns:

whether or not the release was successfully deleted

Throws:

java.lang.Exception

deactivateUser

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

Deactivates the User.

Specified by:

deactivateUser in interface ContourSoapService

Parameters:

token - the WsAuth item

userId - the id of the user to deactivate

Returns:

whether or not the user was successfully deactivated

Throws:

java.lang.Exception

getActivities

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

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 ContourSoapService

Parameters:

token - the WsAuth item

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

start - index of results to start at

count - number of results to return

Returns:

an array of WsActivitys

Throws:

java.lang.Exception

getBaseline

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

Gets a Baseline.

Specified by:

getBaseline in interface 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)

Gets all the Baselines in a Project.

Specified by:

getBaselinesForProject in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - the project to get baselines from

Returns:

an array of baselines

Throws:

java.lang.Exception

signBaseline

public java.lang.Boolean signBaseline(WsAuth token,
                                      java.lang.Long baselineId,
                                      java.lang.String comments)

Electronically signs a Baseline.

Specified by:

signBaseline in interface 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

revokeSignatureFromBaseline

public java.lang.Boolean revokeSignatureFromBaseline(WsAuth token,
                                                     java.lang.Long baselineId,
                                                     java.lang.String revokeComments)

Revokes an Electronic Signature from a Baseline.

Specified by:

revokeSignatureFromBaseline in interface 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

createBaseline

public WsBaseline createBaseline(WsAuth token,
                                 WsBaseline baseline)

Creates a Baseline.

Specified by:

createBaseline in interface ContourSoapService

Parameters:

token - the WsAuth token

baseline - the baseline to create

Returns:

the created baseline

Throws:

java.lang.Exception

createBaselineFromFilter

public WsBaseline createBaselineFromFilter(WsAuth token,
                                           java.lang.String baselineName,
                                           java.lang.String description,
                                           WsFilter filter)

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.

Specified by:

createBaselineFromFilter in interface 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

deactivateBaseline

public java.lang.Boolean deactivateBaseline(WsAuth token,
                                            WsBaseline baseline)

Deactivates a Baseline.

Specified by:

deactivateBaseline in interface ContourSoapService

Parameters:

token - the WsAuth item

baseline - baseline to deactivate

Returns:

whether or not the baseline was successfully deactivated

Throws:

java.lang.Exception

updateBaseline

public WsBaseline updateBaseline(WsAuth token,
                                 java.lang.Long baselineId,
                                 java.lang.String newName,
                                 java.lang.String newDescription)

Updates an existing Baseline.

Specified by:

updateBaseline in interface 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

getChildrenOfItem

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

Gets the children of an Item/Folder.

Specified by:

getChildrenOfItem in interface 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

getComments

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

Gets all Comments from an Item.

Specified by:

getComments in interface 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

getComment

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

Gets a Comment.

Specified by:

getComment in interface ContourSoapService

Parameters:

token - the WsAuth item

commentId - id of the comment

Returns:

WsComment

Throws:

java.lang.Exception

deleteComment

public java.lang.Boolean deleteComment(WsAuth token,
                                       java.lang.Long commentId)

Deletes a Comment. (Caution: Irreversible)

Specified by:

deleteComment in interface ContourSoapService

Parameters:

token - for the WsAuth item

commentId - id of the comment to delete

Returns:

whether or not the comment was successfully deleted

Throws:

java.lang.Exception

getDownstreamRelated

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

Gets all Items downstream of an Item.

Specified by:

getDownstreamRelated in interface 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

getFiltersForProject

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

Gets all Filters for a Project.

Specified by:

getFiltersForProject in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get filters from

Returns:

an array of filters from the source project

Throws:

java.lang.Exception

getFilter

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

Gets a Filter.

Specified by:

getFilter in interface ContourSoapService

Parameters:

token - the WsAuth item

filterId - id of the filter to get

Returns:

the filter

Throws:

java.lang.Exception

getItemsForProjectAndDocumentType

public WsItem[] getItemsForProjectAndDocumentType(WsAuth token,
                                                  java.lang.Long projectId,
                                                  java.lang.Long documentTypeId,
                                                  int start,
                                                  int count)

Gets all the Items in a WsProject that are of a given WsDocumentType. Use start and count to page the results. Start and counts of 0 will return all results.

Specified by:

getItemsForProjectAndDocumentType in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - the id of the project

documentTypeId - the id of the document type

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)

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 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

getItemsForBaseline

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

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

Specified by:

getItemsForBaseline in interface 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

getItemsFromFilter

@Transactional(readOnly=true)
public WsItem[] getItemsFromFilter(WsAuth token,
                                                 WsFilter filter,
                                                 java.lang.Integer start,
                                                 java.lang.Integer count)

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:

getItemsFromFilter in interface 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

getNumItemsFromFilter

@Transactional(readOnly=true)
public java.lang.Integer getNumItemsFromFilter(WsAuth token,
                                                             WsFilter filter)

Gets the number of items in the result of 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.

Specified by:

getNumItemsFromFilter in interface ContourSoapService

Parameters:

token - the WsAuth item

filter - the WsFilter to use

Returns:

number of items returned by the filter

Throws:

java.lang.Exception

getItemsFromTextSearch

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

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 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

getNumItemsFromTextSearch

public java.lang.Integer getNumItemsFromTextSearch(WsAuth token,
                                                   java.lang.String searchTerms)

Gets the number of items in the result of a text search. Keyword or Lucene syntax.

Specified by:

getNumItemsFromTextSearch in interface ContourSoapService

Parameters:

token - the WsAuth item

searchTerms - the search query

Returns:

number of items returned by the text search

Throws:

java.lang.Exception

getItemFields

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

Returns an array of all WsFields for an Item.

Specified by:

getItemFields in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

an array of WsFields

Throws:

java.lang.Exception

getItemFieldNames

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

Returns an array of the field names for an Item.

Specified by:

getItemFieldNames in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

an array of field names

Throws:

java.lang.Exception

getOrganizations

public WsOrganization[] getOrganizations(WsAuth token)

Gets all Organizations in this Contour installation.

Specified by:

getOrganizations in interface ContourSoapService

Parameters:

token - the WsAuth item

Returns:

an array of WsOrganizations

Throws:

java.lang.Exception

getOrganization

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

Gets an Organization.

Specified by:

getOrganization in interface ContourSoapService

Parameters:

token - the WsAuth item

organizationId - id of the organization

Returns:

WsOrganization

Throws:

java.lang.Exception

getProjects

public WsProject[] getProjects(WsAuth token)

Gets all Projects in the current Organization.

Specified by:

getProjects in interface ContourSoapService

Parameters:

token - the WsAuth item

Returns:

an array of WsProjects

Throws:

java.lang.Exception

getProject

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

Gets a Project.

Specified by:

getProject in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project

Returns:

WsProject

Throws:

java.lang.Exception

getReleases

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

Gets all the Releases for a Project.

Specified by:

getReleases in interface ContourSoapService

Parameters:

token - the WsAuth item

project - the project that contains the releases

Returns:

a list of WsRelease

Throws:

java.lang.Exception

getRelease

public WsRelease getRelease(WsAuth token,
                            java.lang.Long releaseId)

Gets a Release.

Specified by:

getRelease in interface ContourSoapService

Parameters:

token - the WsAuth item

releaseId - id of the release

Returns:

WsRelease

Throws:

java.lang.Exception

getServerInfo

public WsServerInfo getServerInfo(WsAuth token)

Gets basic info about the server Contour is installed on.

Specified by:

getServerInfo in interface ContourSoapService

Parameters:

token - the WsAuth item

Returns:

WsServerInfo

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 ContourSoapService

Parameters:

token - the WsAuth item

Returns:

whether or not a connection has been made

Throws:

java.lang.Exception

getSubscribersToAnItem

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

Gets Users that are subscribed to an Item.

Specified by:

getSubscribersToAnItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

a list of WsUsers

Throws:

java.lang.Exception

getUpstreamRelated

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

Gets all the upstream related Items.

Specified by:

getUpstreamRelated in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item

Returns:

a list of WsItems

Throws:

java.lang.Exception

getUsers

public WsUser[] getUsers(WsAuth token)

Gets all the Users for the Organization.

Specified by:

getUsers in interface ContourSoapService

Parameters:

token - the WsAuth item

Returns:

a list of WsUsers

Throws:

java.lang.Exception

getUser

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

Gets a User.

Specified by:

getUser in interface ContourSoapService

Parameters:

token - the WsAuth item

userId - id of the user

Returns:

WsUser

Throws:

java.lang.Exception

getUserFromAuth

public WsUser getUserFromAuth(WsAuth token)

Gets the User that is being used for authentication.

Specified by:

getUserFromAuth in interface ContourSoapService

Parameters:

token - the WsAuth item

Returns:

WsUser

Throws:

java.lang.Exception

getVersionsForItem

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

Gets all the Versions for an Item.

Specified by:

getVersionsForItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id for the item

Returns:

an array of WsVersions

Throws:

java.lang.Exception

getCurrentVersionForItem

public WsVersion getCurrentVersionForItem(WsAuth token,
                                          java.lang.Long itemId)

Gets the current Version of an Item.

Specified by:

getCurrentVersionForItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id for the item

Returns:

current version of the item

Throws:

java.lang.Exception

getVersion

public WsVersion getVersion(WsAuth token,
                            java.lang.Long versionId)

Gets a Version.

Specified by:

getVersion in interface ContourSoapService

Parameters:

token - the WsAuth item

versionId - id for the version

Returns:

WsVersion

Throws:

java.lang.Exception

updateComment

public WsComment updateComment(WsAuth token,
                               WsComment comment)

Updates an existing Comment.

Specified by:

updateComment in interface ContourSoapService

Parameters:

token - the WsAuth item

comment - the updated comment

Returns:

the updated WsComment

Throws:

java.lang.Exception

updateItemValues

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

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 ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item that will be changed

fields - the fields 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

updateItems

public WsItem[] updateItems(WsAuth token,
                            WsItem[] items)

Updates existing Items.

Specified by:

updateItems in interface ContourSoapService

Parameters:

token - the WsAuth item

items - the items to be updated

Returns:

an array of the updated WsItems

Throws:

java.lang.Exception

updateItem

public WsItem updateItem(WsAuth token,
                         WsItem item)

Updates an existing Item.

Specified by:

updateItem in interface ContourSoapService

Parameters:

token - the WsAuth item

item - the item to be updated

Returns:

the updated WsItem

Throws:

java.lang.Exception

updateOrganization

public WsOrganization updateOrganization(WsAuth token,
                                         WsOrganization organization)

Updates an existing Organization.

Specified by:

updateOrganization in interface ContourSoapService

Parameters:

token - the WsAuth item

organization - the organization to be updated

Returns:

the updated WsOrganization

Throws:

java.lang.Exception

updateProject

public WsProject updateProject(WsAuth token,
                               WsProject project)

Updates an existing Project.

Specified by:

updateProject in interface ContourSoapService

Parameters:

token - the WsAuth item

project - the project to be updated

Returns:

the updated WsProject

Throws:

java.lang.Exception

updateRelease

public WsRelease updateRelease(WsAuth token,
                               WsRelease release)

Updates an existing Release.

Specified by:

updateRelease in interface ContourSoapService

Parameters:

token - the WsAuth item

release - the release to be updated

Returns:

the updated WsRelease

Throws:

java.lang.Exception

updateUser

public WsUser updateUser(WsAuth token,
                         WsUser user)

Updates an existing User.

Specified by:

updateUser in interface ContourSoapService

Parameters:

token - the WsAuth item

user - the user to be updated

Returns:

the updated user

Throws:

java.lang.Exception

addPropertyEntry

public WsPropertyEntry addPropertyEntry(WsAuth token,
                                        WsPropertyEntry propertyEntry)

Adds a new Property Entry.

Specified by:

addPropertyEntry in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to be added

Returns:

the added property entry

Throws:

java.lang.Exception

addPropertyList

public WsPropertyList addPropertyList(WsAuth token,
                                      WsPropertyList propertyList)

Adds a new list of Property Entries.

Specified by:

addPropertyList in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyList - A list of property entries to be added

Returns:

the added property list

Throws:

java.lang.Exception

deletePropertyEntry

public java.lang.Boolean deletePropertyEntry(WsAuth token,
                                             WsPropertyEntry propertyEntry)

Deletes a property entry. (Caution: Irreversible)

Specified by:

deletePropertyEntry in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to be deleted

Returns:

whether or not the property entry was successfully deleted

Throws:

java.lang.Exception

deletePropertyList

public java.lang.Boolean deletePropertyList(WsAuth token,
                                            WsPropertyList propertyList)

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

Specified by:

deletePropertyList in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertylist - A list of property entries to be deleted

Returns:

whether or not the property list was successfully deleted

Throws:

java.lang.Exception

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 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

Throws:

java.lang.Exception

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 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

Throws:

java.lang.Exception

updatePropertyEntry

public WsPropertyEntry updatePropertyEntry(WsAuth token,
                                           WsPropertyEntry propertyEntry)

Updates an existing Property Entry.

Specified by:

updatePropertyEntry in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertyEntry - the property entry to update

Returns:

the updated property entry

Throws:

java.lang.Exception

updatePropertyList

public WsPropertyList updatePropertyList(WsAuth token,
                                         WsPropertyList propertyList)

Updates a list of existing Property Entries.

Specified by:

updatePropertyList in interface ContourSoapService

Parameters:

token - the WsAuth item

wsPropertylist - a list of property entries to be updated

Returns:

the updated property list

Throws:

java.lang.Exception

addAttachmentToItem

public java.lang.Boolean addAttachmentToItem(WsAuth token,
                                             java.lang.Long attachmentDocId,
                                             java.lang.Long itemId)

Adds an existing Attachment to an Item.

Specified by:

addAttachmentToItem in interface 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

getUrlForAttachment

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

Gets the URL for an Attachment.

Specified by:

getUrlForAttachment in interface 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

Throws:

java.lang.Exception

getAttachment

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

Gets an Attachment.

Specified by:

getAttachment in interface ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

Returns:

WsAttachment

Throws:

java.lang.Exception

getAttachments

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

Gets all the Attachments in a Project.

Specified by:

getAttachments in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get attachments from

Returns:

an array of WsAttachments

Throws:

java.lang.Exception

getItemsWithAttachment

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

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

Specified by:

getItemsWithAttachment in interface ContourSoapService

Parameters:

token - the WsAuth item

attachmentDocId - id of the item that represents the attachment

Returns:

an array of WsItems

Throws:

java.lang.Exception

getAttachmentsForItem

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

Gets all Attachments attached to a specified Item.

Specified by:

getAttachmentsForItem in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item to get attachments from

Returns:

an array of WsAttachments

Throws:

java.lang.Exception

deleteAttachment

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

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

Specified by:

deleteAttachment in interface ContourSoapService

Parameters:

token - the WsAuth item

attachmentId - id of the attachment to delete

Returns:

whether or not the attachment was successfully deleted

Throws:

java.lang.Exception

removeAttachmentFromItem

public java.lang.Boolean removeAttachmentFromItem(WsAuth token,
                                                  java.lang.Long attachmentId,
                                                  java.lang.Long itemId)

Removes the association between an Attachment and an Item.

Specified by:

removeAttachmentFromItem in interface ContourSoapService

Parameters:

token - the WsAuth item

attachmentId - id of the item that represents the attachment

itemId - id of the item to remove attachment from

Returns:

whether or not the attachment wass succesfully removed

Throws:

java.lang.Exception

addLookup

public void addLookup(WsAuth token,
                      WsLookup lookup)

Adds a new Lookup value.

Specified by:

addLookup in interface ContourSoapService

Parameters:

token - the WsAuth item

lookup - the lookup to be added

Throws:

java.lang.Exception

deactivateLookup

public java.lang.Boolean deactivateLookup(WsAuth token,
                                          WsLookup lookupToDeactivate,
                                          WsLookup replacementLookup)

Deactivates an existing lookup value.

Specified by:

deactivateLookup in interface ContourSoapService

Parameters:

token - the WsAuth item

lookupToDeactivate - the lookup to be deactivated

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

Returns:

whether or not the lookup was successfully deactivated

Throws:

java.lang.Exception

getLookup

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

Gets a lookup value.

Specified by:

getLookup in interface ContourSoapService

Parameters:

token - the WsAuth item

lookupId - id of the lookup to get

Returns:

WsLookup

Throws:

java.lang.Exception

getLookupType

public WsLookupType getLookupType(WsAuth token,
                                  java.lang.Integer lookupTypeId)

Gets a lookup type value.

Specified by:

getLookupType in interface ContourSoapService

Parameters:

token - the WsAuth item

lookupTypeId - id of the lookup type to get

Returns:

WsLookupType

Throws:

java.lang.Exception

getLookupsFromType

public WsLookup[] getLookupsFromType(WsAuth token,
                                     java.lang.Integer lookupTypeId)

Gets all lookup values associated with a lookup type. Only returns lookups that are active.

Specified by:

getLookupsFromType in interface ContourSoapService

Parameters:

token - the WsAuth item

lookupTypeId - id of the lookup type to get

Returns:

an array of WsLookups

Throws:

java.lang.Exception

updateLookup

public WsLookup updateLookup(WsAuth token,
                             WsLookup lookup)

Updates an existing lookup value.

Specified by:

updateLookup in interface ContourSoapService

Parameters:

token - the WsAuth item

lookup - the lookup to be updated

Returns:

the updated lookup

Throws:

java.lang.Exception

getChangeRequestAssociation

public WsChangeRequestAssociation getChangeRequestAssociation(WsAuth token,
                                                              java.lang.Long changeRequestAssociationId)

Gets a Change Request Association.

Specified by:

getChangeRequestAssociation in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestAssociationId - id of the Change Request Association

Returns:

WsChangeRequestAssociation

Throws:

java.lang.Exception

isChangeRequest

public java.lang.Boolean isChangeRequest(WsAuth token,
                                         java.lang.Integer itemId)

Does this item contain the Change Request component?

Specified by:

isChangeRequest in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the item to check

Returns:

whether or not the item is considered a Change Request

Throws:

java.lang.Exception

getChangeRequestAssociations

public WsChangeRequestAssociation[] getChangeRequestAssociations(WsAuth token,
                                                                 java.lang.Integer changeRequestItemId)

Gets all the Change Request Associations associated with a Change Request.

Specified by:

getChangeRequestAssociations in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestItemId - id of the Change Request to get associations from

Returns:

an array of WsChangeRequestAssociations

Throws:

java.lang.Exception

addChangeRequestAssociation

public WsChangeRequestAssociation addChangeRequestAssociation(WsAuth token,
                                                              WsChangeRequestAssociation changeRequestAssociation)

Adds a new Change Request Association.

Specified by:

addChangeRequestAssociation in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestAssociation - the association to add

Returns:

the added WsChangeRequestAssociation

Throws:

java.lang.Exception

updateChangeRequestAssociation

public WsChangeRequestAssociation updateChangeRequestAssociation(WsAuth token,
                                                                 WsChangeRequestAssociation changeRequestAssociation)

Updates a Change Request Association.

Specified by:

updateChangeRequestAssociation in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestAssociation - the association to update

Returns:

the updated WsChangeRequestAssociation

Throws:

java.lang.Exception

deleteChangeRequestAssociation

public java.lang.Boolean deleteChangeRequestAssociation(WsAuth token,
                                                        WsChangeRequestAssociation changeRequestAssociation)

Deletes a Change Request Association. (Caution: Irreversible)

Specified by:

deleteChangeRequestAssociation in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestAssociation - the association to update

Returns:

the updated WsChangeRequestAssociation

Throws:

java.lang.Exception

closeChangeRequest

public java.lang.Boolean closeChangeRequest(WsAuth token,
                                            java.lang.Integer changeRequestItemId)

Closes a Change Request. This fills out all ending versions for the Change Request with the current versions.

Specified by:

closeChangeRequest in interface ContourSoapService

Parameters:

token - the WsAuth item

changeRequestItemId - id of the Change Request to close

Returns:

whether or not the Change Request was successfully closed

Throws:

java.lang.Exception

getPermissionsByRefAndScope

public WsPermissions getPermissionsByRefAndScope(WsAuth token,
                                                 java.lang.Integer refId,
                                                 java.lang.Integer scope)

Gets the current user's permissions for a given object.

Specified by:

getPermissionsByRefAndScope in interface 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

Returns:

WsPermissions or null if invalid scope/ref

Throws:

java.lang.Exception

See Also:

WsScope

getDocumentType

public WsDocumentType getDocumentType(WsAuth token,
                                      java.lang.Long documentTypeId)

Gets a document type.

Specified by:

getDocumentType in interface ContourSoapService

Parameters:

token - the WsAuth item

documentTypeId - id of the document type to get

Returns:

WsDocumentType

Throws:

java.lang.Exception

getDocumentTypes

public WsDocumentType[] getDocumentTypes(WsAuth token,
                                         java.lang.Long organizationId)

Gets all the document types in an organization.

Specified by:

getDocumentTypes in interface ContourSoapService

Parameters:

token - the WsAuth item

organizationId - id of the organization to get document types from

Returns:

an array of WsDocumentTypes

Throws:

java.lang.Exception

getDocumentTypesForProject

public WsDocumentType[] getDocumentTypesForProject(WsAuth token,
                                                   java.lang.Long projectId)

Gets all the document types that are applicable to a project.

Specified by:

getDocumentTypesForProject in interface ContourSoapService

Parameters:

token - the WsAuth item

projectId - id of the project to get document types from

Returns:

an array of WsDocumentTypes

Throws:

java.lang.Exception

getDocumentTypeFields

public WsField[] getDocumentTypeFields(WsAuth token,
                                       java.lang.Long documentTypeId)

Gets the fields associated with a document type.

Specified by:

getDocumentTypeFields in interface ContourSoapService

Parameters:

token - the WsAuth item

documentTypeId - id of the document type to get fields from

Returns:

an array of WsFields

Throws:

java.lang.Exception

isValidDocumentPlacement

public java.lang.Boolean isValidDocumentPlacement(WsAuth token,
                                                  java.lang.Long documentTypeId,
                                                  java.lang.Long parentId)

Returns whether or not an item of the given document type can be placed as a child of an item.

Specified by:

isValidDocumentPlacement in interface ContourSoapService

Parameters:

token - the WsAuth item

documentTypeId - id of the document type to check

parentId - id of the parent to check

Returns:

Boolean

Throws:

java.lang.Exception

moveDocument

public java.lang.Boolean moveDocument(WsAuth token,
                                      java.lang.Long itemId,
                                      java.lang.Long newParentId)

Moves a document from it's current position in the explorer tree to be under another document.

Specified by:

moveDocument in interface ContourSoapService

Parameters:

token - the WsAuth item

itemId - id of the document to move

newParentId - id of the document to be the new parent of the moved document

Returns:

Boolean whether or not the move occurred correctly

Throws:

java.lang.Exception

setItemService

public void setItemService(com.jamasoftware.contour.ws.v3.service.WsItemService itemService)

setWsSubscriptionService

public void setWsSubscriptionService(com.jamasoftware.contour.ws.v3.service.WsSubscriptionService wsSubscriptionService)

setWsCommentService

public void setWsCommentService(com.jamasoftware.contour.ws.v3.service.WsCommentService wsCommentService)

setWsUserService

public void setWsUserService(com.jamasoftware.contour.ws.v3.service.WsUserService wsUserService)

setWsRelationshipService

public void setWsRelationshipService(com.jamasoftware.contour.ws.v3.service.WsRelationshipService wsRelationshipService)

setWsReleaseService

public void setWsReleaseService(com.jamasoftware.contour.ws.v3.service.WsReleaseService wsReleaseService)

setWsProjectService

public void setWsProjectService(com.jamasoftware.contour.ws.v3.service.WsProjectService wsProjectService)

setWsFilterService

public void setWsFilterService(com.jamasoftware.contour.ws.v3.service.WsFilterService wsFilterService)

setWsActivityService

public void setWsActivityService(com.jamasoftware.contour.ws.v3.service.WsActivityService wsActivityService)

setWsBaselineService

public void setWsBaselineService(com.jamasoftware.contour.ws.v3.service.WsBaselineService wsBaselineService)

setWsOrganizationService

public void setWsOrganizationService(com.jamasoftware.contour.ws.v3.service.WsOrganizationService wsOrganizationService)

setWsPropertyService

public void setWsPropertyService(com.jamasoftware.contour.ws.v3.service.WsPropertyService wsPropertyService)

setWsAttachmentService

public void setWsAttachmentService(com.jamasoftware.contour.ws.v3.service.WsAttachmentService wsAttachmentService)

setWsLookupService

public void setWsLookupService(com.jamasoftware.contour.ws.v3.service.WsLookupService wsLookupService)

setWsChangeRequestAssociationService

public void setWsChangeRequestAssociationService(com.jamasoftware.contour.ws.v3.service.WsChangeRequestAssociationService wsChangeRequestAssociationService)

setWsVersionService

public void setWsVersionService(com.jamasoftware.contour.ws.v3.service.WsVersionService wsVersionService)

setWsDocumentTypeService

public void setWsDocumentTypeService(com.jamasoftware.contour.ws.v3.service.WsDocumentTypeService wsDocumentTypeService)

addModule

@Deprecated
public WsModule addModule(WsAuth token,
                                     WsModule module)

Deprecated.

deactivateModule

@Deprecated
public java.lang.Boolean deactivateModule(WsAuth token,
                                                     java.lang.Long moduleId)

Deprecated.

getModule

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

Deprecated.

getModuleForProjectAndDocumentType

@Deprecated
public WsModule getModuleForProjectAndDocumentType(WsAuth token,
                                                              java.lang.Integer projectId,
                                                              java.lang.Integer documentTypeId)

Deprecated.

getModules

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

Deprecated.

updateModule

@Deprecated
public WsModule updateModule(WsAuth token,
                                        WsModule module)

Deprecated.

addFilter

@Deprecated
public WsFilter addFilter(WsAuth token,
                                     WsFilter filter)

Deprecated.

updateFilter

@Deprecated
public WsFilter updateFilter(WsAuth token,
                                        WsFilter filter)

Deprecated.

deleteFilter

@Deprecated
public java.lang.Boolean deleteFilter(WsAuth token,
                                                 WsFilter filter)

Deprecated.