All Classes and Interfaces
Class
Description
Common interface for all fields, that can be used as custom fields.
An HTML color.
CompositeParameter.BuilderBase<P extends CompositeParameter,B extends CompositeParameter.BuilderBase>
Command for copy fields action
Result of copy action
Command for creating linked work item
Widget Parameter for selecting value from custom enumeration.
Widget developer specifies available options by
Widget developer specifies available options by
CustomEnumParameter.Builder.addEnumItem(String, String)Builder which uses custom chart options to build a chart.
Accessor for
DataCount that allows for the use of optional parameters like DataCountAccessor.category(SeparateByCategory)Accessor for
DataSet that allows for the use of optional parameters like DataSetAccessor.category(SeparateByCategory)Interface for selecting the document using optional revision and mandatory project id document path or space id and document name.
Iterating over this instance returns all of a document's Work Items.
Common interface for model fields.
Result of comparing 2 fields using the
Field.compareWith(Field) method.Parameter for configuring list of fields which can be used for example to configure table columns.
In future it will also allow configuring how the fields should be rendered, so the
If there is no scope and prototype or no structure provided through the
In future it will also allow configuring how the fields should be rendered, so the
Field.render(Fields) should be used for the rendering to allow thatIf there is no scope and prototype or no structure provided through the
DataSetParameter or FieldsParameter.Builder, this parameter will use default values: current scope for scope and PrototypeEnum.WorkItem for prototype.Used for setting default fields, when the original set does not suit the use case.
Marks objects for which the project id is a part of identification.
Horizontal alignment selector.
Generic definition for series in plot options.
Low level API for defining Highcharts.
Builder for specifying optional attributes of html tag.
Interface for selecting
HtmlBuilderTargetBuilder for content of html tag, instances are returned by
HtmlTagBuilder.append()Protocol: the following methods can be used only in this order:
1.
1.
Builder for building fragment of html.
Use
HtmlLinkFactory to create instances.Map backed by
LinkedHashMap.Can be used in
DataSetAccessor.interval(IntervalField, TimeAxisInterval)
Represents date or date only field.Parameter for configuring a field of date field which can be used together with
The parameter returns
Must be put inside the
DataSetParameter.The parameter returns
IntervalField which represent selected field and
can be used in DataSetAccessor.interval(IntervalField, TimeAxisInterval).Must be put inside the
DataSetParameter using the DataSetParameter.Builder.add(String, RichPageParameter) to work correctly.Represents read only collection of semantical elements - it does not guarantee that next iteration will return the same instance of the object.
Adapter from
Collection to IterableWithSizeBuilds the branchDocument JS action.
Builds different JS actions.
Defines base parameters for descendant builders
Builds createNewArtifact JS action.
Builds the createBaseline JS action.
Builds createCollection JS action.
Builds createDocument JS action.
Builds createLinkedWorkItem JS action.
Builds createPlan JS action.
Builds createProject JS action.
Builds createDocument JS action.
Builds createDocument JS action.
Builds createTestRun JS action.
Builds createWorkItemForm JS action.
Builds duplicateDocument JS action.
Builds exportToPdf JS action.
Builds importDocument JS action.
Builds importReqIfDocument JS action.
Builds print JS action.
Defines document name for descendant builders
Defines template id for descendant builders
Defines project id for descendant builders
Defines space id for descendant builders
Builder for specifying argument in Javascript method.
Builder for specifying JavaScript method invocations.
Aggregates multiple instances of
IterableWithSize to single instance and
does not iterate over the elements in them until it is needed.The iterator never returns null values
The "position" varies depending on the source file being parsed and the selected
parser creating the resource traceability link.
The "position" varies depending on the source file being parsed and the selected
parser creating the resource traceability link.
Adds possibility to specify page mode.
Generic version of
ModelEntity interface.Generic version of
ModelEntityReference interface.Generic version of
ModelObject interface.Generic implementation of
ModelObjectReference interface.ModelObjectReferenceWithUpdatable<T extends ModelObjectBase<T,R>,U extends UpdatableModelObject,R extends ModelObjectReferenceBase<T,R>>
This interface acts both as the builder for Lucene searches and the iterable of the results.
Based on http://svn.polarion.org/repos/community/Polarion%20Connectors/Polarion%20Extensions/WikiExtensions/com.polarion.alm.extension.vcontext/src/com/polarion/alm/extension/vcontext/ObjectFactory.java
Selector interface to choose the page mode.
Iterable.iterator() iterates over the parametersThis class provides simple access to plan a basic statistic.
Collection of helper methods related to one Plan.
High level API for creating charts.
Instances can be obtained from
SharedContext.createPortalLink()Configuration to associate part or all of the widget with the Properties Sidebar.
The container that the Properties Sidebar is available inside of.
Configuration for enabling the sidebar on a tag representing the rendered object.
"Strict" means that it does not allow null keys, and that all methods use generics unlike for example
Map.containsKey(Object)Use the
TransactionalExecutor.executeInReadOnlyTransaction(RunnableInReadOnlyTransaction) to execute the code in a read only transaction.Additional API for Widget Developer to work with resources through velocity
Configured scripted chart widget resource object.
Common interface for all Rich Page parameters
Plug-ins can not add new implementations of this interface.
The interface should be used when handling dependencies in the UI.
Common interface for classes handling instantiating and initializing Rich Page parameters from persistence./br>
Plug-ins can implement this interface, but it is not needed for normal use cases of using the parameters
Interface for selecting the rich page using optional project id and revision and mandatory page path or space id and page name.
Checks various permissions for Rich Page in specified scope.
Rich Page Widget is a visual component which can be added by the user to the Rich Page
and which shows some data based on user defined parameters - see
RichPageWidget.getParametersDefinition(ParameterFactory)
Implementations should be state-less and not assume that only one instance is created in runtime.Context used in
RichPageWidget.executeAction(RichPageWidgetActionContext)Common super interface for contexts used in methods
RichPageWidget.renderHtml(RichPageWidgetRenderingContext)
and RichPageWidget.executeAction(RichPageWidgetActionContext)TO BE USED ONLY FOR INTERNAL PURPOSES.
Context used in
RichPageWidget.renderHtml(RichPageWidgetRenderingContext)TO BE USED ONLY FOR INTERNAL PURPOSES.
Scope of the objects.
Page and Widget parameter to set scope.
Each instance can be used only once.
Interface for selecting the scope with option type, the selection is finished using some method from
ScopeSelector
Each instance can be used only once.Object that contains information about script rendering result.
Instances are returned by
SeparateByParameter.categories().Parameter for configuring a field of enum type which can be used together with
The parameter returns list of
Must be put inside the
DataSetParameter.The parameter returns list of
SeparateByParameter.categories() which represent the configured allowed values for the selected field and
can be used in DataSetAccessor.category(SeparateByCategory).Must be put inside the
DataSetParameter using the DataSetParameter.Builder.add(String, RichPageParameter) to work correctly.Instance can be obtained from
ReadOnlyTransaction.context()Instance can be obtained from
SharedContext.localization()Parameter for configuring sorting of items by the
Must be put inside the
SortingParameter.fields()Must be put inside the
DataSetParameter using the DataSetParameter.Builder.add(String, RichPageParameter) to work correctly.The space now represents a folder (
IFolder from old API) in which the rich pages or documents are contained,
but in future it might me extended to also have some fields, so it will derive from ModelObjectInterface for selecting the context of the spaces using optional project id.
Interface for selecting the space using optional project id and space id.
Keeps order of elements how they were added
Map backed by
LinkedHashMap.Map backed by
LinkedHashMap.Test case specific view of a work item.
Collection of helper methods that return some Test Run related queries.
Defines interval between two
TimeAxisPoint points.Defines a point in time.
Executor for code using the
ReadOnlyTransaction or WriteTransactionGeneric version of
UpdatableModelObject interface.UpdatableObjectReferenceField<T extends ModelObjectBase<T,R>,R extends ModelObjectReferenceBase<T,R>,S extends ModelObjectSelector<T,S,R>>
For more info see
UserGroup.Common interface for updatable objects with attachments.
Representation of User Group object
Wrapper class for WikiPage attachments' references.
Interface for selecting the wiki page using optional project id and revision and mandatory page path or space id and page name.
Iterable.iterator() iterates over the WorkItemLinkedWorkItemsField.direct() and then over the WorkItemLinkedWorkItemsField.back() links, but not the WorkItemLinkedWorkItemsField.external()Use the
TransactionalExecutor.executeInWriteTransaction(RunnableInWriteTransaction) to execute the code in a write transaction.