Interface TrackerWebService

  • All Superinterfaces:
    java.rmi.Remote

    public interface TrackerWebService
    extends java.rmi.Remote
    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void addApprovee​(java.lang.String workitemURI, java.lang.String approveeId)
      Adds an approvee.
      boolean addAssignee​(java.lang.String workitemURI, java.lang.String assigneeId)
      Adds an assignee.
      boolean addCategory​(java.lang.String workitemURI, java.lang.String categoryId)
      Adds a Category to a Work Item.
      java.lang.String addComment​(java.lang.String parentObjectUri, java.lang.String title, Text content)
      Adds a comment to a Work Item, Document, Test Run or as a reply to an existing comment.
      void addCommentToActivity​(java.lang.String activityGlobalId, Text commentText)
      Adds a comment to the Activity.
      boolean addExternalLinkedRevision​(java.lang.String workitemURI, java.lang.String repositoryName, java.lang.String revisionId)
      Links a revision from an external repository.
      boolean addExternallyLinkedItem​(java.lang.String workitemURI, java.lang.String linkedExternalWorkitemURI, EnumOptionId role)
      Adds an external linked Work Item.
      boolean addHyperlink​(java.lang.String workitemURI, java.lang.String url, EnumOptionId role)
      Adds a hyperlink.
      boolean addLinkedItem​(java.lang.String workitemURI, java.lang.String linkedWorkitemURI, EnumOptionId role)
      Adds a linked Work Item.
      boolean addLinkedItemWithRev​(java.lang.String in0, java.lang.String in1, EnumOptionId in2, java.lang.String in3, boolean in4)
      Adds a linked item to the specific Work Item with a revision.
      boolean addLinkedOslcItem​(java.lang.String workitemURI, java.lang.String linkedOslcItemURI, EnumOptionId role, java.lang.String label)
      Adds an OSLC item.
      boolean addLinkedRevision​(java.lang.String workitemURI, java.lang.String revisionId)
      Links a revision.
      boolean addPlaningContraint​(java.lang.String workitemURI, java.util.Calendar date, EnumOptionId constraint)
      Adds a planing constraint.
      boolean canCommentActivity​(java.lang.String activityGlobalId)
      Returns true if the Activity allows for comments.
      boolean canCurrentUserAddCommentToActivity​(java.lang.String activityGlobalId)
      Returns true if the current User can comment on the Activity.
      void createAttachment​(java.lang.String workitemURI, java.lang.String fileName, java.lang.String title, byte[] data)
      Creates a new attachment.
      Baseline createBaseline​(java.lang.String projectId, java.lang.String name, java.lang.String description, java.lang.String revision)
      Creates a Baseline from the head or particular revision.
      void createComment​(java.lang.String workitemURI, Text content)
      java.lang.String createCommentNew​(java.lang.String parentURI, java.lang.String title, Text content, java.lang.String[] visibleTo)
      java.lang.String createDocument​(java.lang.String projectId, java.lang.String location, java.lang.String documentName, java.lang.String documentTitle, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, java.lang.String homePageContent)
      Creates a Document in the given location with the given parameters.
      java.lang.String createDocumentComment​(java.lang.String documentURI, Text text)
      java.lang.String createDocumentCommentReferringWI​(java.lang.String documentURI, java.lang.String workItemURI, Text text)
      Creates a comment referring to a Work Item in the Document.
      java.lang.String createDocumentCommentReply​(java.lang.String parentURI, Text text)
      Folder createFolder​(java.lang.String projectId, java.lang.String parentName, java.lang.String name, java.lang.String title)
      Creates and returns a sub folder for parentName folder, if it is not null, otherwise it creates a new folder under the "Documents & Pages" root Topic.
      java.lang.String createModule​(java.lang.String projectId, java.lang.String location, java.lang.String moduleName, EnumOptionId[] allowedWITypes, EnumOptionId structureLinkRole, boolean parentToChild, java.lang.String homePageContent)
      Creates a document or an old-style Module/Document in a given location with the given parameters.
      java.lang.String createWorkItem​(WorkItem content)
      Creates a new Work Item with the given content.
      java.lang.String createWorkItemInModule​(java.lang.String moduleURI, java.lang.String parentWorkItemURI, WorkItem workItem)
      Creates a Work Item at a specified position inside the Module/Document.
      void createWorkRecord​(java.lang.String workitemURI, User user, java.util.Date date, java.lang.String timeSpent)
      Creates a Work Record.
      void createWorkRecordWithTypeAndComment​(java.lang.String workitemURI, User user, java.util.Date date, EnumOptionId type, java.lang.String timeSpent, java.lang.String comment)
      Creates a Work Record.
      void deleteAttachment​(java.lang.String workitemURI, java.lang.String id)
      Remove an attachment.
      void deleteBaseline​(java.lang.String baselineURI)
      Deletes the given Baseline.
      void deleteModule​(java.lang.String moduleURI)
      Deletes a Module/Document.
      void deleteWorkRecord​(java.lang.String workitemURI, java.lang.String workRecordURI)
      Deletes a Work Record.
      void doAutoassign​(java.lang.String workitemURI)
      Triggers autoassignement.
      void doAutoSuspect​(java.lang.String workitemURI)
      Triggers auto suspect.
      void editApproval​(java.lang.String workitemURI, java.lang.String approveeId, EnumOptionId status)
      Changes the status of an approval.
      Change[] generateHistory​(java.lang.String workitemURI, java.lang.String[] ignoredFields, java.lang.String[] fieldOrder)
      Gets the Work Item's history.
      Activity getActivityByGlobalId​(java.lang.String activityGlobalId)
      Returns the Activity with the given global Id.
      EnumOptionId[] getAllEnumOptionIdsForId​(java.lang.String projectID, java.lang.String enumId)
      Gets all enumeration option IDs.
      EnumOptionId[] getAllEnumOptionIdsForKey​(java.lang.String projectID, java.lang.String key)
      Gets all enumeration option IDs.
      EnumOption[] getAllEnumOptionsForId​(java.lang.String projectID, java.lang.String enumID)
      Gets all enumeration options.
      EnumOption[] getAllEnumOptionsForKey​(java.lang.String projectID, java.lang.String key)
      Gets all enumeration options.
      User[] getAllowedApprovers​(java.lang.String workitemURI)
      Gets all allowed approvers.
      User[] getAllowedAssignees​(java.lang.String workitemURI)
      Gets all allowed assignees.
      WorkflowAction[] getAvailableActions​(java.lang.String workitemURI)
      Gets the actions that can be used on the workflow object in its current state.
      EnumOptionId[] getAvailableEnumOptionIdsForId​(java.lang.String workitemURI, java.lang.String enumID)
      Gets the available enumeration option IDs.
      EnumOptionId[] getAvailableEnumOptionIdsForKey​(java.lang.String workitemURI, java.lang.String key)
      Gets the available enumeration option IDs.
      LinkedWorkItem[] getBackLinkedWorkitems​(java.lang.String workitemURI)
      Gets the back linked Work Items.
      Category[] getCategories​(java.lang.String projectId)
      Get the categories defined for the give project id.
      Folder[] getChildFolders​(java.lang.String projectId, java.lang.String parentFolderId)
      Returns list of folders contained in this folder.
      CustomField getCustomField​(java.lang.String workitemURI, java.lang.String key)
      Gets a Work Item's custom field.
      java.lang.String[] getCustomFieldKeys​(java.lang.String workitemURI)
      Gets the names of defined custom fields.
      CustomFieldType getCustomFieldType​(java.lang.String workitemURI, java.lang.String key)
      Gets the custom field definitions for a specific Work Item.
      CustomFieldType[] getCustomFieldTypes​(java.lang.String workitemURI)
      Gets all custom field definitions for a specific Work Item.
      LanguageDefinition getDefaultLanguageDefinition​(java.lang.String projectId)
      Returns the language definition for the default language.
      java.lang.String[] getDefinedCustomFieldKeys​(java.lang.String projectID, java.lang.String typeID)
      Gets all custom field keys defined for a Work Item Type in a Project.
      CustomFieldType getDefinedCustomFieldType​(java.lang.String projectID, java.lang.String typeID, java.lang.String key)
      Gets a custom field definition for a Work Item Type.
      CustomFieldType[] getDefinedCustomFieldTypes​(java.lang.String projectID, java.lang.String typeID)
      Gets all custom field definitions for a Work Item Type.
      java.lang.String[] getDocumentLocations​(java.lang.String projectId)
      Gets the document locations (e.g.
      java.lang.String[] getDocumentSpaces​(java.lang.String projectId)
      Returns Module/Document Spaces from given Project.
      float getDurationHours​(java.lang.String duration)
      Gets duration time in hours
      java.lang.String getEnumControlKeyForId​(java.lang.String projectID, java.lang.String enumID)
      Gets the enumeration control key for the specified Work Item key.
      java.lang.String getEnumControlKeyForKey​(java.lang.String projectID, java.lang.String key)
      Gets the enumeration control key for the specified Work Item key.
      EnumOption getEnumOptionFromObjectUriForId​(java.lang.String uri, java.lang.String enumId)
      Returns an instance of the IEnumOption of a given object URI and the enumeration Id.
      EnumOption getEnumOptionFromObjectUriForKey​(java.lang.String uri, java.lang.String prototypeName, java.lang.String key)
      Returns an instance of the IEnumOption of a given object URI, the Prototype name and the prototype object's key.
      EnumOption[] getEnumOptionsForId​(java.lang.String workitemURI, java.lang.String enumID)
      Gets the available enumeration options.
      EnumOption[] getEnumOptionsForIdWithControl​(java.lang.String projectID, java.lang.String enumID, java.lang.String controlValue)
      Gets the available enumeration options.
      EnumOption[] getEnumOptionsForKey​(java.lang.String workitemURI, java.lang.String key)
      Gets the available enumeration options.
      EnumOption[] getEnumOptionsForKeyWithControl​(java.lang.String projectID, java.lang.String key, java.lang.String controlValue)
      Gets the available enumeration options.
      EnumOption getEnumOptionWithEnumId​(java.lang.String workitemURI, java.lang.String enumID, EnumOptionId id)
      Gets an enumeration option.
      EnumOption getEnumOptionWithKey​(java.lang.String workitemURI, java.lang.String key, EnumOptionId id)
      Gets an enumeration option.
      EnumOption[] getFilteredEnumOptionsForKey​(java.lang.String uri, java.lang.String key, java.lang.String filter)
      Gets the available, filtered enumeration options.
      Folder getFolder​(java.lang.String projectId, java.lang.String folderName)
      Returns a folder specified by the Project and Folder name.
      Folder getFolderForURI​(java.lang.String objectURI)
      Returns the folder that the specified object is contained in.
      Folder[] getFolders​(java.lang.String projectId)
      Returns folders from the given Project or on the Global level.
      WorkflowAction getInitialWorkflowAction​(java.lang.String workitemURI)
      Gets the initial workflow action for the specified object and returns null if there is no initial action for the corresponding workflow.
      WorkflowAction getInitialWorkflowActionForProjectAndType​(java.lang.String projectId, EnumOptionId wiType)
      Gets the initial workflow action for a specific Work Item Type in the specific Project.
      LanguageDefinition getLanguageDefinition​(java.lang.String projectId, java.lang.String language)
      Returns the language definition for a given language.
      LanguageDefinition[] getLanguageDefinitions​(java.lang.String projectId)
      Returns all language definitions.
      LinkedResource[] getLinkedResources​(java.lang.String workitemURI)
      Returns a set of resources linked to the Work Item.
      Text getLocalizedWorkItemDescription​(java.lang.String uri, java.lang.String language)
      Returns the localized description or the normal description if the localized one is not defined or is empty.
      java.lang.String getLocalizedWorkItemDescriptionField​(java.lang.String projectId, java.lang.String language, EnumOptionId type)
      Returns the Id of the field of a Work Item of a given Type that stores the localized description.
      java.lang.String getLocalizedWorkItemTitle​(java.lang.String uri, java.lang.String language)
      Returns the localized title or normal title if the localized one is not defined or is empty.
      java.lang.String getLocalizedWorkItemTitleField​(java.lang.String projectId, java.lang.String language, EnumOptionId type)
      Returns the Id of the field of a Work Item of a given Type that stores the localized title.
      Module getModuleByLocation​(java.lang.String projectId, java.lang.String location)
      Retrieves the Module/Document on the given location.
      Module getModuleByLocationWithFields​(java.lang.String projectId, java.lang.String location, java.lang.String[] fields)
      Retrieves the Module/Document on the given location with the given fields set.
      Module getModuleByUri​(java.lang.String uri)
      Gets Module/Document with all fields filled.
      Module getModuleByUriWithFields​(java.lang.String uri, java.lang.String[] fields)
      Gets a Module/Document with given fields filled in.
      Module[] getModules​(java.lang.String projectId, java.lang.String location)
      Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
      java.lang.String[] getModulesSubFolders​(java.lang.String projectId, java.lang.String location)
      Returns the sub-folders of a given location relative to the "modules" folder of the given Project.
      Module[] getModulesWithFields​(java.lang.String projectId, java.lang.String location, java.lang.String[] fields)
      Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
      java.lang.String[] getModuleUris​(java.lang.String projectId, java.lang.String location)
      Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
      WorkItem[] getModuleWorkItems​(java.lang.String moduleURI, java.lang.String parentWorkItemURI, boolean deep, java.lang.String[] fields)
      Returns Work Items (with given fields set) contained in a given Module/Document under the given parent (if specified).
      java.lang.String[] getModuleWorkItemUris​(java.lang.String moduleURI, java.lang.String parentWorkItemURI, boolean deep)
      Returns the URIs of Work Items contained in a given Module/Document under given parent (if specified).
      long getOneDayLength()
      Gets the length of one day
      Revision getRevision​(java.lang.String repositoryName, java.lang.String revisionId)
      Gets a revision.
      Revision getRevisionByUri​(java.lang.String revisionURI)
      Gets a revision.
      java.lang.String[] getRevisions​(java.lang.String in0)
      Returns all revisions for a specific URI.
      Folder[] getRootFolders​(java.lang.String projectId)
      Returns parent folders from the given Project or on the Global level.
      TimePoint[] getTimepoints​(java.lang.String projectId)
      Gets the time points available for a Project.
      WorkflowAction[] getUnavailableActions​(java.lang.String workitemURI)
      Gets the actions that can not be used on the Work Item in the current state because of unsatisfied condition(s).
      WikiPage getWikiPageByUri​(java.lang.String uri)
      Returns a Wiki Page with the given SubterraURI.
      WikiPage getWikiPageByUriWithFields​(java.lang.String uri, java.lang.String[] fields)
      Returns a Wiki Page with the given SubterraURI.
      WikiPage[] getWikiPages​(java.lang.String projectId, java.lang.String spaceId)
      Returns Wiki Pages from a given Project and Space.
      WikiPage[] getWikiPagesWithFields​(java.lang.String projectId, java.lang.String spaceId, java.lang.String[] fields)
      Returns Wiki Pages from a given Project and Space.
      java.lang.String[] getWikiPageUris​(java.lang.String projectId, java.lang.String spaceId)
      Returns Wiki Pages from a given Project and Space.
      java.lang.String[] getWikiSpaces​(java.lang.String projectId)
      Returns Wiki spaces from a given Project.
      WorkItem getWorkItemById​(java.lang.String projectId, java.lang.String workitemId)
      Gets a Work Item with all fields set.
      WorkItem getWorkItemByIdsWithFields​(java.lang.String projectId, java.lang.String workitemId, java.lang.String[] keys)
      Gets a Work Item with only the fields specified filled in with values.
      WorkItem getWorkItemByUri​(java.lang.String uri)
      Gets a Work Item with all fields set.
      WorkItem getWorkItemByUriInRevision​(java.lang.String uri, java.lang.String revision)
      Gets a Work Item in the given revision with all fields set.
      WorkItem getWorkItemByUriInRevisionWithFields​(java.lang.String uri, java.lang.String revision, java.lang.String[] keys)
      Gets a Work Item in a given revision with only the fields specified filled in with values.
      WorkItem getWorkItemByUriWithFields​(java.lang.String uri, java.lang.String[] keys)
      Gets a Work Item with only the fields specified filled in with values.
      int getWorkItemsCount​(java.lang.String query)
      Counts the number of Work Items returned by the given query.
      WorkItem[] getWorkItemsLinkedToRevision​(java.lang.String revisionURI)
      Gets Work Items linked to a revision.
      WorkItem[] getWorkItemsLinkedToRevisionWithFields​(java.lang.String revisionURI, java.lang.String[] keys)
      Gets Work Items linked to a revision.
      boolean isHistoryAvailable()
      Returns true if the History is available.
      boolean isResolvedComment​(java.lang.String commentURI)
      Checks if the comment is in a resolved comments thread.
      ActivitySource[] listActivitySources()
      Returns all Activity Sources.
      Activity[] listAllActivities​(java.lang.String query, int count)
      Returns Activities within the default repository.
      java.lang.String[] listAllActivitiesGlobalIds​(java.lang.String query, int count)
      Returns the Activity global IDs within the default repository.
      Activity[] listGroupActivities​(java.lang.String uri, java.lang.String query, int count)
      Returns Activities within a given Project group.
      java.lang.String[] listGroupActivitiesGlobalIds​(java.lang.String uri, java.lang.String query, int count)
      Returns global IDs of activities within given project group.
      Activity[] listProjectActivities​(java.lang.String projectId, java.lang.String query, int count)
      Returns activities within the given Project.
      java.lang.String[] listProjectActivitiesGlobalIds​(java.lang.String projectId, java.lang.String query, int count)
      Returns the global IDs of Activities within the given Project.
      void moveWorkItemToDocument​(java.lang.String workItemURI, java.lang.String documentURI, java.lang.String parentWorkItemURI, int position, boolean retainDocumentFlow)
      Moves a Work Item to a specific position in a Document.
      void moveWorkItemToModule​(java.lang.String workItemURI, java.lang.String moduleURI, java.lang.String parentWorkItemURI, int position)
      void performWorkflowAction​(java.lang.String workitemURI, int actionId)
      Executes a workflow action.
      Baseline[] queryBaselines​(java.lang.String query, java.lang.String sort)
      Queries for Baselines.
      Module[] queryModules​(java.lang.String query, java.lang.String sort, java.lang.String[] fields, int resultsLimit)
      Searches for Modules/Documents.
      Module[] queryModulesBySQL​(java.lang.String sqlQuery, java.lang.String[] fields)
      Searches for Modules/Documents.
      Module[] queryModulesInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, java.lang.String[] fields, int resultsLimit)
      Searches for the Modules/Documents in a given Baseline.
      Module[] queryModulesInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision, java.lang.String[] fields)
      Searches for Modules/Documents in a given Baseline.
      java.lang.String[] queryModuleUris​(java.lang.String query, java.lang.String sort, int resultsLimit)
      Searches for Modules/Documents.
      java.lang.String[] queryModuleUrisBySQL​(java.lang.String sqlQuery)
      Searches for Modules/Documents.
      java.lang.String[] queryModuleUrisInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, int resultsLimit)
      Searches for Modules/Documents in a given Baseline.
      java.lang.String[] queryModuleUrisInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision)
      Searches for Modules/Documents in a given Baseline.
      Revision[] queryRevisions​(java.lang.String query, java.lang.String sort, java.lang.String[] fields)
      Queries for revisions.
      java.lang.String[] queryRevisionUris​(java.lang.String query, java.lang.String sort, boolean includeInternal)
      Queries for revisions.
      WikiPage[] queryWikiPages​(java.lang.String query, java.lang.String sort, java.lang.String[] fields, int resultsLimit)
      Searches for Wiki Pages.
      WikiPage[] queryWikiPagesBySQL​(java.lang.String sqlQuery, java.lang.String[] fields)
      Searches for Wiki Pages.
      WikiPage[] queryWikiPagesInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, java.lang.String[] fields, int resultsLimit)
      Searches for Wiki Pages in the given Baseline.
      WikiPage[] queryWikiPagesInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision, java.lang.String[] fields)
      Searches for Wiki Pages in the given Baseline.
      java.lang.String[] queryWikiPageUris​(java.lang.String query, java.lang.String sort, int resultsLimit)
      Searches for Wiki Pages.
      java.lang.String[] queryWikiPageUrisBySQL​(java.lang.String sqlQuery)
      Searches for Wiki Pages.
      java.lang.String[] queryWikiPageUrisInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, int resultsLimit)
      Searches for Wiki Pages in a given Baseline.
      java.lang.String[] queryWikiPageUrisInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision)
      Searches for Wiki Pages in the given Baseline.
      WorkItem[] queryWorkItems​(java.lang.String query, java.lang.String sort, java.lang.String[] fields)
      Queries for Work Items.
      WorkItem[] queryWorkItemsBySQL​(java.lang.String sqlQuery, java.lang.String[] fields)
      Queries for Work Items.
      WorkItem[] queryWorkItemsInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, java.lang.String[] fields)
      Queries for Work Items in a given Baseline.
      WorkItem[] queryWorkItemsInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision, java.lang.String[] fields)
      Searches for Work Items in a given Baseline revision.
      WorkItem[] queryWorkItemsInBaselineLimited​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, java.lang.String[] fields, int resultsLimit)
      Queries for Work Items in a Baseline with a given limit.
      WorkItem[] queryWorkItemsInRevision​(java.lang.String query, java.lang.String sort, java.lang.String revision, java.lang.String[] fields)
      Queries for Work Items.
      WorkItem[] queryWorkItemsInRevisionLimited​(java.lang.String query, java.lang.String sort, java.lang.String revision, java.lang.String[] fields, int resultsLimit)
      Queries for Work Items.
      WorkItem[] queryWorkItemsLimited​(java.lang.String query, java.lang.String sort, java.lang.String[] fields, int resultsLimit)
      Queries for Work Items.
      java.lang.String[] queryWorkItemUris​(java.lang.String query, java.lang.String sort)
      Query the URIs of a Work Item.
      java.lang.String[] queryWorkItemUrisBySQL​(java.lang.String sqlQuery)
      Query the URIs of Work Items.
      java.lang.String[] queryWorkItemUrisInBaseline​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision)
      Queries for Work Item URIs in a Baseline.
      java.lang.String[] queryWorkItemUrisInBaselineBySQL​(java.lang.String sqlQuery, java.lang.String baselineRevision)
      Searches for URIs of Work Items in the given Baseline revision.
      java.lang.String[] queryWorkItemUrisInBaselineLimited​(java.lang.String query, java.lang.String sort, java.lang.String baselineRevision, int resultsLimit)
      Queries for Work Item URIs in a baseline with a given limit.
      java.lang.String[] queryWorkItemUrisLimited​(java.lang.String query, java.lang.String sort, int resultsLimit)
      Query the URIs of a Work Item.
      void removeApprovee​(java.lang.String workitemURI, java.lang.String approveeId)
      Removes an approving user.
      boolean removeAssignee​(java.lang.String workitemURI, java.lang.String assigneeId)
      Removes an assignee.
      boolean removeCategory​(java.lang.String workitemURI, java.lang.String categoryId)
      Removes a Category.
      boolean removeExternalLinkedRevision​(java.lang.String workitemURI, java.lang.String repositoryName, java.lang.String revisionId)
      Removes a revision from an external repository.
      boolean removeExternallyLinkedItem​(java.lang.String workitemURI, java.lang.String linkedExternalWorkitemURI, EnumOptionId role)
      Removes an external linked item.
      boolean removeHyperlink​(java.lang.String workitemURI, java.lang.String url)
      Removes a hyperlink.
      boolean removeLinkedItem​(java.lang.String workitemURI, java.lang.String linkedItemURI, EnumOptionId role)
      Removes a linked item.
      boolean removeLinkedRevision​(java.lang.String workitemURI, java.lang.String revisionId)
      Removes a revision.
      boolean removePlaningConstraint​(java.lang.String workitemURI, java.util.Calendar date, EnumOptionId constraint)
      Removes a planing constraint.
      void resetWorkflow​(java.lang.String workflowObjectURI)
      Resets the workflow for the specified object.
      java.lang.String reuseDocument​(java.lang.String sourceURI, java.lang.String targetProjectId, java.lang.String targetLocation, java.lang.String targetName, java.lang.String targetTitle, boolean updateTitleInDocument, EnumOptionId linkRole, java.lang.String[] derivedFields)
      Creates a new Document based on an existing Document.
      java.lang.String reuseModule​(java.lang.String sourceURI, java.lang.String targetProjectId, java.lang.String targetLocation, java.lang.String targetName, EnumOptionId linkRole, java.lang.String[] fields, java.lang.String[] exceptFields, java.lang.String[] derivedFields)
      Creates new Module/Document based on the existing Module/Document.
      void setCommentTags​(java.lang.String commentURI, EnumOptionId[] tags)
      Sets the tags of a comment.
      void setCustomField​(CustomField customField)
      Sets a custom field of a Work Item.
      void setFieldsNull​(java.lang.String workitemURI, java.lang.String[] fields)
      Sets a field to null.
      void setLocalizedWorkItemDescription​(java.lang.String uri, java.lang.String language, Text description)
      Sets the localized description.
      void setLocalizedWorkItemTitle​(java.lang.String uri, java.lang.String language, java.lang.String title)
      Sets the localized title.
      void setResolvedComment​(java.lang.String commentURI, boolean resolved)
      Sets the state of the comment to "Resolved".
      void updateAttachment​(java.lang.String workitemURI, java.lang.String id, java.lang.String fileName, java.lang.String title, byte[] data)
      Update an existing attachment.
      void updateBaseline​(Baseline baseline)
      Updates the given Baseline.
      void updateDerivedDocument​(java.lang.String documentURI, java.lang.String revision, boolean autoSuspect)
      Updates derived Document to the new revision (Baseline).
      void updateDerivedModule​(java.lang.String moduleURI, java.lang.String revision)
      Updates derived the Module/Document to the new revision (Baseline).
      void updateModule​(Module module)
      Updates a Module/Document.
      java.lang.String updateTitleHeadingInDocument​(java.lang.String documentURI, java.lang.String title)
      Updates the first Title Heading in the Document's content.
      void updateWorkItem​(WorkItem content)
      Updates a Work Item.
    • Method Detail

      • addApprovee

        void addApprovee​(java.lang.String workitemURI,
                         java.lang.String approveeId)
                  throws java.rmi.RemoteException
        Adds an approvee.
        Parameters:
        workitemURI - The URI of the Work Item to add an approvee to.
        approveeId - The Id of the user to add as an approvee.
        Throws:
        java.rmi.RemoteException
      • addAssignee

        boolean addAssignee​(java.lang.String workitemURI,
                            java.lang.String assigneeId)
                     throws java.rmi.RemoteException
        Adds an assignee.
        Parameters:
        workitemURI - The URI of the Work Item to add the assignee to.
        assigneeId - the Id of the user to add as an assignee.
        Throws:
        java.rmi.RemoteException
      • addCategory

        boolean addCategory​(java.lang.String workitemURI,
                            java.lang.String categoryId)
                     throws java.rmi.RemoteException
        Adds a Category to a Work Item.
        Parameters:
        workitemURI - The URI of the Work Item to add the Category to.
        categoryId - The Id of the Category to add.
        Throws:
        java.rmi.RemoteException
      • addComment

        java.lang.String addComment​(java.lang.String parentObjectUri,
                                    java.lang.String title,
                                    Text content)
                             throws java.rmi.RemoteException
        Adds a comment to a Work Item, Document, Test Run or as a reply to an existing comment.
        Parameters:
        parentObjectUri - The URI of the parent object (not null).
        title - The title of the new comment or null.
        content - The content of the new comment or null.
        Throws:
        java.rmi.RemoteException - if the title is not null in a Document or reply comment, or if the parent URI is of an object that does not support comments.
        Since:
        3.10.2
      • addCommentToActivity

        void addCommentToActivity​(java.lang.String activityGlobalId,
                                  Text commentText)
                           throws java.rmi.RemoteException
        Adds a comment to the Activity.
        Parameters:
        activityGlobalId - The Activity's global Id (not null).
        commentText - The comment's text (not null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • addExternalLinkedRevision

        boolean addExternalLinkedRevision​(java.lang.String workitemURI,
                                          java.lang.String repositoryName,
                                          java.lang.String revisionId)
                                   throws java.rmi.RemoteException
        Links a revision from an external repository.
        Parameters:
        workitemURI - The URI of the Work Item to add the revision to.
        repositoryName - The Id of the external repository.
        revisionId - The Id of the revision to add.
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.1
      • addExternallyLinkedItem

        boolean addExternallyLinkedItem​(java.lang.String workitemURI,
                                        java.lang.String linkedExternalWorkitemURI,
                                        EnumOptionId role)
                                 throws java.rmi.RemoteException
        Adds an external linked Work Item.
        Parameters:
        workitemURI - The URI of the Work Item to add the link to.
        linkedExternalWorkitemURI - The URI of the target external Work Item the link points to.
        role - The role of the link to add.
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.0
      • addHyperlink

        boolean addHyperlink​(java.lang.String workitemURI,
                             java.lang.String url,
                             EnumOptionId role)
                      throws java.rmi.RemoteException
        Adds a hyperlink.
        Parameters:
        workitemURI - The URI of the Work Item to add the hyperlink to.
        url - The url of the hyperlink to add.
        role - The role of the hyperlink to add.
        Throws:
        java.rmi.RemoteException
      • addLinkedItem

        boolean addLinkedItem​(java.lang.String workitemURI,
                              java.lang.String linkedWorkitemURI,
                              EnumOptionId role)
                       throws java.rmi.RemoteException
        Adds a linked Work Item.
        Parameters:
        workitemURI - The URI of the Work Item to add the link to.
        linkedWorkitemURI - The URI of the target Work Item the link points to.
        role - The role of the link to add.
        Throws:
        java.rmi.RemoteException
      • addLinkedItemWithRev

        boolean addLinkedItemWithRev​(java.lang.String in0,
                                     java.lang.String in1,
                                     EnumOptionId in2,
                                     java.lang.String in3,
                                     boolean in4)
                              throws java.rmi.RemoteException
        Adds a linked item to the specific Work Item with a revision.
        Parameters:
        in0 - workitemURI The URI of the Work Item to add the link to.
        in1 - linkedWorkitemURI The URI of the target Work Item the link points to.
        in2 - role The role of the linked item to add.
        in3 - revision specific The revision for a linked item (null refers to the HEAD revision).
        in4 - suspect true if the link should be marked with a suspect flag.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.3
      • addLinkedOslcItem

        boolean addLinkedOslcItem​(java.lang.String workitemURI,
                                  java.lang.String linkedOslcItemURI,
                                  EnumOptionId role,
                                  java.lang.String label)
                           throws java.rmi.RemoteException
        Adds an OSLC item.
        Parameters:
        workitemURI - The URI of the Work Item to add the link to.
        linkedOslcItemURI - The URI of the target resource the link points to.
        role - The role of the link to add.
        label - The label of the link to add.
        Throws:
        java.rmi.RemoteException
        Since:
        3.10.2
      • addLinkedRevision

        boolean addLinkedRevision​(java.lang.String workitemURI,
                                  java.lang.String revisionId)
                           throws java.rmi.RemoteException
        Links a revision.
        Parameters:
        workitemURI - The URI of the Work Item to add the revision to.
        revisionId - The Id of the revision to add.
        Throws:
        java.rmi.RemoteException
      • addPlaningContraint

        boolean addPlaningContraint​(java.lang.String workitemURI,
                                    java.util.Calendar date,
                                    EnumOptionId constraint)
                             throws java.rmi.RemoteException
        Adds a planing constraint.
        Parameters:
        workitemURI - The URI of the Work Item to add the planning constraint to.
        date - The date of the planning constraint to add.
        constraint - The type of constraint to add.
        Throws:
        java.rmi.RemoteException
      • canCommentActivity

        boolean canCommentActivity​(java.lang.String activityGlobalId)
                            throws java.rmi.RemoteException
        Returns true if the Activity allows for comments.
        Parameters:
        activityGlobalId - The Activity's global Id (not null).
        Returns:
        true if Activity allows for comments. Otherwise false.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • canCurrentUserAddCommentToActivity

        boolean canCurrentUserAddCommentToActivity​(java.lang.String activityGlobalId)
                                            throws java.rmi.RemoteException
        Returns true if the current User can comment on the Activity.
        Parameters:
        activityGlobalId - The Activity's global Id (not null).
        Returns:
        true if the current user can comment on the Activity. Otherwise false.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • createAttachment

        void createAttachment​(java.lang.String workitemURI,
                              java.lang.String fileName,
                              java.lang.String title,
                              byte[] data)
                       throws java.rmi.RemoteException
        Creates a new attachment.
        Parameters:
        workitemURI - The URI of the Work Item to add the attachment to.
        fileName - The fileName of the attachment.
        title - The title of the attachment.
        data - The content of the attachment.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.1
      • createBaseline

        Baseline createBaseline​(java.lang.String projectId,
                                java.lang.String name,
                                java.lang.String description,
                                java.lang.String revision)
                         throws java.rmi.RemoteException
        Creates a Baseline from the head or particular revision.
        Parameters:
        projectId - The Project Id (not null).
        name - the Baseline's name (not null).
        description - The Baseline's description (can be null).
        revision - The revision or a null value for the Head revision.
        Returns:
        The Created Baseline.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • createComment

        void createComment​(java.lang.String workitemURI,
                           Text content)
                    throws java.rmi.RemoteException
        Creates a comment.
        Parameters:
        workitemURI - The URI of the Work Item to create a comment for.
        content - The content of the comment to create.
        Throws:
        java.rmi.RemoteException
      • createCommentNew

        java.lang.String createCommentNew​(java.lang.String parentURI,
                                          java.lang.String title,
                                          Text content,
                                          java.lang.String[] visibleTo)
                                   throws java.rmi.RemoteException
        Creates a comment.
        Parameters:
        parentURI - The URI of the parent item (either a Work Item or another comment) to create the comment for.
        title - The title of the comment.
        content - The content of the comment to create.
        visibleTo - Who this comment should be visible to.
        Throws:
        java.rmi.RemoteException
        Since:
        3.1.2
      • createDocument

        java.lang.String createDocument​(java.lang.String projectId,
                                        java.lang.String location,
                                        java.lang.String documentName,
                                        java.lang.String documentTitle,
                                        EnumOptionId[] allowedWITypes,
                                        EnumOptionId structureLinkRole,
                                        java.lang.String homePageContent)
                                 throws java.rmi.RemoteException
        Creates a Document in the given location with the given parameters.
        Parameters:
        projectId - The Project Id (not null)
        location - The document's Space location with one component or null for the default space. (Can be null.)
        documentName - The Document's name (not null).
        documentTitle - The Document's title (can be null).
        allowedWITypes - A single Type can be specified. (Can be null.)
        structureLinkRole - The role that defines the hierarchy of the Work Items inside the Document. (Not null.)
        homePageContent - The HTML markup for a document home page. (Can be null).
        Returns:
        The URI of the created Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.2
      • createDocumentComment

        java.lang.String createDocumentComment​(java.lang.String documentURI,
                                               Text text)
                                        throws java.rmi.RemoteException
        Creates an unreferenced comment in the Document.
        Parameters:
        documentURI - The Document SubterraURI.
        text - The comment's text.
        Returns:
        The SubterraURI of the newly created comment
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • createDocumentCommentReferringWI

        java.lang.String createDocumentCommentReferringWI​(java.lang.String documentURI,
                                                          java.lang.String workItemURI,
                                                          Text text)
                                                   throws java.rmi.RemoteException
        Creates a comment referring to a Work Item in the Document.
        Parameters:
        documentURI - The document SubterraURI.
        workItemURI - The Work Item SubterraURI.
        text - The comment's text.
        Returns:
        The SubterraURI of the newly created comment.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • createDocumentCommentReply

        java.lang.String createDocumentCommentReply​(java.lang.String parentURI,
                                                    Text text)
                                             throws java.rmi.RemoteException
        Creates a comment as a reply to a given parent Comment in the Document.
        Parameters:
        parentURI - The parent comment SubterraURI.
        text - The comment's text.
        Returns:
        The SubterraURI of the newly created comment.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • createFolder

        Folder createFolder​(java.lang.String projectId,
                            java.lang.String parentName,
                            java.lang.String name,
                            java.lang.String title)
                     throws java.rmi.RemoteException
        Creates and returns a sub folder for parentName folder, if it is not null, otherwise it creates a new folder under the "Documents & Pages" root Topic.
        Parameters:
        projectId - The project ID or null for the Global level.
        parentName - (ID) must be unique for the whole folder hierarchy.
        name - (ID) must be unique for the whole folder hierarchy.
        title - The title for the folder.
        Throws:
        java.rmi.RemoteException
        Since:
        3.18.1
      • createModule

        java.lang.String createModule​(java.lang.String projectId,
                                      java.lang.String location,
                                      java.lang.String moduleName,
                                      EnumOptionId[] allowedWITypes,
                                      EnumOptionId structureLinkRole,
                                      boolean parentToChild,
                                      java.lang.String homePageContent)
                               throws java.rmi.RemoteException
        Creates a document or an old-style Module/Document in a given location with the given parameters.
        Parameters:
        projectId - the Project Id.
        location - The document Space location with a single component (e.g. "_default" for the default space) or null for old-style Modules.
        moduleName - The Document/Module name.
        allowedWITypes - The allowed Work Item Types. Only one type can be specified.
        structureLinkRole - The required, role that defines the hierarchy of Work Items inside the Module/Document.
        parentToChild - Always false.
        homePageContent - The HTML markup for a document home page or Wiki markup for the old-style Module home page or null if the default is OK.
        Returns:
        The URI of the created Module/Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • createWorkItem

        java.lang.String createWorkItem​(WorkItem content)
                                 throws java.rmi.RemoteException
        Creates a new Work Item with the given content. The Project and the Type must be set or the Work Item will not be created. The URI MUST NOT be set, otherwise the creation will fail. To create a Work Item in a specific location e.g. a LiveDoc, set the location of the Work Item to the desired target location. To create a Work Item in a specific Module/Document, set the Module/Document of the Work Item to the desired target Module/Document.
        Parameters:
        content - The content of the Work Item to be created.
        Throws:
        java.rmi.RemoteException
      • createWorkItemInModule

        java.lang.String createWorkItemInModule​(java.lang.String moduleURI,
                                                java.lang.String parentWorkItemURI,
                                                WorkItem workItem)
                                         throws java.rmi.RemoteException
        Creates a Work Item at a specified position inside the Module/Document.
        Parameters:
        moduleURI - The Module/Document URI.
        parentWorkItemURI - The URI of the parent Work Item or null.
        workItem - The content of the Work Item to be created.
        Returns:
        The URI of the created Work Item.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • createWorkRecord

        void createWorkRecord​(java.lang.String workitemURI,
                              User user,
                              java.util.Date date,
                              java.lang.String timeSpent)
                       throws java.rmi.RemoteException
        Creates a Work Record.
        Parameters:
        workitemURI - The URI of the Work Item to create a Work Record for.
        user - The user for the Work Record.
        date - The date of the Work Record.
        timeSpent - The time spent for the Work Record.
        Throws:
        java.rmi.RemoteException
      • createWorkRecordWithTypeAndComment

        void createWorkRecordWithTypeAndComment​(java.lang.String workitemURI,
                                                User user,
                                                java.util.Date date,
                                                EnumOptionId type,
                                                java.lang.String timeSpent,
                                                java.lang.String comment)
                                         throws java.rmi.RemoteException
        Creates a Work Record.
        Parameters:
        workitemURI - The URI of the Work Item to create a Work Record for.
        user - The user for the Work Record.
        date - The date of the Work Record.
        type - The Work Record Type.
        timeSpent - The time spent on the Work Record.
        comment - The Work Record comment.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • deleteAttachment

        void deleteAttachment​(java.lang.String workitemURI,
                              java.lang.String id)
                       throws java.rmi.RemoteException
        Remove an attachment.
        Parameters:
        workitemURI - The URI of the Work Item containing the attachment to be removed.
        id - The Id of the attachment to be removed.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.1
      • deleteBaseline

        void deleteBaseline​(java.lang.String baselineURI)
                     throws java.rmi.RemoteException
        Deletes the given Baseline.
        Parameters:
        baselineURI - The Baseline SubterraURI (not null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • deleteModule

        void deleteModule​(java.lang.String moduleURI)
                   throws java.rmi.RemoteException
        Deletes a Module/Document.
        Parameters:
        moduleURI - The URI of the Module/Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • deleteWorkRecord

        void deleteWorkRecord​(java.lang.String workitemURI,
                              java.lang.String workRecordURI)
                       throws java.rmi.RemoteException
        Deletes a Work Record.
        Parameters:
        workitemURI - The URI of the Work Item to remove the work record from.
        workRecordURI - The URI of the Work Record to remove.
        Throws:
        java.rmi.RemoteException
      • doAutoSuspect

        void doAutoSuspect​(java.lang.String workitemURI)
                    throws java.rmi.RemoteException
        Triggers auto suspect.
        Parameters:
        workitemURI - The URI of the work item to trigger auto suspect for.
        Throws:
        java.rmi.RemoteException
      • doAutoassign

        void doAutoassign​(java.lang.String workitemURI)
                   throws java.rmi.RemoteException
        Triggers autoassignement.
        Parameters:
        workitemURI - The URI of the Work Item to trigger autoassignement for.
        Throws:
        java.rmi.RemoteException
      • editApproval

        void editApproval​(java.lang.String workitemURI,
                          java.lang.String approveeId,
                          EnumOptionId status)
                   throws java.rmi.RemoteException
        Changes the status of an approval.
        Parameters:
        workitemURI - The URI of the Work Item to execute the action for.
        approveeId - The Id of the approvee.
        status - The new status to set.
        Throws:
        java.rmi.RemoteException
      • generateHistory

        Change[] generateHistory​(java.lang.String workitemURI,
                                 java.lang.String[] ignoredFields,
                                 java.lang.String[] fieldOrder)
                          throws java.rmi.RemoteException
        Gets the Work Item's history.
        Parameters:
        workitemURI - The URI of the Work Item to get the history for.
        ignoredFields - The fields that will be ignored (can be null).
        fieldOrder - The order of fields (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getActivityByGlobalId

        Activity getActivityByGlobalId​(java.lang.String activityGlobalId)
                                throws java.rmi.RemoteException
        Returns the Activity with the given global Id.
        Parameters:
        activityGlobalId - The Activity's global Id.
        Returns:
        The Activity.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • getAllEnumOptionIdsForId

        EnumOptionId[] getAllEnumOptionIdsForId​(java.lang.String projectID,
                                                java.lang.String enumId)
                                         throws java.rmi.RemoteException
        Gets all enumeration option IDs.
        Parameters:
        projectID - The ID of the Project to get the options for.
        enumId - The Id of the enumeration to get the options for.
        Throws:
        java.rmi.RemoteException
      • getAllEnumOptionIdsForKey

        EnumOptionId[] getAllEnumOptionIdsForKey​(java.lang.String projectID,
                                                 java.lang.String key)
                                          throws java.rmi.RemoteException
        Gets all enumeration option IDs.
        Parameters:
        projectID - The Id of the Project to get the options for.
        key - The key of the field containing the enumeration to get the option Id for.
        Throws:
        java.rmi.RemoteException
      • getAllEnumOptionsForId

        EnumOption[] getAllEnumOptionsForId​(java.lang.String projectID,
                                            java.lang.String enumID)
                                     throws java.rmi.RemoteException
        Gets all enumeration options.
        Parameters:
        projectID - The Id of the Project to get the options for.
        enumID - The Id of the enumeration to get the options for.
        Throws:
        java.rmi.RemoteException
      • getAllEnumOptionsForKey

        EnumOption[] getAllEnumOptionsForKey​(java.lang.String projectID,
                                             java.lang.String key)
                                      throws java.rmi.RemoteException
        Gets all enumeration options.
        Parameters:
        projectID - The Id of the Project to get the options for.
        key - The key of the field containing the enumeration to get the options for.
        Throws:
        java.rmi.RemoteException
      • getAllowedApprovers

        User[] getAllowedApprovers​(java.lang.String workitemURI)
                            throws java.rmi.RemoteException
        Gets all allowed approvers.
        Parameters:
        workitemURI - The URI of the Work Item to get the allowed approvers for.
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.3
      • getAllowedAssignees

        User[] getAllowedAssignees​(java.lang.String workitemURI)
                            throws java.rmi.RemoteException
        Gets all allowed assignees.
        Parameters:
        workitemURI - The URI of the Work Item to get the allowed assignees for.
        Throws:
        java.rmi.RemoteException
      • getAvailableActions

        WorkflowAction[] getAvailableActions​(java.lang.String workitemURI)
                                      throws java.rmi.RemoteException
        Gets the actions that can be used on the workflow object in its current state. The conditions of the action are checked and those with failed condition(s) are not returned. NOTE: The parameter name workitemURI is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.
        Parameters:
        workitemURI - The URI of the WorkflowObject to get the available actions from. (Should not be null.)
        Returns:
        The available actions.
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
        java.rmi.RemoteException
        See Also:
        performWorkflowAction(java.lang.String, int), getUnavailableActions(java.lang.String)
      • getAvailableEnumOptionIdsForId

        EnumOptionId[] getAvailableEnumOptionIdsForId​(java.lang.String workitemURI,
                                                      java.lang.String enumID)
                                               throws java.rmi.RemoteException
        Gets the available enumeration option IDs.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration option IDs for.
        enumID - The Id of the enumeration to get the option IDs for.
        Throws:
        java.rmi.RemoteException
      • getAvailableEnumOptionIdsForKey

        EnumOptionId[] getAvailableEnumOptionIdsForKey​(java.lang.String workitemURI,
                                                       java.lang.String key)
                                                throws java.rmi.RemoteException
        Gets the available enumeration option IDs.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration option IDs for.
        key - The Id of the enumeration to get the available option IDs for.
        Throws:
        java.rmi.RemoteException
      • getBackLinkedWorkitems

        LinkedWorkItem[] getBackLinkedWorkitems​(java.lang.String workitemURI)
                                         throws java.rmi.RemoteException
        Gets the back linked Work Items. (Work Items linking to the specified Work Item.)
        Parameters:
        workitemURI - The URI of the Work Item to get the back links for.
        Throws:
        java.rmi.RemoteException
      • getCategories

        Category[] getCategories​(java.lang.String projectId)
                          throws java.rmi.RemoteException
        Get the categories defined for the give project id.
        Throws:
        java.rmi.RemoteException
      • getChildFolders

        Folder[] getChildFolders​(java.lang.String projectId,
                                 java.lang.String parentFolderId)
                          throws java.rmi.RemoteException
        Returns list of folders contained in this folder.
        Parameters:
        projectId - The project ID or null for the Global level.
        parentFolderId - The parent folder name (ID).
        Returns:
        An array of child folders from this parent folder.
        Throws:
        java.rmi.RemoteException
        Since:
        3.18.1
      • getCustomField

        CustomField getCustomField​(java.lang.String workitemURI,
                                   java.lang.String key)
                            throws java.rmi.RemoteException
        Gets a Work Item's custom field.
        Parameters:
        workitemURI - The URI of the Work Item to get the custom field from.
        key - The custom field's key.
        Throws:
        java.rmi.RemoteException
      • getCustomFieldKeys

        java.lang.String[] getCustomFieldKeys​(java.lang.String workitemURI)
                                       throws java.rmi.RemoteException
        Gets the names of defined custom fields.
        Parameters:
        workitemURI - the URI of the work item to get the defined custom fields for.
        Throws:
        java.rmi.RemoteException
      • getCustomFieldType

        CustomFieldType getCustomFieldType​(java.lang.String workitemURI,
                                           java.lang.String key)
                                    throws java.rmi.RemoteException
        Gets the custom field definitions for a specific Work Item.
        Parameters:
        workitemURI - The URI of the Work Item.
        key - The key of the custom field.
        Throws:
        java.rmi.RemoteException
      • getCustomFieldTypes

        CustomFieldType[] getCustomFieldTypes​(java.lang.String workitemURI)
                                       throws java.rmi.RemoteException
        Gets all custom field definitions for a specific Work Item.
        Parameters:
        workitemURI - The URI of the Work Item.
        Throws:
        java.rmi.RemoteException
      • getDefaultLanguageDefinition

        LanguageDefinition getDefaultLanguageDefinition​(java.lang.String projectId)
                                                 throws java.rmi.RemoteException
        Returns the language definition for the default language. (Primarily to provide its label).
        Parameters:
        projectId - The Project Id (not null).
        Returns:
        The language definition or null if one is not defined.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getDefinedCustomFieldKeys

        java.lang.String[] getDefinedCustomFieldKeys​(java.lang.String projectID,
                                                     java.lang.String typeID)
                                              throws java.rmi.RemoteException
        Gets all custom field keys defined for a Work Item Type in a Project.
        Parameters:
        projectID - The Id of the Project.
        typeID - The Work Item Type Id.
        Throws:
        java.rmi.RemoteException
      • getDefinedCustomFieldType

        CustomFieldType getDefinedCustomFieldType​(java.lang.String projectID,
                                                  java.lang.String typeID,
                                                  java.lang.String key)
                                           throws java.rmi.RemoteException
        Gets a custom field definition for a Work Item Type.
        Parameters:
        projectID - The Id of the Project.
        typeID - The Work Item Type Id.
        key - key of the custom field.
        Throws:
        java.rmi.RemoteException
      • getDefinedCustomFieldTypes

        CustomFieldType[] getDefinedCustomFieldTypes​(java.lang.String projectID,
                                                     java.lang.String typeID)
                                              throws java.rmi.RemoteException
        Gets all custom field definitions for a Work Item Type.
        Parameters:
        projectID - The Id of the Project.
        typeID - The Work Item Type Id.
        Throws:
        java.rmi.RemoteException
      • getDocumentLocations

        java.lang.String[] getDocumentLocations​(java.lang.String projectId)
                                         throws java.rmi.RemoteException
        Gets the document locations (e.g. LiveDocuments) for a Project.
        Parameters:
        projectId - The Id of the Projects to get the document locations for.
        Throws:
        java.rmi.RemoteException
      • getDocumentSpaces

        java.lang.String[] getDocumentSpaces​(java.lang.String projectId)
                                      throws java.rmi.RemoteException
        Returns Module/Document Spaces from given Project.
        Parameters:
        projectId - The Project Id (not null).
        Returns:
        An array of Space IDs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getDurationHours

        float getDurationHours​(java.lang.String duration)
                        throws java.rmi.RemoteException
        Gets duration time in hours
        Parameters:
        duration - The string representation of the duration time.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getEnumControlKeyForId

        java.lang.String getEnumControlKeyForId​(java.lang.String projectID,
                                                java.lang.String enumID)
                                         throws java.rmi.RemoteException
        Gets the enumeration control key for the specified Work Item key.
        Parameters:
        projectID - The Id of the Project.
        enumID - The Id of the enumeration to get the control key for.
        Throws:
        java.rmi.RemoteException
      • getEnumControlKeyForKey

        java.lang.String getEnumControlKeyForKey​(java.lang.String projectID,
                                                 java.lang.String key)
                                          throws java.rmi.RemoteException
        Gets the enumeration control key for the specified Work Item key.
        Parameters:
        projectID - The Id of the Project.
        key - The key of the field containing the enumeration to get the control key for.
        Throws:
        java.rmi.RemoteException
      • getEnumOptionFromObjectUriForId

        EnumOption getEnumOptionFromObjectUriForId​(java.lang.String uri,
                                                   java.lang.String enumId)
                                            throws java.rmi.RemoteException
        Returns an instance of the IEnumOption of a given object URI and the enumeration Id.
        Parameters:
        uri - The SubterraURI (not null).
        enumId - The Id of the enumeration.
        Returns:
        An instance of IEnumOption (not null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getEnumOptionFromObjectUriForKey

        EnumOption getEnumOptionFromObjectUriForKey​(java.lang.String uri,
                                                    java.lang.String prototypeName,
                                                    java.lang.String key)
                                             throws java.rmi.RemoteException
        Returns an instance of the IEnumOption of a given object URI, the Prototype name and the prototype object's key.
        Parameters:
        uri - The SubterraURI (not null)
        prototypeName - The Prototype name.
        key - The key of the given prototype object.
        Returns:
        The instance of the IEnumOption (not null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getEnumOptionWithEnumId

        EnumOption getEnumOptionWithEnumId​(java.lang.String workitemURI,
                                           java.lang.String enumID,
                                           EnumOptionId id)
                                    throws java.rmi.RemoteException
        Gets an enumeration option.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration option for.
        enumID - The Id of the enumeration.
        id - The enumeration option Id.
        Throws:
        java.rmi.RemoteException
      • getEnumOptionWithKey

        EnumOption getEnumOptionWithKey​(java.lang.String workitemURI,
                                        java.lang.String key,
                                        EnumOptionId id)
                                 throws java.rmi.RemoteException
        Gets an enumeration option.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration option for.
        key - The key of the field containing the enumeration option value.
        id - The enumeration option Id.
        Throws:
        java.rmi.RemoteException
      • getEnumOptionsForId

        EnumOption[] getEnumOptionsForId​(java.lang.String workitemURI,
                                         java.lang.String enumID)
                                  throws java.rmi.RemoteException
        Gets the available enumeration options.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration options for.
        enumID - The id of the enumeration to get the options for.
        Throws:
        java.rmi.RemoteException
      • getEnumOptionsForIdWithControl

        EnumOption[] getEnumOptionsForIdWithControl​(java.lang.String projectID,
                                                    java.lang.String enumID,
                                                    java.lang.String controlValue)
                                             throws java.rmi.RemoteException
        Gets the available enumeration options. The control value is the string representation of the Work Item value at the field specified by the enumerations control key.
        Parameters:
        projectID - The Id of the Project to get the options for.
        enumID - The Id of the enumeration to get the options for.
        controlValue - The string representation of the control value.
        Throws:
        java.rmi.RemoteException
        See Also:
        getEnumControlKeyForKey(java.lang.String, java.lang.String), getEnumControlKeyForId(java.lang.String, java.lang.String)
      • getEnumOptionsForKey

        EnumOption[] getEnumOptionsForKey​(java.lang.String workitemURI,
                                          java.lang.String key)
                                   throws java.rmi.RemoteException
        Gets the available enumeration options.
        Parameters:
        workitemURI - The URI of the Work Item to get the enumeration options for.
        key - The key of the field containing the enumeration to get the options for.
        Throws:
        java.rmi.RemoteException
      • getEnumOptionsForKeyWithControl

        EnumOption[] getEnumOptionsForKeyWithControl​(java.lang.String projectID,
                                                     java.lang.String key,
                                                     java.lang.String controlValue)
                                              throws java.rmi.RemoteException
        Gets the available enumeration options. The control value is the string representation of the Work Item value on the field specified by the enumerations control key.
        Parameters:
        projectID - The Id of the Project to get the options for.
        key - The key of the field containing the enumeration to get the options for.
        controlValue - The string representation of the control value.
        Throws:
        java.rmi.RemoteException
        See Also:
        getEnumControlKeyForKey(java.lang.String, java.lang.String), getEnumControlKeyForId(java.lang.String, java.lang.String)
      • getFilteredEnumOptionsForKey

        EnumOption[] getFilteredEnumOptionsForKey​(java.lang.String uri,
                                                  java.lang.String key,
                                                  java.lang.String filter)
                                           throws java.rmi.RemoteException
        Gets the available, filtered enumeration options.
        Parameters:
        uri - The URI of the peristent object to get the enumeration options for (not null).
        key - The key of the field containing the enumeration to get the options for (not null).
        filter - The Id of the enumeration option to use as the "from" value for the dependency mapping. (Can be null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.1
      • getFolder

        Folder getFolder​(java.lang.String projectId,
                         java.lang.String folderName)
                  throws java.rmi.RemoteException
        Returns a folder specified by the Project and Folder name.
        Parameters:
        projectId - The Project Id or null for the Global level.
        folderName - The name of the folder. (Not null.)
        Returns:
        The folder from the given Project or on the Global level.(Not null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.3
      • getFolderForURI

        Folder getFolderForURI​(java.lang.String objectURI)
                        throws java.rmi.RemoteException
        Returns the folder that the specified object is contained in. The object must implement the IFolderItem interface (e.g. Module). Otherwise returns null.
        Parameters:
        objectURI - The URI of the object. (Not null.)
        Returns:
        Folder for specified object. (Can be null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.3
      • getFolders

        Folder[] getFolders​(java.lang.String projectId)
                     throws java.rmi.RemoteException
        Returns folders from the given Project or on the Global level.
        Parameters:
        projectId - The project Id or null for the Global level.
        Returns:
        An array of folders contained within the given Project or on the Global level.
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.3
      • getInitialWorkflowAction

        WorkflowAction getInitialWorkflowAction​(java.lang.String workitemURI)
                                         throws java.rmi.RemoteException
        Gets the initial workflow action for the specified object and returns null if there is no initial action for the corresponding workflow. NOTE: The parameter name workitemURI is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.
        Parameters:
        workitemURI - The URI of the WorkflowObject to get the available actions from. (Should not be null.)
        Returns:
        The initial workflow action, null if no action is configured.
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
        java.rmi.RemoteException
        Since:
        3.4.3
        See Also:
        resetWorkflow(java.lang.String)
      • getInitialWorkflowActionForProjectAndType

        WorkflowAction getInitialWorkflowActionForProjectAndType​(java.lang.String projectId,
                                                                 EnumOptionId wiType)
                                                          throws java.rmi.RemoteException
        Gets the initial workflow action for a specific Work Item Type in the specific Project.
        Parameters:
        projectId - The Id of the Project to get the Work Item from.
        wiType - The Work Item Type to get the available actions from. (Should not be null.)
        Returns:
        The initial workflow action, null if no initial action is configured.
        Throws:
        java.lang.IllegalArgumentException - if wiType is null
        java.rmi.RemoteException
        Since:
        3.6.1
        See Also:
        getInitialWorkflowAction(java.lang.String)
      • getLanguageDefinition

        LanguageDefinition getLanguageDefinition​(java.lang.String projectId,
                                                 java.lang.String language)
                                          throws java.rmi.RemoteException
        Returns the language definition for a given language.
        Parameters:
        projectId - The Project Id (not null).
        language - The language Id (not null).
        Returns:
        The language definition or null if one is not defined.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getLanguageDefinitions

        LanguageDefinition[] getLanguageDefinitions​(java.lang.String projectId)
                                             throws java.rmi.RemoteException
        Returns all language definitions. (Does not include the default language definition).
        Parameters:
        projectId - The Project Id (not null).
        Returns:
        All language definitions.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getLinkedResources

        LinkedResource[] getLinkedResources​(java.lang.String workitemURI)
                                     throws java.rmi.RemoteException
        Returns a set of resources linked to the Work Item.
        Parameters:
        workitemURI - The URI of the Work Item to get linked resources from.
        Returns:
        An array of Linked Resources for the specified Work Item.
        Throws:
        java.rmi.RemoteException
        Since:
        3.17.0
      • getLocalizedWorkItemDescription

        Text getLocalizedWorkItemDescription​(java.lang.String uri,
                                             java.lang.String language)
                                      throws java.rmi.RemoteException
        Returns the localized description or the normal description if the localized one is not defined or is empty.
        Parameters:
        uri - The Work Item URI (not null).
        language - The language Id or null for the default language.
        Returns:
        The localized description (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getLocalizedWorkItemDescriptionField

        java.lang.String getLocalizedWorkItemDescriptionField​(java.lang.String projectId,
                                                              java.lang.String language,
                                                              EnumOptionId type)
                                                       throws java.rmi.RemoteException
        Returns the Id of the field of a Work Item of a given Type that stores the localized description.
        Parameters:
        projectId - The Project Id (not null).
        language - The language Id (not null).
        type - The Work Item Type (not null).
        Returns:
        The Id of the field or null if it is not defined.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getLocalizedWorkItemTitle

        java.lang.String getLocalizedWorkItemTitle​(java.lang.String uri,
                                                   java.lang.String language)
                                            throws java.rmi.RemoteException
        Returns the localized title or normal title if the localized one is not defined or is empty.
        Parameters:
        uri - The Work Item URI (not null).
        language - The language Id or null for the default language.
        Returns:
        The localized title (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getLocalizedWorkItemTitleField

        java.lang.String getLocalizedWorkItemTitleField​(java.lang.String projectId,
                                                        java.lang.String language,
                                                        EnumOptionId type)
                                                 throws java.rmi.RemoteException
        Returns the Id of the field of a Work Item of a given Type that stores the localized title.
        Parameters:
        projectId - The Project Id (not null).
        language - The language Id (not null).
        type - The Work Item Type (not null).
        Returns:
        The Id of the field or null if one is not defined.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • getModuleByLocation

        Module getModuleByLocation​(java.lang.String projectId,
                                   java.lang.String location)
                            throws java.rmi.RemoteException
        Retrieves the Module/Document on the given location.
        Parameters:
        projectId - The Project Id.
        location - The encoded location of a retrieved Module/Document, relative to the Module/Document root in the given Project. Use the location with a revision set to retrieve a particular revision of the Module/Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModuleByLocationWithFields

        Module getModuleByLocationWithFields​(java.lang.String projectId,
                                             java.lang.String location,
                                             java.lang.String[] fields)
                                      throws java.rmi.RemoteException
        Retrieves the Module/Document on the given location with the given fields set.
        Parameters:
        projectId - The Project Id.
        location - The encoded location of retrieved Module/Document, relative to Module/Document root in the given project. Use the location with a revision set to retrieve a particular revision of the Module/Document.
        fields - The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModuleByUri

        Module getModuleByUri​(java.lang.String uri)
                       throws java.rmi.RemoteException
        Gets Module/Document with all fields filled.
        Parameters:
        uri - Module/Document URI
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModuleByUriWithFields

        Module getModuleByUriWithFields​(java.lang.String uri,
                                        java.lang.String[] fields)
                                 throws java.rmi.RemoteException
        Gets a Module/Document with given fields filled in.
        Parameters:
        uri - Module/Document URI
        fields - The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModuleUris

        java.lang.String[] getModuleUris​(java.lang.String projectId,
                                         java.lang.String location)
                                  throws java.rmi.RemoteException
        Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
        Parameters:
        projectId - The Project Id (not null).
        location - The serialized location relative to the "modules" folder.
        Returns:
        An array of Modules/Documents SubterraURIs. (One Module/Document SubterraURI if the location is the location of the Module/Document; can be null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getModuleWorkItemUris

        java.lang.String[] getModuleWorkItemUris​(java.lang.String moduleURI,
                                                 java.lang.String parentWorkItemURI,
                                                 boolean deep)
                                          throws java.rmi.RemoteException
        Returns the URIs of Work Items contained in a given Module/Document under given parent (if specified).
        Parameters:
        moduleURI - The Module/Document URI.
        parentWorkItemURI - The URI of the parent Work Item or null.
        deep - true to return Work Items from the whole subtree.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModuleWorkItems

        WorkItem[] getModuleWorkItems​(java.lang.String moduleURI,
                                      java.lang.String parentWorkItemURI,
                                      boolean deep,
                                      java.lang.String[] fields)
                               throws java.rmi.RemoteException
        Returns Work Items (with given fields set) contained in a given Module/Document under the given parent (if specified).
        Parameters:
        moduleURI - The Module/Document URI.
        parentWorkItemURI - The URI of parent Work Item or null.
        deep - true to return Work Items from the whole subtree.
        fields - The fields to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • getModules

        Module[] getModules​(java.lang.String projectId,
                            java.lang.String location)
                     throws java.rmi.RemoteException
        Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
        Parameters:
        projectId - The Project Id (not null).
        location - The serialized location relative to the "modules" folder.
        Returns:
        An array of Modules/Documents. (One Module/Document if the location is the location of the Module/Document; can be null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getModulesSubFolders

        java.lang.String[] getModulesSubFolders​(java.lang.String projectId,
                                                java.lang.String location)
                                         throws java.rmi.RemoteException
        Returns the sub-folders of a given location relative to the "modules" folder of the given Project.
        Parameters:
        projectId - The Project Id (not null).
        location - The serialized location relative to the "modules" folder.
        Returns:
        An array of serialized locations (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getModulesWithFields

        Module[] getModulesWithFields​(java.lang.String projectId,
                                      java.lang.String location,
                                      java.lang.String[] fields)
                               throws java.rmi.RemoteException
        Returns the Modules/Documents residing on the given location relative to the "modules" folder of the given project.
        Parameters:
        projectId - The Project Id (not null).
        location - The serialized location relative to the "modules" folder.
        fields - An array of field names to fill in the returned Modules/Documents (can be null). For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Returns:
        An array of Modules/Documents. (One Module/Document if the location is the location of the Module/Document; can be null.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getOneDayLength

        long getOneDayLength()
                      throws java.rmi.RemoteException
        Gets the length of one day
        Throws:
        java.rmi.RemoteException
        Since:
        3.2.3
      • getRevision

        Revision getRevision​(java.lang.String repositoryName,
                             java.lang.String revisionId)
                      throws java.rmi.RemoteException
        Gets a revision.
        Parameters:
        repositoryName - The repository name. (Put "default" for the default repository.)
        revisionId - The revision name.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getRevisionByUri

        Revision getRevisionByUri​(java.lang.String revisionURI)
                           throws java.rmi.RemoteException
        Gets a revision.
        Parameters:
        revisionURI - The URI of the revision.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getRevisions

        java.lang.String[] getRevisions​(java.lang.String in0)
                                 throws java.rmi.RemoteException
        Returns all revisions for a specific URI.
        Parameters:
        in0 - uri the URI of the persistence object (Work Item, Module/Document, User, etc).
        Returns:
        all revisions for the specific URI.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.3
      • getRootFolders

        Folder[] getRootFolders​(java.lang.String projectId)
                         throws java.rmi.RemoteException
        Returns parent folders from the given Project or on the Global level. Sorted in ascending order by name (or title if present).
        Parameters:
        projectId - The project ID or null for the Global level.
        Returns:
        An array of folders contained within the given Project or on the Global level.
        Throws:
        java.rmi.RemoteException
        Since:
        3.18.1
      • getTimepoints

        TimePoint[] getTimepoints​(java.lang.String projectId)
                           throws java.rmi.RemoteException
        Gets the time points available for a Project.
        Parameters:
        projectId - The Id of the Projects to get the available time points for.
        Throws:
        java.rmi.RemoteException
      • getUnavailableActions

        WorkflowAction[] getUnavailableActions​(java.lang.String workitemURI)
                                        throws java.rmi.RemoteException
        Gets the actions that can not be used on the Work Item in the current state because of unsatisfied condition(s). The conditions of the action are checked and those with failed condition(s) are returned. The reason for unavailability is returned by WorkflowAction.getUnavailabilityMessage(). NOTE: The parameter name workitemURI is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.
        Parameters:
        workitemURI - the URI of the WorkflowObject to get the available actions from. (should not be null)
        Returns:
        the unavailable actions
        Throws:
        java.lang.IllegalArgumentException - if parameter is null
        java.rmi.RemoteException
        Since:
        3.6.1
        See Also:
        performWorkflowAction(java.lang.String, int), getAvailableActions(java.lang.String)
      • getWikiPageByUri

        WikiPage getWikiPageByUri​(java.lang.String uri)
                           throws java.rmi.RemoteException
        Returns a Wiki Page with the given SubterraURI.
        Parameters:
        uri - The SubterraURI (not null).
        Returns:
        The Wiki Page (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWikiPageByUriWithFields

        WikiPage getWikiPageByUriWithFields​(java.lang.String uri,
                                            java.lang.String[] fields)
                                     throws java.rmi.RemoteException
        Returns a Wiki Page with the given SubterraURI.
        Parameters:
        uri - The SubterraURI (not null).
        fields - An array of field names to fill in on the returned Wiki Pages (can be null).
        Returns:
        The Wiki Page (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWikiPageUris

        java.lang.String[] getWikiPageUris​(java.lang.String projectId,
                                           java.lang.String spaceId)
                                    throws java.rmi.RemoteException
        Returns Wiki Pages from a given Project and Space.
        Parameters:
        projectId - The Project Id (not null).
        spaceId - The Space Id (not null).
        Returns:
        An array of Wiki Pages SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWikiPages

        WikiPage[] getWikiPages​(java.lang.String projectId,
                                java.lang.String spaceId)
                         throws java.rmi.RemoteException
        Returns Wiki Pages from a given Project and Space.
        Parameters:
        projectId - The Project Id (not null).
        spaceId - The Space Id (not null).
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWikiPagesWithFields

        WikiPage[] getWikiPagesWithFields​(java.lang.String projectId,
                                          java.lang.String spaceId,
                                          java.lang.String[] fields)
                                   throws java.rmi.RemoteException
        Returns Wiki Pages from a given Project and Space.
        Parameters:
        projectId - The Project Id (not null).
        spaceId - Space Id (not null).
        fields - An array of field names to filled in on the returned Wiki Pages (can be null).
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWikiSpaces

        java.lang.String[] getWikiSpaces​(java.lang.String projectId)
                                  throws java.rmi.RemoteException
        Returns Wiki spaces from a given Project.
        Parameters:
        projectId - The Project Id (not null).
        Returns:
        An array of Space Ids (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • getWorkItemById

        WorkItem getWorkItemById​(java.lang.String projectId,
                                 java.lang.String workitemId)
                          throws java.rmi.RemoteException
        Gets a Work Item with all fields set.
        Parameters:
        projectId - The Id of the project that contains the Work Item to get.
        workitemId - The Id of the Work Item to get.
        Throws:
        java.rmi.RemoteException
      • getWorkItemByIdsWithFields

        WorkItem getWorkItemByIdsWithFields​(java.lang.String projectId,
                                            java.lang.String workitemId,
                                            java.lang.String[] keys)
                                     throws java.rmi.RemoteException
        Gets a Work Item with only the fields specified filled in with values. All other fields are not transmitted.
        Parameters:
        projectId - The Id of the project that contains the Work Item to get.
        workitemId - The Id of the Work Item to get.
        keys - The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
      • getWorkItemByUri

        WorkItem getWorkItemByUri​(java.lang.String uri)
                           throws java.rmi.RemoteException
        Gets a Work Item with all fields set.
        Parameters:
        uri - the URI of the work item to get.
        Throws:
        java.rmi.RemoteException
      • getWorkItemByUriInRevision

        WorkItem getWorkItemByUriInRevision​(java.lang.String uri,
                                            java.lang.String revision)
                                     throws java.rmi.RemoteException
        Gets a Work Item in the given revision with all fields set. Returns null if the work item did not exist in the revision.
        Parameters:
        uri - The URI of the Work Item to get.
        revision - The revision of the Work Item to get.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • getWorkItemByUriInRevisionWithFields

        WorkItem getWorkItemByUriInRevisionWithFields​(java.lang.String uri,
                                                      java.lang.String revision,
                                                      java.lang.String[] keys)
                                               throws java.rmi.RemoteException
        Gets a Work Item in a given revision with only the fields specified filled in with values. All other fields are not transmitted. Returns null if the Work Item does not exist in the revision.
        Parameters:
        uri - The URI of the Work Item to get.
        revision - The revision of the Work Item to get.
        keys - The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • getWorkItemByUriWithFields

        WorkItem getWorkItemByUriWithFields​(java.lang.String uri,
                                            java.lang.String[] keys)
                                     throws java.rmi.RemoteException
        Gets a Work Item with only the fields specified filled in with values. All other fields are not transmitted.
        Parameters:
        uri - The URI of the Work Item to get.
        keys - The fields of the Work Item to fill in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
      • getWorkItemsCount

        int getWorkItemsCount​(java.lang.String query)
                       throws java.rmi.RemoteException
        Counts the number of Work Items returned by the given query.
        Parameters:
        query - The Lucene query to be used.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getWorkItemsLinkedToRevision

        WorkItem[] getWorkItemsLinkedToRevision​(java.lang.String revisionURI)
                                         throws java.rmi.RemoteException
        Gets Work Items linked to a revision.
        Parameters:
        revisionURI - The URI of the revision.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • getWorkItemsLinkedToRevisionWithFields

        WorkItem[] getWorkItemsLinkedToRevisionWithFields​(java.lang.String revisionURI,
                                                          java.lang.String[] keys)
                                                   throws java.rmi.RemoteException
        Gets Work Items linked to a revision.
        Parameters:
        revisionURI - The URI of the revision.
        keys - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • isHistoryAvailable

        boolean isHistoryAvailable()
                            throws java.rmi.RemoteException
        Returns true if the History is available.
        Returns:
        true if the History is available. Otherwise false.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • isResolvedComment

        boolean isResolvedComment​(java.lang.String commentURI)
                           throws java.rmi.RemoteException
        Checks if the comment is in a resolved comments thread.
        Parameters:
        commentURI - The URI of the comment.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • listActivitySources

        ActivitySource[] listActivitySources()
                                      throws java.rmi.RemoteException
        Returns all Activity Sources.
        Returns:
        array of Activity sources.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listAllActivities

        Activity[] listAllActivities​(java.lang.String query,
                                     int count)
                              throws java.rmi.RemoteException
        Returns Activities within the default repository.
        Parameters:
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activities.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listAllActivitiesGlobalIds

        java.lang.String[] listAllActivitiesGlobalIds​(java.lang.String query,
                                                      int count)
                                               throws java.rmi.RemoteException
        Returns the Activity global IDs within the default repository.
        Parameters:
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activity global IDs.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listGroupActivities

        Activity[] listGroupActivities​(java.lang.String uri,
                                       java.lang.String query,
                                       int count)
                                throws java.rmi.RemoteException
        Returns Activities within a given Project group.
        Parameters:
        uri - The SubterraURI (not null).
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activities.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listGroupActivitiesGlobalIds

        java.lang.String[] listGroupActivitiesGlobalIds​(java.lang.String uri,
                                                        java.lang.String query,
                                                        int count)
                                                 throws java.rmi.RemoteException
        Returns global IDs of activities within given project group.
        Parameters:
        uri - The SubterraURI (not null).
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activity global IDs.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listProjectActivities

        Activity[] listProjectActivities​(java.lang.String projectId,
                                         java.lang.String query,
                                         int count)
                                  throws java.rmi.RemoteException
        Returns activities within the given Project.
        Parameters:
        projectId - The Id of the Project (not null).
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activities.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • listProjectActivitiesGlobalIds

        java.lang.String[] listProjectActivitiesGlobalIds​(java.lang.String projectId,
                                                          java.lang.String query,
                                                          int count)
                                                   throws java.rmi.RemoteException
        Returns the global IDs of Activities within the given Project.
        Parameters:
        projectId - The Id of the Project (not null).
        query - The Lucene query (can be null).
        count - The number of results. (-1 will return all results.)
        Returns:
        An array of Activity global IDs.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • moveWorkItemToDocument

        void moveWorkItemToDocument​(java.lang.String workItemURI,
                                    java.lang.String documentURI,
                                    java.lang.String parentWorkItemURI,
                                    int position,
                                    boolean retainDocumentFlow)
                             throws java.rmi.RemoteException
        Moves a Work Item to a specific position in a Document. If the Work Item is not yet inside the Document it will be moved into the Document. Modules are also supported.
        Parameters:
        workItemURI - The URI of the Work Item to be moved.
        documentURI - The URI of the Document.
        parentWorkItemURI - The URI of the parent Work Item or null to insert it as the root.
        position - The desired position in the list of children or a value < 0 to insert the Work Item at the end. (If the old and new parent are the same, then the moved Work Item is not counted.)
        retainDocumentFlow - true to retain the position of the moved Work Item in the document flow, even if it means changing the parent. false to keep the desired parent, even if it means moving the Work Item to a different position.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.0
      • moveWorkItemToModule

        void moveWorkItemToModule​(java.lang.String workItemURI,
                                  java.lang.String moduleURI,
                                  java.lang.String parentWorkItemURI,
                                  int position)
                           throws java.rmi.RemoteException
        Moves a Work Item to a specific position in a Module/Document. If the Work Item is not yet inside the Module/Document it will be moved there. Since 3.7.0 this no longer retains the document flow, but keeps the desired parent.
        Parameters:
        workItemURI - The URI of the Work Item to be moved.
        moduleURI - The URI of the Module/Document.
        parentWorkItemURI - The URI of the parent Work Item or null to insert it as the root.
        position - The desired position in the list of children or a value < 0 to insert at the end. (If the old and new parent are the same, then the moved Work Item is not counted.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.3
      • performWorkflowAction

        void performWorkflowAction​(java.lang.String workitemURI,
                                   int actionId)
                            throws java.rmi.RemoteException
        Executes a workflow action. The actions that can be performed can be received by getAvailableActions(java.lang.String). The workflow action is specified by WorkflowAction.getActionId(). NOTE: The parameter name workitemURI is kept for backward compatibility, but the specified URI can refer to any WorkflowObject, e.g. WorkItem or Module.
        Parameters:
        workitemURI - The URI of the WorkflowObject to execute the action for (should not be null).
        actionId - The Id of the action to execute.
        Throws:
        java.lang.IllegalArgumentException - if workitemURI parameter is null
        java.rmi.RemoteException
        See Also:
        getAvailableActions(java.lang.String)
      • queryBaselines

        Baseline[] queryBaselines​(java.lang.String query,
                                  java.lang.String sort)
                           throws java.rmi.RemoteException
        Queries for Baselines.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • queryModuleUris

        java.lang.String[] queryModuleUris​(java.lang.String query,
                                           java.lang.String sort,
                                           int resultsLimit)
                                    throws java.rmi.RemoteException
        Searches for Modules/Documents.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        resultsLimit - Set a limit on how many results to return. (-1 for unlimited.)
        Returns:
        An array of Modules/Documents SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModuleUrisBySQL

        java.lang.String[] queryModuleUrisBySQL​(java.lang.String sqlQuery)
                                         throws java.rmi.RemoteException
        Searches for Modules/Documents.
        Parameters:
        sqlQuery - The SQL statement.
        Returns:
        An array of Modules/Documents SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModuleUrisInBaseline

        java.lang.String[] queryModuleUrisInBaseline​(java.lang.String query,
                                                     java.lang.String sort,
                                                     java.lang.String baselineRevision,
                                                     int resultsLimit)
                                              throws java.rmi.RemoteException
        Searches for Modules/Documents in a given Baseline.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        baselineRevision - The Baseline revision.
        resultsLimit - Set a limit on how many results to return. (-1 for unlimited.)
        Returns:
        An array of Modules/Documents SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModuleUrisInBaselineBySQL

        java.lang.String[] queryModuleUrisInBaselineBySQL​(java.lang.String sqlQuery,
                                                          java.lang.String baselineRevision)
                                                   throws java.rmi.RemoteException
        Searches for Modules/Documents in a given Baseline.
        Parameters:
        sqlQuery - The SQL statement.
        baselineRevision - The Baseline revision.
        Returns:
        An array of Modules/Documents SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModules

        Module[] queryModules​(java.lang.String query,
                              java.lang.String sort,
                              java.lang.String[] fields,
                              int resultsLimit)
                       throws java.rmi.RemoteException
        Searches for Modules/Documents.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null)
        fields - An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        resultsLimit - Sets a limit on the number of results to return.(-1 to return all results without a limit.)
        Returns:
        An array of Modules/Documents (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModulesBySQL

        Module[] queryModulesBySQL​(java.lang.String sqlQuery,
                                   java.lang.String[] fields)
                            throws java.rmi.RemoteException
        Searches for Modules/Documents.
        Parameters:
        sqlQuery - The SQL statement.
        fields - An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Returns:
        An array of Modules/Documents (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModulesInBaseline

        Module[] queryModulesInBaseline​(java.lang.String query,
                                        java.lang.String sort,
                                        java.lang.String baselineRevision,
                                        java.lang.String[] fields,
                                        int resultsLimit)
                                 throws java.rmi.RemoteException
        Searches for the Modules/Documents in a given Baseline.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        baselineRevision - The Baseline revision
        fields - An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        resultsLimit - how many results to return (-1 means everything)
        Returns:
        An array of Modules/Documents (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryModulesInBaselineBySQL

        Module[] queryModulesInBaselineBySQL​(java.lang.String sqlQuery,
                                             java.lang.String baselineRevision,
                                             java.lang.String[] fields)
                                      throws java.rmi.RemoteException
        Searches for Modules/Documents in a given Baseline.
        Parameters:
        sqlQuery - The SQL statement.
        baselineRevision - The Baseline revision.
        fields - An array of field names to fill in the returned Modules/Documents with. (Can be null.) For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Returns:
        An array of Modules/Documents (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryRevisionUris

        java.lang.String[] queryRevisionUris​(java.lang.String query,
                                             java.lang.String sort,
                                             boolean includeInternal)
                                      throws java.rmi.RemoteException
        Queries for revisions.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        includeInternal - Whether internal Polarion commits should be included.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • queryRevisions

        Revision[] queryRevisions​(java.lang.String query,
                                  java.lang.String sort,
                                  java.lang.String[] fields)
                           throws java.rmi.RemoteException
        Queries for revisions.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        fields - The keys of the fields that should be filled in.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • queryWikiPageUris

        java.lang.String[] queryWikiPageUris​(java.lang.String query,
                                             java.lang.String sort,
                                             int resultsLimit)
                                      throws java.rmi.RemoteException
        Searches for Wiki Pages.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        resultsLimit - Limit the number of results to return.(-1 for unlimited.)
        Returns:
        An array of Wiki Pages SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPageUrisBySQL

        java.lang.String[] queryWikiPageUrisBySQL​(java.lang.String sqlQuery)
                                           throws java.rmi.RemoteException
        Searches for Wiki Pages.
        Parameters:
        sqlQuery - The SQL statement.
        Returns:
        An array of Wiki Pages SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPageUrisInBaseline

        java.lang.String[] queryWikiPageUrisInBaseline​(java.lang.String query,
                                                       java.lang.String sort,
                                                       java.lang.String baselineRevision,
                                                       int resultsLimit)
                                                throws java.rmi.RemoteException
        Searches for Wiki Pages in a given Baseline.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        baselineRevision - The Baseline revision.
        resultsLimit - Limit the number of results to return.(-1 for unlimited.)
        Returns:
        An array of Wiki Pages SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPageUrisInBaselineBySQL

        java.lang.String[] queryWikiPageUrisInBaselineBySQL​(java.lang.String sqlQuery,
                                                            java.lang.String baselineRevision)
                                                     throws java.rmi.RemoteException
        Searches for Wiki Pages in the given Baseline.
        Parameters:
        sqlQuery - The SQL statement.
        baselineRevision - The Baseline revision.
        Returns:
        An array of Wiki Pages SubterraURIs (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPages

        WikiPage[] queryWikiPages​(java.lang.String query,
                                  java.lang.String sort,
                                  java.lang.String[] fields,
                                  int resultsLimit)
                           throws java.rmi.RemoteException
        Searches for Wiki Pages.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        fields - An array of field names to fill in on the returned Wiki Pages (can be null).
        resultsLimit - Limit the maximum number of results to return. (-1 for unlimited.)
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPagesBySQL

        WikiPage[] queryWikiPagesBySQL​(java.lang.String sqlQuery,
                                       java.lang.String[] fields)
                                throws java.rmi.RemoteException
        Searches for Wiki Pages.
        Parameters:
        sqlQuery - The SQL statement.
        fields - An array of field names to fill in for the returned Wiki Pages. (Can be null.)
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPagesInBaseline

        WikiPage[] queryWikiPagesInBaseline​(java.lang.String query,
                                            java.lang.String sort,
                                            java.lang.String baselineRevision,
                                            java.lang.String[] fields,
                                            int resultsLimit)
                                     throws java.rmi.RemoteException
        Searches for Wiki Pages in the given Baseline.
        Parameters:
        query - The Lucene query (can be null).
        sort - The Lucene sort string (can be null).
        baselineRevision - The Baseline revision.
        fields - An array of field names to fill in on the returned Wiki Pages. (Can be null.)
        resultsLimit - Limits the number of results to return. (-1 for unlimited.)
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWikiPagesInBaselineBySQL

        WikiPage[] queryWikiPagesInBaselineBySQL​(java.lang.String sqlQuery,
                                                 java.lang.String baselineRevision,
                                                 java.lang.String[] fields)
                                          throws java.rmi.RemoteException
        Searches for Wiki Pages in the given Baseline.
        Parameters:
        sqlQuery - The SQL statement.
        baselineRevision - The Baseline revision.
        fields - An array of field names to fill in on the returned Wiki Pages. (Can be null.)
        Returns:
        An array of Wiki Pages (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.3
      • queryWorkItemUris

        java.lang.String[] queryWorkItemUris​(java.lang.String query,
                                             java.lang.String sort)
                                      throws java.rmi.RemoteException
        Query the URIs of a Work Item.
        Parameters:
        query - The Lucene query.
        sort - The key used to sort the result.
        Throws:
        java.rmi.RemoteException
      • queryWorkItemUrisBySQL

        java.lang.String[] queryWorkItemUrisBySQL​(java.lang.String sqlQuery)
                                           throws java.rmi.RemoteException
        Query the URIs of Work Items.
        Parameters:
        sqlQuery - the SQL query.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemUrisInBaseline

        java.lang.String[] queryWorkItemUrisInBaseline​(java.lang.String query,
                                                       java.lang.String sort,
                                                       java.lang.String baselineRevision)
                                                throws java.rmi.RemoteException
        Queries for Work Item URIs in a Baseline.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        baselineRevision - The revision that the Work Items should be returned for.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemUrisInBaselineBySQL

        java.lang.String[] queryWorkItemUrisInBaselineBySQL​(java.lang.String sqlQuery,
                                                            java.lang.String baselineRevision)
                                                     throws java.rmi.RemoteException
        Searches for URIs of Work Items in the given Baseline revision.
        Parameters:
        sqlQuery - The SQL query.
        baselineRevision - The Baseline revision that the Work Item should be returned for.
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemUrisInBaselineLimited

        java.lang.String[] queryWorkItemUrisInBaselineLimited​(java.lang.String query,
                                                              java.lang.String sort,
                                                              java.lang.String baselineRevision,
                                                              int resultsLimit)
                                                       throws java.rmi.RemoteException
        Queries for Work Item URIs in a baseline with a given limit.
        Parameters:
        query - the Lucene query to be used.
        sort - The field to be used for sorting.
        baselineRevision - The revision that the Work Items should be returned for.
        resultsLimit - The maximum number of returned Work Items. (-1 for unlimited.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemUrisLimited

        java.lang.String[] queryWorkItemUrisLimited​(java.lang.String query,
                                                    java.lang.String sort,
                                                    int resultsLimit)
                                             throws java.rmi.RemoteException
        Query the URIs of a Work Item.
        Parameters:
        query - the Lucene query.
        sort - The key used to sort the result.
        resultsLimit - The maximum number of returned Work Items. (-1 for unlimited.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • queryWorkItems

        WorkItem[] queryWorkItems​(java.lang.String query,
                                  java.lang.String sort,
                                  java.lang.String[] fields)
                           throws java.rmi.RemoteException
        Queries for Work Items.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        fields - The keys for the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
      • queryWorkItemsBySQL

        WorkItem[] queryWorkItemsBySQL​(java.lang.String sqlQuery,
                                       java.lang.String[] fields)
                                throws java.rmi.RemoteException
        Queries for Work Items.
        Parameters:
        sqlQuery - The SQL query.
        fields - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemsInBaseline

        WorkItem[] queryWorkItemsInBaseline​(java.lang.String query,
                                            java.lang.String sort,
                                            java.lang.String baselineRevision,
                                            java.lang.String[] fields)
                                     throws java.rmi.RemoteException
        Queries for Work Items in a given Baseline.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        baselineRevision - The revision that the Work Items should be returned for.
        fields - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemsInBaselineBySQL

        WorkItem[] queryWorkItemsInBaselineBySQL​(java.lang.String sqlQuery,
                                                 java.lang.String baselineRevision,
                                                 java.lang.String[] fields)
                                          throws java.rmi.RemoteException
        Searches for Work Items in a given Baseline revision.
        Parameters:
        sqlQuery - The SQL query.
        baselineRevision - The Baseline revision in that the Work Items should be returned for.
        fields - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemsInBaselineLimited

        WorkItem[] queryWorkItemsInBaselineLimited​(java.lang.String query,
                                                   java.lang.String sort,
                                                   java.lang.String baselineRevision,
                                                   java.lang.String[] fields,
                                                   int resultsLimit)
                                            throws java.rmi.RemoteException
        Queries for Work Items in a Baseline with a given limit.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        baselineRevision - The revision that the Work Items should be returned for.
        fields - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        resultsLimit - The maximum number of returned Work Items. (-1 for unlimited.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.0
      • queryWorkItemsInRevision

        WorkItem[] queryWorkItemsInRevision​(java.lang.String query,
                                            java.lang.String sort,
                                            java.lang.String revision,
                                            java.lang.String[] fields)
                                     throws java.rmi.RemoteException
        Queries for Work Items. The search is done in the current state of the Work Items, but the Work Items are returned in the state of the given revision. Work Items that were deleted since the revision are not returned.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        revision - The revision that the Work Items should be returned to.
        fields - The keys of the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • queryWorkItemsInRevisionLimited

        WorkItem[] queryWorkItemsInRevisionLimited​(java.lang.String query,
                                                   java.lang.String sort,
                                                   java.lang.String revision,
                                                   java.lang.String[] fields,
                                                   int resultsLimit)
                                            throws java.rmi.RemoteException
        Queries for Work Items. The search is done in current state of the Work Items, but the Work Items are returned in the state they are in for the given revision. Work Items that were deleted since the revision are not returned.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        revision - The revision that the Work Items should be returned for.
        fields - The keys of the fields that should be filled in. For nested structures in the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        resultsLimit - maximal returned number of workitems (-1 means no limit)
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.2
      • queryWorkItemsLimited

        WorkItem[] queryWorkItemsLimited​(java.lang.String query,
                                         java.lang.String sort,
                                         java.lang.String[] fields,
                                         int resultsLimit)
                                  throws java.rmi.RemoteException
        Queries for Work Items.
        Parameters:
        query - The Lucene query to be used.
        sort - The field to be used for sorting.
        fields - The keys of the fields that should be filled in. For nested structures within the lists, use the following syntax to only include a subset of fields: myList.LIST.key (e.g. linkedWorkItems.LIST.role). For custom fields, specify which fields to be filled in using the following syntax: customFields.CUSTOM_FIELD_ID (e.g. customFields.risk).
        resultsLimit - The maximum number of returned Work Items. (-1 for unlimited.)
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.0
      • removeApprovee

        void removeApprovee​(java.lang.String workitemURI,
                            java.lang.String approveeId)
                     throws java.rmi.RemoteException
        Removes an approving user.
        Parameters:
        workitemURI - The URI of the Work Item to remove the approvee from.
        approveeId - The Id of the approving user to remove.
        Throws:
        java.rmi.RemoteException
      • removeAssignee

        boolean removeAssignee​(java.lang.String workitemURI,
                               java.lang.String assigneeId)
                        throws java.rmi.RemoteException
        Removes an assignee.
        Parameters:
        workitemURI - The URI of the Work Item to remove the assignee from.
        assigneeId - the id of the user to add as an assignee.
        Throws:
        java.rmi.RemoteException
      • removeCategory

        boolean removeCategory​(java.lang.String workitemURI,
                               java.lang.String categoryId)
                        throws java.rmi.RemoteException
        Removes a Category.
        Parameters:
        workitemURI - The URI of the Work Item to remove the Category from.
        categoryId - The Id of the Category to Remove.
        Throws:
        java.rmi.RemoteException
      • removeExternalLinkedRevision

        boolean removeExternalLinkedRevision​(java.lang.String workitemURI,
                                             java.lang.String repositoryName,
                                             java.lang.String revisionId)
                                      throws java.rmi.RemoteException
        Removes a revision from an external repository.
        Parameters:
        workitemURI - The URI of the Work Item to remove the linked revision from.
        repositoryName - The Id of the external repository.
        revisionId - The Id of the revision to remove.
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.1
      • removeExternallyLinkedItem

        boolean removeExternallyLinkedItem​(java.lang.String workitemURI,
                                           java.lang.String linkedExternalWorkitemURI,
                                           EnumOptionId role)
                                    throws java.rmi.RemoteException
        Removes an external linked item.
        Parameters:
        workitemURI - The URI of the Work Item to remove the linked item from.
        linkedExternalWorkitemURI - The URI of the linked item to remove.
        role - The role of the linked item to remove.
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.0
      • removeHyperlink

        boolean removeHyperlink​(java.lang.String workitemURI,
                                java.lang.String url)
                         throws java.rmi.RemoteException
        Removes a hyperlink.
        Parameters:
        workitemURI - The URI of the Work Item to remove the hyperlink from.
        url - The url of the hyperlink to remove.
        Throws:
        java.rmi.RemoteException
      • removeLinkedItem

        boolean removeLinkedItem​(java.lang.String workitemURI,
                                 java.lang.String linkedItemURI,
                                 EnumOptionId role)
                          throws java.rmi.RemoteException
        Removes a linked item.
        Parameters:
        workitemURI - The URI of the Work Item to remove the linked item from.
        linkedItemURI - The URI of the linked item to remove.
        role - The role of the linked item to remove.
        Throws:
        java.rmi.RemoteException
      • removeLinkedRevision

        boolean removeLinkedRevision​(java.lang.String workitemURI,
                                     java.lang.String revisionId)
                              throws java.rmi.RemoteException
        Removes a revision.
        Parameters:
        workitemURI - The URI of the Work Item to remove the linked revision from.
        revisionId - The Id of the revision to remove.
        Throws:
        java.rmi.RemoteException
      • removePlaningConstraint

        boolean removePlaningConstraint​(java.lang.String workitemURI,
                                        java.util.Calendar date,
                                        EnumOptionId constraint)
                                 throws java.rmi.RemoteException
        Removes a planing constraint.
        Parameters:
        workitemURI - The URI of the Work Item to remove the planning constraint from.
        date - The date of the planning constraint to remove.
        constraint - The Type of constraint to remove.
        Throws:
        java.rmi.RemoteException
      • resetWorkflow

        void resetWorkflow​(java.lang.String workflowObjectURI)
                    throws java.rmi.RemoteException
        Resets the workflow for the specified object. Performs an initial action if it exists and sets the initial status.
        Parameters:
        workflowObjectURI - The URI of the WorkflowObject (should not be null).
        Throws:
        java.lang.IllegalArgumentException - if the parameter is null.
        java.rmi.RemoteException
        Since:
        3.8.1
      • reuseDocument

        java.lang.String reuseDocument​(java.lang.String sourceURI,
                                       java.lang.String targetProjectId,
                                       java.lang.String targetLocation,
                                       java.lang.String targetName,
                                       java.lang.String targetTitle,
                                       boolean updateTitleInDocument,
                                       EnumOptionId linkRole,
                                       java.lang.String[] derivedFields)
                                throws java.rmi.RemoteException
        Creates a new Document based on an existing Document.
        Parameters:
        sourceURI - The URI of the source Document. (Not null.)
        targetProjectId - The target Project Id. (Not null.)
        targetLocation - The document's Space location with one component or null for the default space. (Can be null.)
        targetName - The target Document's name. (Not null.)
        targetTitle - The target Document's title. (Can be null.)
        updateTitleInDocument - if true then the first title found in the document will be changed to the targetTitle value. (If permissions allow it).
        linkRole - The role of links going from a reused Work Item to its source Work Item or null to not create links unless the derivedFields are specified. If this is the case, the links will be created with the default role. (Can be null.)
        derivedFields - The fields that are derived from the source Document. (See updateDerivedModule.) (Can be null.)
        Returns:
        The URI of the created Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.2
      • reuseModule

        java.lang.String reuseModule​(java.lang.String sourceURI,
                                     java.lang.String targetProjectId,
                                     java.lang.String targetLocation,
                                     java.lang.String targetName,
                                     EnumOptionId linkRole,
                                     java.lang.String[] fields,
                                     java.lang.String[] exceptFields,
                                     java.lang.String[] derivedFields)
                              throws java.rmi.RemoteException
        Creates new Module/Document based on the existing Module/Document.
        Parameters:
        sourceURI - The URI of the source Module/Document.
        targetProjectId - The target project Id.
        targetLocation - ignored
        targetName - The target Module/Document name.
        linkRole - The role of links going from a reused Work Item to a source Work Item or null to not create links unless the derivedFields are specified. (If so, the links will be created with the default role.)
        fields - ignored
        exceptFields - ignored
        derivedFields - The fields that are derived from the source Module/Document (see updateDerivedModule).
        Returns:
        The URI of the created Module/Document.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • setCommentTags

        void setCommentTags​(java.lang.String commentURI,
                            EnumOptionId[] tags)
                     throws java.rmi.RemoteException
        Sets the tags of a comment.
        Parameters:
        commentURI - The URI of the comment.
        tags - The tags to set.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • setCustomField

        void setCustomField​(CustomField customField)
                     throws java.rmi.RemoteException
        Sets a custom field of a Work Item.
        Parameters:
        customField - The custom field to set.
        Throws:
        java.rmi.RemoteException
      • setFieldsNull

        void setFieldsNull​(java.lang.String workitemURI,
                           java.lang.String[] fields)
                    throws java.rmi.RemoteException
        Sets a field to null.
        Parameters:
        workitemURI - The URI of the Work Item to set a fields null for.
        fields - The keys of the fields to set null.
        Throws:
        java.rmi.RemoteException
      • setLocalizedWorkItemDescription

        void setLocalizedWorkItemDescription​(java.lang.String uri,
                                             java.lang.String language,
                                             Text description)
                                      throws java.rmi.RemoteException
        Sets the localized description.
        Parameters:
        uri - The Work Item URI (not null).
        language - The language Id (must be defined) or null for the default language.
        description - The description (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • setLocalizedWorkItemTitle

        void setLocalizedWorkItemTitle​(java.lang.String uri,
                                       java.lang.String language,
                                       java.lang.String title)
                                throws java.rmi.RemoteException
        Sets the localized title.
        Parameters:
        uri - The Work Item URI (not null).
        language - The language Id (must be defined) or null for the default language.
        title - The title (can be null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.6.1
      • setResolvedComment

        void setResolvedComment​(java.lang.String commentURI,
                                boolean resolved)
                         throws java.rmi.RemoteException
        Sets the state of the comment to "Resolved". Can only be used for root comments.
        Parameters:
        commentURI - The URI of the comment.
        resolved - The new resolved state.
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • updateAttachment

        void updateAttachment​(java.lang.String workitemURI,
                              java.lang.String id,
                              java.lang.String fileName,
                              java.lang.String title,
                              byte[] data)
                       throws java.rmi.RemoteException
        Update an existing attachment.
        Parameters:
        workitemURI - The URI of the Work Item containing the attachment to be updated.
        id - The Id of the attachment to be updated.
        fileName - The new filename, will be ignored if null is used.
        title - The new title, will be ignored if null is used.
        data - The new content, will be ignored if null is used.
        Throws:
        java.rmi.RemoteException
        Since:
        3.3.1
      • updateBaseline

        void updateBaseline​(Baseline baseline)
                     throws java.rmi.RemoteException
        Updates the given Baseline.
        Parameters:
        baseline - The updated Baseline (not null).
        Throws:
        java.rmi.RemoteException
        Since:
        3.7.1
      • updateDerivedDocument

        void updateDerivedDocument​(java.lang.String documentURI,
                                   java.lang.String revision,
                                   boolean autoSuspect)
                            throws java.rmi.RemoteException
        Updates derived Document to the new revision (Baseline).
        Parameters:
        documentURI - The derived document.
        revision - Null refers to the HEAD revision
        autoSuspect -
        Throws:
        java.rmi.RemoteException
        Since:
        3.5.3
      • updateDerivedModule

        void updateDerivedModule​(java.lang.String moduleURI,
                                 java.lang.String revision)
                          throws java.rmi.RemoteException
        Updates derived the Module/Document to the new revision (Baseline).
        Parameters:
        moduleURI - The derived Module/Document.
        revision - Null refers to the HEAD revision.
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • updateModule

        void updateModule​(Module module)
                   throws java.rmi.RemoteException
        Updates a Module/Document.
        Parameters:
        module - updated Module/Document
        Throws:
        java.rmi.RemoteException
        Since:
        3.4.1
      • updateTitleHeadingInDocument

        java.lang.String updateTitleHeadingInDocument​(java.lang.String documentURI,
                                                      java.lang.String title)
                                               throws java.rmi.RemoteException
        Updates the first Title Heading in the Document's content.
        Parameters:
        documentURI - The URI of the Document. (Not null.)
        title - The Document title. (Can be null.)
        Returns:
        The URI of an updated Title Heading or null if no Title Heading in the Document's content was updated.
        Throws:
        java.rmi.RemoteException
        Since:
        3.8.2
      • updateWorkItem

        void updateWorkItem​(WorkItem content)
                     throws java.rmi.RemoteException
        Updates a Work Item. The Work Item passed has to contain the valid URI of the Work Item to updated. Fields that are not transmitted will not be set on the target Work Item. Therefore only the changed fields and the URI should be sent to save resources.
        Parameters:
        content - The altered content.
        Throws:
        java.rmi.RemoteException