- canonicalUrl - Variable in class com.playsql.requirementyogi.ao.Baseline
-
The url of the page, or, by default, the indexUrl
- ceo - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceo - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceoId - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceoId() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceoId - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceoId() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess
-
- ceoId - Variable in class com.playsql.requirementyogi.api.dev.DevInterface.Measure
-
- ceoManager - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V29AddSpaceKeysUpgradeTask
-
- ceoManager - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask
-
- ceoManager - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask
-
- ceoManager - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V33EnlargeColumnsToUnlimitedUpgradeTask
-
- checkLimitNotNull() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- cleanKey(String) - Static method in class com.playsql.requirementyogi.ao.Property
-
Encode a key, truncated at 200 characters.
- cleanseRelationship(String, String) - Static method in class com.playsql.requirementyogi.ao.RequirementRef
-
- cleanValue(RenderedContentCleaner, String) - Static method in class com.playsql.requirementyogi.ao.Property
-
- clock - Variable in class com.playsql.requirementyogi.api.dev.DevInterface.Measure
-
- com.playsql.requirementyogi.ao - package com.playsql.requirementyogi.ao
-
Database objects - We rely on Atlassian's ActiveObjects specifications.
- com.playsql.requirementyogi.ao.upgradetasks - package com.playsql.requirementyogi.ao.upgradetasks
-
Upgrade tasks.
- com.playsql.requirementyogi.ao.v27 - package com.playsql.requirementyogi.ao.v27
-
Model beans for the database tables in an older version (v27).
- com.playsql.requirementyogi.ao.v33 - package com.playsql.requirementyogi.ao.v33
-
Model beans for the database tables.
- com.playsql.requirementyogi.api - package com.playsql.requirementyogi.api
-
This is where you start when trying to use Requirement Yogi's Java APIs.
- com.playsql.requirementyogi.api.beans - package com.playsql.requirementyogi.api.beans
-
Core JavaBean objects representing Requirement Yogi's data: Requirements, references, baselines etc.
- com.playsql.requirementyogi.api.dev - package com.playsql.requirementyogi.api.dev
-
APIs which are only available at development time, for internal testing purpose.
- com.playsql.requirementyogi.api.documentimporter - package com.playsql.requirementyogi.api.documentimporter
-
Classes and interfaces related to extending Requirement Yogi with a document importer.
- com.playsql.requirementyogi.api.permissions - package com.playsql.requirementyogi.api.permissions
-
Permission-related classes and interfaces
- com.playsql.requirementyogi.api.search - package com.playsql.requirementyogi.api.search
-
Search-related classes and interfaces
- compare(AORequirement, AORequirement) - Method in class com.playsql.requirementyogi.ao.v33.AORequirement.BaselineComparator
-
- compareTo(JiraRef) - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- compareTo(PageRef) - Method in class com.playsql.requirementyogi.ao.PageRef
-
Natural ordering: by type, then by page, then by occurrence.
- conflicting - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
Duplicated in another place of the space
- convertToCss(Property) - Static method in class com.playsql.requirementyogi.ao.Property
-
- correctedUserQuery - Variable in class com.playsql.requirementyogi.api.SearchResult
-
- count - Variable in class com.playsql.requirementyogi.ao.Baseline
-
Optional.
- count - Variable in class com.playsql.requirementyogi.api.SearchResult
-
- countConflicting - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countCreated - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countDeleted - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countDuplicated - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countEmpty - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countInvalid - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countRecycled - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- countUpdated - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- created - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- createHistoricalVersionOfDocument(DocumentId) - Method in interface com.playsql.requirementyogi.api.documentimporter.VersioningDescriptor
-
Create an archived revision of this document, so the requirements in a baseline relating to this requirement
have an ORIGIN link to point to.
- creator() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
The UserKey of the user who created the baseline
- dao - Variable in class com.playsql.requirementyogi.ao.upgradetasks.V45AddHashColumnUpgradeTask
-
- dateCreation - Variable in class com.playsql.requirementyogi.ao.TestRef
-
- dateOrdering - Variable in class com.playsql.requirementyogi.ao.TestRef
-
- deleted - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- dependencies - Variable in class com.playsql.requirementyogi.ao.Requirement
-
- dependencyId - Variable in class com.playsql.requirementyogi.ao.PageRef
-
An integer, showing the ID of the REQ-to-REQ dependency covering this PageRef.
- Descriptor - Interface in com.playsql.requirementyogi.api.documentimporter
-
If your RY extension wants to import requirements, then it should implement this interface and be declared in the atlassian-plugin.xml using:
- descriptorKey - Variable in class com.playsql.requirementyogi.ao.ImportedRef
-
- descriptorKey - Variable in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- destinationUrl - Variable in class com.playsql.requirementyogi.ao.Requirement
-
- DevIndexingInterface - Interface in com.playsql.requirementyogi.api.dev
-
Do not use in production.
- DevInterface - Interface in com.playsql.requirementyogi.api.dev
-
Do not use in production.
- DevInterface.Measure - Class in com.playsql.requirementyogi.api.dev
-
- display - Variable in class com.playsql.requirementyogi.ao.Property
-
- Document - Class in com.playsql.requirementyogi.api.documentimporter
-
Metadata about a document.
- Document(DocumentId, String, String) - Constructor for class com.playsql.requirementyogi.api.documentimporter.Document
-
- documentId - Variable in class com.playsql.requirementyogi.ao.ImportedRef
-
The project key or
the name of the ReqIf file.
- documentId - Variable in class com.playsql.requirementyogi.api.documentimporter.Document
-
The primary key of the document
- DocumentId - Class in com.playsql.requirementyogi.api.documentimporter
-
The unique key of a document imported by another system
- DocumentId(String, String, String) - Constructor for class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
Constructor when the document is the current version
- DocumentId(DocumentId, String) - Constructor for class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
Constructor for an older version of a document
- DocumentImporterAPI - Interface in com.playsql.requirementyogi.api
-
This interface will be used to import Requirements from external sources.
- DocumentImporterAPI.RequirementPersister - Interface in com.playsql.requirementyogi.api
-
The API that lets you create requirements when you are inside of a document.
- documentsInCollision - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- documentVersionId - Variable in class com.playsql.requirementyogi.ao.ImportedRef
-
If the requirement is archived, this is the version of the document.
- done() - Method in class com.playsql.requirementyogi.api.dev.DevInterface.Measure
-
- duplicated - Variable in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
Duplicated in the same document
- duplicateOriginalPages - Variable in class com.playsql.requirementyogi.ao.Requirement
-
- genericUrl - Variable in class com.playsql.requirementyogi.ao.Requirement
-
- getAdminURL() - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
A URL for the administration, inside of the Confluence instance.
- getAllVersionsOfRequirement(String, String) - Method in interface com.playsql.requirementyogi.api.RequirementService
-
Fetch all versions of a requirement and fill its full details.
- getAO() - Method in interface com.playsql.requirementyogi.api.dev.DevIndexingInterface
-
- getAOCounter() - Method in interface com.playsql.requirementyogi.api.dev.DevInterface
-
- getAoSql() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getApplink() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getApplink() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getApplink() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
The applink key.
- getApplinkId() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getApplinkid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
If provided, the applink's values (URLs, ...) must superseed this bean's values.
- getApplinkid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Jira application link id
- getAttachmentId() - Method in class com.playsql.requirementyogi.ao.ExcelRef
-
- getBaseline() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getBaseline() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getBaseline() - Method in class com.playsql.requirementyogi.ao.RequirementRef
-
- getBaseline() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
- getBaseline() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
- getBaseline() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
The baseline number.
- getBaselineCondition() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
Returns a list of pairs of { spaceKey, baselineNumber }
- getBaselineDetails() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getBaseUrl() - Method in interface com.playsql.requirementyogi.api.RYWebInterfaceAPI
-
- getBean() - Method in exception com.playsql.requirementyogi.api.permissions.PermissionException
-
- getCanonicalUrl() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getCeoId() - Method in class com.playsql.requirementyogi.api.dev.DevInterface.Measure
-
- getChecker(ConfluenceUser, Perm) - Method in interface com.playsql.requirementyogi.api.PermissionAPI
-
Returns a permission checker that caches the results.
- getConflicting() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getCorrectedUserQuery() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getCount() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getCount() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getCreated() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getCreationdate() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
The date of creation of the supporting page, in milliseconds since 1970
- getDateCreation() - Method in class com.playsql.requirementyogi.ao.TestRef
-
- getDateOrdering() - Method in class com.playsql.requirementyogi.ao.TestRef
-
- getDeleted() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getDependencies() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getDependencies(String) - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getDependencies() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getDependencyId() - Method in class com.playsql.requirementyogi.ao.PageRef
-
- getDependencyid() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
If the link is already covered by a REQ-to-REQ dependency, then this is the ID of ORIGIN AODependency.
- getDescriptorKey() - Method in class com.playsql.requirementyogi.ao.ImportedRef
-
- getDescriptorKey() - Method in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- getDestinationUrl() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getDisplayName() - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
A human-readable name to display in the UI.
- getDisplayurl() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
User-facing link to that server, including Jira's context path
- getDocumentationURL() - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
A URL for the documentation, which may be displayed in the administration of RY.
- getDocumentId() - Method in class com.playsql.requirementyogi.ao.ImportedRef
-
- getDocumentIdBean(String) - Method in class com.playsql.requirementyogi.ao.ImportedRef
-
- getDocumentMetadata(DocumentId) - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
Get the document metadata for an active version of the document.
- getDocumentsInCollision() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getDocumentVersionId() - Method in class com.playsql.requirementyogi.ao.ImportedRef
-
- getDuplicated() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getDuplicateOriginalPages() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getDuration() - Method in interface com.playsql.requirementyogi.api.dev.DevInterface
-
- getEndpoint() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
The end of the URL, appended to the RPC URL
- getEstate() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
For TYPE_EXTERNAL:
It's like a space key in Confluence, or a project key in Jira, anything you want.
- getExplanation() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getFields() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getFields() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
A stringify json
Fields can have templated values such as {req.key} .., or hardcoded values
- getFormattingCss() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getFormattingNoBorder() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getGenericUrl() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getGlobalLimit() - Method in interface com.playsql.requirementyogi.api.RYSettingsAPI
-
The maximum number of requirements ever treated in 1 request.
- getGroupall() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Grouping all requirements in one Jira issue
- getHash() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getHtmlExcerpt() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getHtmlexcerpt() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getHtmlexcerpt() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getHtmlflag() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
1 if the HTMLEXCERPT needs to be updated.
- getID() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getId() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getId() - Method in class com.playsql.requirementyogi.api.documentimporter.Document
-
- getId() - Method in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- getIndexation() - Method in class com.playsql.requirementyogi.ao.Property
-
- getIndexingjson() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
The json indexation, for the search queries.
- getIndexUrl() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getInvalid() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getIssue() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getIssue() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegrationQueue
-
The object key.
- getIssue() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
For TYPE_EXTERNAL, the issue key
For TYPE_ORIGINAL_EXCEL, the sheet name + "-" + the row number.
- getIssueKey() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getIssues() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getIssues(String) - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getIssuetemplate() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
The Issue Template that was used to create the link, it should be a Jira link obviously
- getIssueTemplateId() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getIssueTypeId() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getIssuetypeid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Jira issue type id
- getJson() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegrationQueue
-
The body of the message.
- getKey() - Method in class com.playsql.requirementyogi.ao.Property
-
The (unescpaed) key.
- getKey() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getKey() - Method in class com.playsql.requirementyogi.ao.RequirementRef
-
- getKey() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
Deprecated.
- getKey() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
- getKey() - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
The key of this descriptor.
- getKeySuggestions() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getLabel() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
- getLastMeasure() - Method in interface com.playsql.requirementyogi.api.dev.DevInterface
-
- getLastresponse() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegrationQueue
-
- getLimit() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- getLimit() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getLimitForImport() - Method in interface com.playsql.requirementyogi.api.RYSettingsAPI
-
The maximum number of requirements in one import.
- getLimitForUI() - Method in interface com.playsql.requirementyogi.api.RYSettingsAPI
-
The default number of requirements in one page.
- getLinks() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getLinks() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getMarkerInDocument() - Method in class com.playsql.requirementyogi.ao.ImportedRef
-
- getMaxCellsLimit() - Method in interface com.playsql.requirementyogi.api.RYSettingsAPI
-
The maximum number of cells on one page.
- getMessageBeanAsText() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
For external plugins who can't access MessageBean, but still want the contents...
- getMessages() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.AbstractAOUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V27ChangeKeyColumnUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V28RemoveKeyColumnUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V29AddSpaceKeysUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V31AddRequirementPropertiesUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V33EnlargeColumnsToUnlimitedUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V35MarkOrphanDependenciesUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V40ExternalAPIUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V42OutdatedDependenciesUpgradeTask
-
Deprecated.
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V43OutdatedDependenciesUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V45AddHashColumnUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V46RemoveOrphanRequirementsUpgradeTask
-
- getModelVersion() - Method in class com.playsql.requirementyogi.ao.upgradetasks.V47EnsureEstateIsNotNullUpgradeTask
-
- getMultivalues() - Method in class com.playsql.requirementyogi.api.beans.PropertyIndexation
-
- getName() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getName() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
Free-text for the user.
- getNavbarHtml(String, String, ConfluenceActionSupport) - Method in interface com.playsql.requirementyogi.api.RYWebInterfaceAPI
-
Return the HTML of the navigation tabs, with the current tab highlighted.
- getNewSpaceKey() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getNewspacekey() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getNewspacekey() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getOccurrence() - Method in class com.playsql.requirementyogi.ao.PageRef
-
- getOccurrence() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
Index of the link if there are several links in the same page.
- getOffset() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- getOffset() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getOrder() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- getOrigin() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getOriginalPage(AORequirement) - Method in class com.playsql.requirementyogi.ao.upgradetasks.V29AddSpaceKeysUpgradeTask
-
- getPage() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getPageCount() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getPagecount() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
- getPageId() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getPageId() - Method in class com.playsql.requirementyogi.ao.PageRef
-
- getPageId() - Method in class com.playsql.requirementyogi.ao.Requirement
-
Retrieve the pageID, based on the 'origin' or 'page' member.
- getPageid() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getPageid() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
Optional.
- getPageid() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
When type = TYPE_ORIGINAL_PAGE | TYPE_DEPENDENT_PAGE, it's the page id.
- getPagesInCollision() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getPageUrl() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getPageversion() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
If this is a link to an archived version, then pageversion is provided.
- getParent() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getParent() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
- getParent() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
- getParent() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
- getParsingResult() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getPerm() - Method in exception com.playsql.requirementyogi.api.permissions.PermissionException
-
- getProjectId() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getProjectid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Jira project id
- getProjectMetadata() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getProjectmetadata() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Project meta data, a Json string {
projectKey: "TEST",
issueTypeName: "BUG",
projectIconUrl: url,
issueTypeIconUrl: url
}
- getProperties() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getProperties() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getProperty(String) - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getProperty() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
The name of the property.
- getRecycled() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getReferences() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getReferencesExcludingDependencies() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getRelationship() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getRelationship() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getRelationship() - Method in class com.playsql.requirementyogi.ao.RequirementRef
-
- getRelationship() - Method in class com.playsql.requirementyogi.ao.TestRef
-
- getRelationship() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
When type = TYPE_JIRA, issue must have an issue key, applink must have an applink
and relationship contains the Jira Remote Issue Link relationship
- getRelationship() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
The name of the property.
- getRelationship() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Relationship between a requirement and a Jira issue
- getRelationship() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
When type = TYPE_JIRA, issue must have an issue key, applink must have an applink
and relationship contains the Jira Remote Issue Link relationship.
- getReqkey() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getReqkey() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getRequirement(String, String, Integer) - Method in interface com.playsql.requirementyogi.api.RequirementService
-
Retrieve an arbitrary requirement.
- getRequirementcount() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
- getRequirementCount() - Method in interface com.playsql.requirementyogi.api.dev.DevInterface
-
- getResult() - Method in class com.playsql.requirementyogi.ao.TestRef
-
- getResultEmojiHtml() - Method in class com.playsql.requirementyogi.ao.TestRef
-
- getResults() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getResultsForSort() - Method in class com.playsql.requirementyogi.api.SearchResult
-
- getReverseDependencies() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getReverseDependencies(String) - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getRpcurl() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
Same as url, but this could be useful if Confluence has a backoffice link
to the server
- getSearchForVersionsUrl() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getSearchUrl() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getSearchUrl() - Method in class com.playsql.requirementyogi.ao.Property
-
- getSenderrorstoemail() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
- getSendrrorstoemailthrottle() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
- getServiceid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
Unique identifier of the service.
- getServiceid() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegrationQueue
-
- getSheetAndRow() - Method in class com.playsql.requirementyogi.ao.ExcelRef
-
- getSort() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- getSpaceKey() - Method in class com.playsql.requirementyogi.ao.Baseline
-
- getSpaceKey() - Method in class com.playsql.requirementyogi.ao.IssueTemplate
-
- getSpaceKey() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getSpaceKey() - Method in class com.playsql.requirementyogi.ao.RequirementRef
-
- getSpacekey() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getSpacekey() - Method in interface com.playsql.requirementyogi.ao.v33.AOBaseline
-
Mandatory, but not tied to anything in particular
- getSpacekey() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
- getSpacekey() - Method in interface com.playsql.requirementyogi.ao.v33.AOIssueTemplate
-
Space key
- getSpacekey() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getSpaceKey() - Method in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- getSpaceKeys() - Method in class com.playsql.requirementyogi.api.search.SearchConfiguration
-
- getStatus() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getStatus() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getStatus() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirement
-
- getStatus() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
The status of the link:
- null => The link is active
- OUTDATED => The target requirement doesn't exist anymore.
- getStatus() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
The status of this link
- getStatus() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegrationQueue
-
- getStatus() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirement
-
- getTests() - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getTests(String) - Method in class com.playsql.requirementyogi.ao.Requirement
-
- getText() - Method in class com.playsql.requirementyogi.api.beans.PropertyIndexation
-
- getTime() - Method in class com.playsql.requirementyogi.api.dev.DevInterface.Measure
-
- getTitle() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getTitle() - Method in class com.playsql.requirementyogi.ao.Ref
-
- getTitle() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getTitle() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
- getTitle() - Method in class com.playsql.requirementyogi.api.documentimporter.Document
-
- getTitleu() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
Jira issue title.
- getType() - Method in class com.playsql.requirementyogi.ao.Property
-
- getType() - Method in class com.playsql.requirementyogi.ao.Ref
-
- getType() - Method in interface com.playsql.requirementyogi.ao.v27.AORequirementLink
-
- getType() - Method in interface com.playsql.requirementyogi.ao.v33.AODependency
-
- getType() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
- getType() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
The type.
- getUpdated() - Method in class com.playsql.requirementyogi.api.documentimporter.ImportResults
-
- getUrl() - Method in class com.playsql.requirementyogi.ao.JiraRef
-
- getUrl() - Method in class com.playsql.requirementyogi.ao.Ref
-
- getUrl() - Method in class com.playsql.requirementyogi.ao.RequirementRef
-
- getUrl() - Method in class com.playsql.requirementyogi.api.documentimporter.Document
-
- getUrlPrefix(ConversionContextOutputType) - Method in interface com.playsql.requirementyogi.api.RYWebInterfaceAPI
-
Return the base url, depending on whether we are exporting outside of Confluence or staying in the webapp.
- getUserFullName() - Method in exception com.playsql.requirementyogi.api.permissions.PermissionException
-
- getUserKey() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
The user to use when connecting to Jira.
- getUserMentions() - Method in class com.playsql.requirementyogi.api.beans.PropertyIndexation
-
- getValue() - Method in class com.playsql.requirementyogi.ao.Property
-
- getValue() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
- getValueu() - Method in interface com.playsql.requirementyogi.ao.v33.AOProperty
-
The contents of the property.
- getVersion() - Method in class com.playsql.requirementyogi.ao.PageRef
-
- getVersion() - Method in interface com.playsql.requirementyogi.ao.v33.AOIntegration
-
Version of the API exposed by the third party.
- getVersion() - Method in interface com.playsql.requirementyogi.ao.v33.AORequirementLink
-
For TYPE_EXTERNAL:
It is the version of the estate.
- getVersion() - Method in interface com.playsql.requirementyogi.api.documentimporter.Descriptor
-
Returns the version number of the descriptors.
- getVersionedDocumentMetadata(DocumentId) - Method in interface com.playsql.requirementyogi.api.documentimporter.VersioningDescriptor
-
- getVersionId() - Method in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- goal - Variable in class com.playsql.requirementyogi.ao.upgradetasks.AbstractAOUpgradeTask
-
- groupAll - Variable in class com.playsql.requirementyogi.ao.IssueTemplate
-
- V27ChangeKeyColumnUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V27ChangeKeyColumnUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V27ChangeKeyColumnUpgradeTask
-
- V28RemoveKeyColumnUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V28RemoveKeyColumnUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V28RemoveKeyColumnUpgradeTask
-
- V29AddSpaceKeysUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V29AddSpaceKeysUpgradeTask(ContentEntityManager) - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V29AddSpaceKeysUpgradeTask
-
- V30AddSpaceKeyToLinkMacrosUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
Links to requirements in other spaces must have the space key.
- V30AddSpaceKeyToLinkMacrosUpgradeTask(ContentEntityManager, XhtmlContent) - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V30AddSpaceKeyToLinkMacrosUpgradeTask
-
- V30AddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V31AddRequirementPropertiesUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V31AddRequirementPropertiesUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V31AddRequirementPropertiesUpgradeTask
-
- V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
This is a re-execution of V30UpgradeTask, which had a bug and had to be re-executed.
- V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask(ContentEntityManager, XhtmlContent) - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask
-
- V32ReexecuteAddSpaceKeyToLinkMacrosUpgradeTask.LinksToProcess - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V33EnlargeColumnsToUnlimitedUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
This is a re-execution of V30UpgradeTask, which had a bug and had to be re-executed.
- V33EnlargeColumnsToUnlimitedUpgradeTask(ContentEntityManager, XhtmlContent) - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V33EnlargeColumnsToUnlimitedUpgradeTask
-
- V35MarkOrphanDependenciesUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
In V33, you could delete requirements and it would leave a trail of AODependency from various origins.
- V35MarkOrphanDependenciesUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V35MarkOrphanDependenciesUpgradeTask
-
- V40ExternalAPIUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
Mark all AOLink as "external" instead of "jira"
- V40ExternalAPIUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V40ExternalAPIUpgradeTask
-
- V42OutdatedDependenciesUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
- V42OutdatedDependenciesUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V42OutdatedDependenciesUpgradeTask
-
Deprecated.
- V43OutdatedDependenciesUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
Since we've missed some cases, ensure all DELETED requirements have all dependencies marked as OUTDATED.
- V43OutdatedDependenciesUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V43OutdatedDependenciesUpgradeTask
-
- V44DuplicateKeysUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
Since we've missed some cases, find all duplicate requirements and merge them
- V44DuplicateKeysUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V44DuplicateKeysUpgradeTask
-
- V45AddHashColumnUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
Initialize the hash column in the AORequirement table
- V45AddHashColumnUpgradeTask(RequirementDAO) - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V45AddHashColumnUpgradeTask
-
- V46RemoveOrphanRequirementsUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
A customer has ACTIVE requirements which don't have any ORIGINAL link.
- V46RemoveOrphanRequirementsUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V46RemoveOrphanRequirementsUpgradeTask
-
- V47EnsureEstateIsNotNullUpgradeTask - Class in com.playsql.requirementyogi.ao.upgradetasks
-
For the inbound queue to work (IntegrationResource -> /rest/reqs/1/integration/{serviceId}/queue/inbound),
we need to ensure that AOLinks for Jira issues have "_" in their estate.
- V47EnsureEstateIsNotNullUpgradeTask() - Constructor for class com.playsql.requirementyogi.ao.upgradetasks.V47EnsureEstateIsNotNullUpgradeTask
-
- value - Variable in class com.playsql.requirementyogi.ao.Property
-
Value, as HTML.
- valueOf(String) - Static method in enum com.playsql.requirementyogi.ao.Property.Type
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.playsql.requirementyogi.ao.upgradetasks.AbstractAOUpgradeTask.Level
-
Returns the enum constant of this type with the specified name.
- valueOf(String) - Static method in enum com.playsql.requirementyogi.api.permissions.Perm
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.playsql.requirementyogi.ao.Property.Type
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.playsql.requirementyogi.ao.upgradetasks.AbstractAOUpgradeTask.Level
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- values() - Static method in enum com.playsql.requirementyogi.api.permissions.Perm
-
Returns an array containing the constants of this enum type, in
the order they are declared.
- version - Variable in class com.playsql.requirementyogi.ao.PageRef
-
The version of the page.
- versionId - Variable in class com.playsql.requirementyogi.api.documentimporter.DocumentId
-
- VersioningDescriptor - Interface in com.playsql.requirementyogi.api.documentimporter
-
An interface to extend for descriptors which support versioning.