public interface IService
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
STATUS_DB_EXCEPTION
This status is returned when a database exception occurs.
|
static java.lang.String |
STATUS_LOGIC_EXCEPTION
This status is returned when a business logic exception is thrown.
|
static java.lang.String |
STATUS_OK
This status is returned if there were no errors.
|
static java.lang.String |
STATUS_VALIDATION_EXCEPTION
This status is returned when some data are not valid
|
Modifier and Type | Method and Description |
---|---|
WSResponse |
addListOptions(WSRequestOptionArray requestOptions)
Add an array of options to a custom list.
|
WSResponse |
addPersonsToGroup(WSRequestGroupAssigment requestGroupAssigment)
Add person(s) to group.
|
WSResponse |
addRoleAssignment(WSRequestRoleAssignmentEdit requestRoleAssignmentEdit)
Add a single role assignment for a single user and project.
|
WSResponse |
archiveItem(WSRequestString requestItemID)
Set the archive flag for an item.
|
WSResponse |
changeItemStatus(WSRequestItem requestItem)
Save a change status of an item.
|
WSResponseBoolean |
checkVersion(WSRequestString requestClientVersion)
It is assumed that the interface evolves over time.
|
WSResponseListOptionArray |
clearListOptions(WSRequestString requestListID)
Clear custom list options.
|
WSResponseString |
copyItem(WSRequestCopyItem requestItem)
Create a clone of the item.
|
WSResponse |
deleteAttachment(WSRequestAttachment requestAttachment)
Delete an attachment.
|
WSResponse |
deleteComments(WSRequestDeleteComments requestDeletecomments)
Delete one or more comments for the given item.
|
WSResponse |
deleteGroup(WSRequestString requestGroupID)
Delete a group by its object identifier without replacement.
|
WSResponse |
deleteItem(WSRequestString requestItemID)
Set the delete flag for an item.
|
WSResponse |
deleteItemLinks(WSRequestDeleteItemLinks requestDeleteLinks)
Delete one or more links for the given item.
|
WSResponse |
deleteList(WSRequestString requestListID)
Delete a custom list.
|
WSResponse |
deleteListOption(WSRequestString requestOptionID)
Delete a custom list option.
|
WSResponse |
deletePerson(WSRequestString requestPersonID)
Delete a person by its object identifier without replacement.
|
WSResponse |
deleteProject(WSRequestString requestProjectID)
Delete a project specified by its object identifier.
|
WSResponseDownloadAttachment |
downloadAttachment(WSRequestAttachment requestAttachment)
Obtain the attachment file as a web-service attachment.
|
WSResponse |
editComment(WSRequestComment requestComment)
Edit a comment.
|
WSResponseQueryResult |
executeCustomQuery(WSRequestQueryConfig requestQueryConfig)
Execute a custom query.
|
WSResponseQueryResult |
executeQuery(WSRequestString requestQueryID)
Execute the query with given id.
|
WSResponseGroupArray |
getAllGroups()
Get all groups.
|
WSResponsePersonArray |
getAllPersons()
Get all persons.
|
WSResponseLabelValueBeanArray |
getAllProjects()
Get all project (workspace) names and object identifiers.
|
WSResponseLabelValueBeanArray |
getAllRoles()
Get all roles.
|
WSResponseRoleAssignmentArray |
getAssignmentRolesByProject(WSRequestString requestProjectID)
Get an array with all role ids and for each role the user ids for the project identified by the object id.
|
WSResponseRoleAssignmentArray |
getAssignmentRolesByProjectName(WSRequestString requestProjectName)
Get an array with all role ids and for each role the user ids for the project identified by its name.
|
WSResponseBaseOptionsContainer |
getBaseOptionsContainer()
Returns the base options (selections):
contains all projects (workspaces), item types, priorities, and states
|
WSResponseEditItemContext |
getChangeStatusItemContext(WSRequestString requestItemID)
Obtain the change status item context.
|
WSResponseForm |
getChangeStatusItemForm(WSRequestItemLocation requestItemLocation)
Get the form for change status for an item.
|
WSResponseCommentArray |
getComments(WSRequestString requestItemID)
Get all comments for the given item object identifier.
|
WSResponseFieldArray |
getCustomFields()
Obtain all custom fields defined.
|
WSResponseDisplayItem |
getDisplayItem(WSRequestString requestItemID)
Obtain an item and the display values for fields.
|
WSResponseGroupEdit |
getEditGroup(WSRequestString requestGroupID)
Get a group for edit purposes.
|
WSResponseEditItemContext |
getEditItemContext(WSRequestString requestItemID)
Obtain the edit item context.
|
WSResponseForm |
getEditItemForm(WSRequestItemLocation requestItemLocation)
Get the form for edit item.
|
WSResponsePersonEdit |
getEditPerson(WSRequestString requestPersonID)
Get the person identified by the object id without selection options.
|
WSResponsePersonEdit |
getEditPersonByLoginName(WSRequestString requestLoginName)
Get the person identified by the login name without selection options.
|
WSResponsePersonEditWithContext |
getEditPersonWithContext(WSRequestString requestPersonID)
Get the person identified by the object id with selection options.
|
WSResponsePersonEditWithContext |
getEditPersonWithContextByLoginName(WSRequestString requestLoginName)
Get the person identified by the login name with selection options.
|
WSResponseProjectEdit |
getEditProject(WSRequestString requestProjectID)
Get a project without selection options by its project id.
|
WSResponseProjectEdit |
getEditProjectByName(WSRequestString requestProjectName)
Get a project without selection options by its name.
|
WSResponseProjectEditWithContext |
getEditProjectWithContext(WSRequestString requestProjectID)
Get a project with selection options by its project id.
|
WSResponseProjectEditWithContext |
getEditProjectWithContextByName(WSRequestString requestProjectName)
Get a project with selection options by its project name.
|
WSResponseListArray |
getGlobalLists()
Get all global (public) custom selection lists.
|
WSResponseLabelValueBeanArray |
getIssueTypes(WSRequestString requestProject)
Deprecated.
use
getItemTypes(WSRequestString) instead |
WSResponseItem |
getItem(WSRequestString requestItemID)
This method fetches a specific item specified by its
object id from the database.
|
WSResponseItemContext |
getItemContext(WSRequestString requestItemID)
Obtain the item context.
|
WSResponseItemContextArray |
getItemContexts(WSRequestStringArray requestItemIDs)
This method obtains the items for the given object identifiers.
|
WSResponseItemHistory |
getItemHistory(WSRequestString requestItemID)
This method fetches the history for a specific item specified by its
object id from the database.
|
WSResponseItemLink |
getItemLink(WSRequestItemLink requestItemLink)
Get a link for the given id
|
WSResponseItemLinkArray |
getItemLinks(WSRequestString requestItemID)
Get all links for the given item object identifier.
|
WSResponseLabelValueBeanArray |
getItemTypes(WSRequestString requestProject)
Get all item types available for the given project (workspace) (workspace).
|
WSResponseParameterArray |
getLinkTpeParameters(WSRequestString requestLinkTypeID)
Get link type parameters
|
WSResponseOptionArray |
getLinkTypes()
get all link types
|
WSResponseListOptionArray |
getListOptions(WSRequestString requestListID)
Get all options for a custom list.
|
WSResponseListOptionArray |
getListOptionsByParent(WSRequestString requestParentID)
Get all sub-options of a parent option.
|
WSResponseEditItemContext |
getMoveItemContext(WSRequestMoveItem requestMoveItem)
Move item to another project (workspace) and item type.
|
WSResponseForm |
getMoveItemForm(WSRequestItemLocation requestItemLocation)
Get the form for moving an item to another project (workspace) or item type.
|
WSResponseEditItemContext |
getNewItemChildContext(WSRequestNewItemChild requestItemLocation)
Create a new child item context.
|
WSResponseForm |
getNewItemChildForm(WSRequestItemLocation requestItemLocation)
Get the form for editing a new child item.
|
WSResponseEditItemContext |
getNewItemContext(WSRequestItemLocation requestItemLocation)
Create a new item context.
|
WSResponseForm |
getNewItemForm(WSRequestItemLocation requestItemLocation)
Get the form for edit new item.
|
WSResponsePersonEditWithContext |
getNewPersonWithContext()
Get an empty person with all selection options.
|
WSResponseProjectEditWithContext |
getNewProjectWithContext()
Get a new empty project with selection options.
|
WSResponsePersonArray |
getPersonsForGroup(WSRequestString requestGroupID)
Get persons in the group
|
WSResponseListArray |
getProjectLists(WSRequestString requestProjectID)
Get all custom lists configured specifically for a workspace or project.
|
WSResponseLabelValueBeanArray |
getProjects()
Get project (workspace) names and object identifiers but only those where
this user has access rights and items in.
|
WSResponseTreeNodeArray |
getProjectsAsTree()
Get all projects (workspaces) as a tree node array, preserving the hierarchy.
|
WSResponseTreeNodeArray |
getProjectsWithCreateItemRightForItemType(WSRequestString requestItemType)
Get the projects where the current user has create permissions for items of the given
item type.
|
WSResponseTreeNodeArray |
getQueries()
Get all queries in a hierarchical structure.
|
WSResponseStringArray |
getServerVersionAndCompatible()
Get the server version and compatible versions.
|
WSResponseLabelValueBeanArray |
getUsedProjects()
Get all project (workspace) names and object identifiers for this user.
|
WSResponseBoolean |
isLoggedIn()
This method returns the current login status.
|
WSResponseList |
loadList(WSRequestString requestListID)
Load a single custom list by id with all its options.
|
WSResponseQueryConfig |
loadQueryConfigBean(WSRequestQueryConfig requestQueryConfig)
Load the query configuration bean with given selections.
|
WSResponsePerson |
login(WSRequestLogon requestLogon)
This method is used to log in the client with the user specific data
stored in the
WSLogonBean (mainly user name and password). |
WSResponseBoolean |
logoff()
This method is used to log off the user from the Track+ server and
invalidate the corresponding session.
|
WSResponse |
moveItem(WSRequestItem requestItem)
Move an item to a new space or item type.
|
WSResponse |
removePersonsFromGroup(WSRequestGroupAssigment requestGroupAssigment)
Remove person(s) from group.
|
WSResponse |
removeRoleAssignment(WSRequestRoleAssignmentEdit requestRoleAssignmentEdit)
Remove a single role assignment for a single user and project.
|
WSResponse |
replaceAndDeleteGroup(WSRequestReplaceAndDelete replaceAndDelete)
Replace and delete a group.
|
WSResponse |
replaceAndDeletePerson(WSRequestReplaceAndDelete replaceAndDeletePerson)
Replace and delete a person.
|
WSResponseAttachment |
saveAttachment(WSRequestAttachment requestAttachment,
javax.activation.DataHandler file)
Save an attachment.
|
WSResponseString |
saveGroup(WSRequestGroupEdit requestGroupEdit)
Save a group.
|
WSResponseString |
saveItem(WSRequestItem requestItem)
This method makes the item bean persistent (saves it into the database).
|
WSResponseString |
saveItemLink(WSRequestItemLinkEdit requestItemLinkEdit)
Save a item link.
|
WSResponseString |
saveList(WSRequestList requestListEdit)
Save a custom list.
|
WSResponseString |
saveListOption(WSRequestOption requestOption)
Save a custom list option.
|
WSResponseString |
savePerson(WSRequestPersonEdit requestPersonEdit)
Save a person.
|
WSResponseString |
saveProject(WSRequestProjectEdit requestProjectEdit)
Save a project.
|
WSResponse |
unarchiveItem(WSRequestString requestItemID)
Reset the archive flag for an item.
|
WSResponse |
undeleteItem(WSRequestString requestItemID)
Reset the delete flag for an item.
|
static final java.lang.String STATUS_OK
static final java.lang.String STATUS_DB_EXCEPTION
static final java.lang.String STATUS_LOGIC_EXCEPTION
static final java.lang.String STATUS_VALIDATION_EXCEPTION
WSResponsePerson login(WSRequestLogon requestLogon)
WSLogonBean
(mainly user name and password). The
return value is a WSResponsePerson
which provides all user specific
data, such as last name, first name, preferred locale and so on.requestLogon
- contains user name and passwordgetStatus()==0
).WSResponseBoolean logoff()
getValue()==true
WSResponseBoolean isLoggedIn()
getValue()=true
if the user is logged on.WSResponseBoolean checkVersion(WSRequestString requestClientVersion)
requestClientVersion
- the version of the client interface (TCLFacade)WSResponseStringArray getServerVersionAndCompatible()
WSResponseTreeNodeArray getQueries()
WSResponseQueryResult executeQuery(WSRequestString requestQueryID)
requestQueryID
- an request that contains the id of the queryWSQueryResultItemBean
WSResponseQueryResult executeCustomQuery(WSRequestQueryConfig requestQueryConfig)
requestQueryConfig
- a wrapper class that contains an WSQueryConfigBean
WSQueryResultItemBean
WSResponseQueryConfig loadQueryConfigBean(WSRequestQueryConfig requestQueryConfig)
requestQueryConfig
- WSResponseString saveItem(WSRequestItem requestItem)
requestItem
- a wrapper over an WSItemBean
WSResponseString copyItem(WSRequestCopyItem requestItem)
requestItem
- contains the item id and the deepCopy(if this is true copy the all history)WSResponse moveItem(WSRequestItem requestItem)
requestItem
- WSResponse changeItemStatus(WSRequestItem requestItem)
requestItem
- WSResponse archiveItem(WSRequestString requestItemID)
requestItemID
- WSResponse unarchiveItem(WSRequestString requestItemID)
requestItemID
- WSResponse deleteItem(WSRequestString requestItemID)
requestItemID
- WSResponse undeleteItem(WSRequestString requestItemID)
requestItemID
- WSResponseItem getItem(WSRequestString requestItemID)
requestItemID
- the object id of the item to be fetched from the database.WSItemBean
WSResponseItemHistory getItemHistory(WSRequestString requestItemID)
requestItemID
- the object id of the item to be fetched from the database.WSItemHistoryBean
WSResponseItemContextArray getItemContexts(WSRequestStringArray requestItemIDs)
requestItemIDs
- the object ids of the items to be fetched from the database.WSItemContextBean
WSResponseItemContext getItemContext(WSRequestString requestItemID)
requestItemID
- the id of the itemWSItemContextBean
WSResponseDisplayItem getDisplayItem(WSRequestString requestItemID)
requestItemID
- the id of the itemWSDisplayItemBean
WSResponseEditItemContext getEditItemContext(WSRequestString requestItemID)
requestItemID
- the id of the itemWSItemContextBean
WSResponseForm getEditItemForm(WSRequestItemLocation requestItemLocation)
requestItemLocation
- contains the projectId and issuTypeIdWSFormBean
WSResponseEditItemContext getNewItemContext(WSRequestItemLocation requestItemLocation)
requestItemLocation
- Contains the projectID and issueTypeIDWSEditItemContextBean
WSResponseForm getNewItemForm(WSRequestItemLocation requestItemLocation)
requestItemLocation
- contains the projectId and issuTypeIdWSFormBean
WSResponseEditItemContext getNewItemChildContext(WSRequestNewItemChild requestItemLocation)
requestItemLocation
- contains the projectID and issueTypeID and parent issue idWSEditItemContextBean
WSResponseForm getNewItemChildForm(WSRequestItemLocation requestItemLocation)
requestItemLocation
- contains the projectId and issuTypeIdWSFormBean
WSResponseEditItemContext getMoveItemContext(WSRequestMoveItem requestMoveItem)
requestMoveItem
- contains the id of the item, the new project (workspace) and issue typeWSResponseForm getMoveItemForm(WSRequestItemLocation requestItemLocation)
requestItemLocation
- contains the projectId and issuTypeIdWSFormBean
WSResponseEditItemContext getChangeStatusItemContext(WSRequestString requestItemID)
requestItemID
- the id of the itemWSEditItemContextBean
WSResponseForm getChangeStatusItemForm(WSRequestItemLocation requestItemLocation)
requestItemLocation
- contains the project object id and item type object idWSFormBean
WSResponseLabelValueBeanArray getProjects()
WSResponseLabelValueBeanArray getUsedProjects()
WSResponseLabelValueBeanArray getAllProjects()
WSResponseTreeNodeArray getProjectsAsTree()
WSResponseProjectEditWithContext getNewProjectWithContext()
WSProjectEditBean
WSResponseProjectEdit getEditProject(WSRequestString requestProjectID)
requestProjectID
- the object id of the projectWSProjectEditBean
WSResponseProjectEdit getEditProjectByName(WSRequestString requestProjectName)
requestProjectName
- the name of the projectWSProjectEditBean
WSResponseProjectEditWithContext getEditProjectWithContext(WSRequestString requestProjectID)
requestProjectID
- the object id of the projectWSProjectEditWithContext
WSResponseProjectEditWithContext getEditProjectWithContextByName(WSRequestString requestProjectName)
requestProjectName
- the name of the projectWSProjectEditWithContext
WSResponseString saveProject(WSRequestProjectEdit requestProjectEdit)
requestProjectEdit
- the project to be saved to the databaseWSResponse deleteProject(WSRequestString requestProjectID)
requestProjectID
- the project object idWSResponseTreeNodeArray getProjectsWithCreateItemRightForItemType(WSRequestString requestItemType)
Get the projects where the current user has create permissions for items of the given item type. If the item type parameter is null, return all projects where the current user has create permissions for items for at least one item type.
If no issue type specified return all projects with create right.
requestItemType
- @Deprecated WSResponseLabelValueBeanArray getIssueTypes(WSRequestString requestProject)
getItemTypes(WSRequestString)
insteadrequestProject
- a request wrapper over the project (workspace) idWSResponseLabelValueBeanArray getItemTypes(WSRequestString requestProject)
requestProject
- a request wrapper over the project (workspace) idWSResponseBaseOptionsContainer getBaseOptionsContainer()
WSBaseOptionsContainer
WSResponseFieldArray getCustomFields()
WSResponseAttachment saveAttachment(WSRequestAttachment requestAttachment, javax.activation.DataHandler file)
requestAttachment
- WSAttachmentBean
with the response statusWSResponse deleteAttachment(WSRequestAttachment requestAttachment)
requestAttachment
- WSAttachmentBean
with the response statusWSResponseDownloadAttachment downloadAttachment(WSRequestAttachment requestAttachment)
requestAttachment
- DataHandler
with the response statusWSResponseCommentArray getComments(WSRequestString requestItemID)
requestItemID
- WSCommentEdit
with the response statusWSResponse deleteComments(WSRequestDeleteComments requestDeletecomments)
requestDeletecomments
- WSResponse editComment(WSRequestComment requestComment)
requestComment
- WSResponseItemLinkArray getItemLinks(WSRequestString requestItemID)
requestItemID
- WSItemLinkBean
with the response statusWSResponseItemLink getItemLink(WSRequestItemLink requestItemLink)
requestItemLink
- WSItemLinkBean
with the response statusWSResponse deleteItemLinks(WSRequestDeleteItemLinks requestDeleteLinks)
requestDeleteLinks
- WSResponseString saveItemLink(WSRequestItemLinkEdit requestItemLinkEdit)
requestItemLinkEdit
- WSResponseOptionArray getLinkTypes()
WSLabelValueBean
objectsWSResponseParameterArray getLinkTpeParameters(WSRequestString requestLinkTypeID)
requestLinkTypeID
- WSResponsePersonArray getAllPersons()
WSPersonBean
objectsWSResponsePersonArray getPersonsForGroup(WSRequestString requestGroupID)
requestGroupID
- the id of the groupWSPersonBean
objectsWSResponsePersonEditWithContext getNewPersonWithContext()
WSPersonEditWithContext
WSResponsePersonEdit getEditPerson(WSRequestString requestPersonID)
requestPersonID
- WSPersonEditBean
WSResponsePersonEdit getEditPersonByLoginName(WSRequestString requestLoginName)
requestLoginName
- WSPersonEditBean
WSResponsePersonEditWithContext getEditPersonWithContext(WSRequestString requestPersonID)
requestPersonID
- WSPersonEditWithContext
WSResponsePersonEditWithContext getEditPersonWithContextByLoginName(WSRequestString requestLoginName)
requestLoginName
- WSPersonEditWithContext
WSResponseString savePerson(WSRequestPersonEdit requestPersonEdit)
requestPersonEdit
- the person to be saved to the databaseWSResponse deletePerson(WSRequestString requestPersonID)
replaceAndDeletePerson(WSRequestReplaceAndDelete)
.requestPersonID
- the persons object idWSResponse replaceAndDeletePerson(WSRequestReplaceAndDelete replaceAndDeletePerson)
replaceAndDeletePerson
- WSResponseGroupArray getAllGroups()
WSGroupBean
objectsWSResponseGroupEdit getEditGroup(WSRequestString requestGroupID)
requestGroupID
- WSGroupEditBean
WSResponseString saveGroup(WSRequestGroupEdit requestGroupEdit)
requestGroupEdit
- the group to be saved to the databaseWSResponse deleteGroup(WSRequestString requestGroupID)
replaceAndDeleteGroup(WSRequestReplaceAndDelete)
.requestGroupID
- the group object idWSResponse replaceAndDeleteGroup(WSRequestReplaceAndDelete replaceAndDelete)
replaceAndDelete
- WSResponse addPersonsToGroup(WSRequestGroupAssigment requestGroupAssigment)
requestGroupAssigment
- contains id of the group and person id(s)WSResponse removePersonsFromGroup(WSRequestGroupAssigment requestGroupAssigment)
requestGroupAssigment
- contains id of the group and person id(s)WSResponseLabelValueBeanArray getAllRoles()
WSResponseRoleAssignmentArray getAssignmentRolesByProject(WSRequestString requestProjectID)
requestProjectID
- WSResponseRoleAssignmentArray getAssignmentRolesByProjectName(WSRequestString requestProjectName)
requestProjectName
- WSResponse addRoleAssignment(WSRequestRoleAssignmentEdit requestRoleAssignmentEdit)
requestRoleAssignmentEdit
- WSResponse removeRoleAssignment(WSRequestRoleAssignmentEdit requestRoleAssignmentEdit)
requestRoleAssignmentEdit
- WSResponseListArray getGlobalLists()
WSResponseListArray getProjectLists(WSRequestString requestProjectID)
requestProjectID
- WSListBean
objectsWSResponseList loadList(WSRequestString requestListID)
requestListID
- the object identifier of the listWSListBean
objectWSResponseListOptionArray getListOptions(WSRequestString requestListID)
requestListID
- the object identifier of the listWSListOptionBean
objectsWSResponseListOptionArray getListOptionsByParent(WSRequestString requestParentID)
requestParentID
- WSListOptionBean
objectsWSResponseString saveList(WSRequestList requestListEdit)
requestListEdit
- a wrapped list objectWSResponse deleteList(WSRequestString requestListID)
requestListID
- WSResponseListOptionArray clearListOptions(WSRequestString requestListID)
requestListID
- WSListOptionBean
objectsWSResponse addListOptions(WSRequestOptionArray requestOptions)
requestOptions
- WSResponseString saveListOption(WSRequestOption requestOption)
requestOption
- WSResponse deleteListOption(WSRequestString requestOptionID)
requestOptionID
-