Polarion SDK

https://testdrive.polarion.com/polarion/sdk/doc/javadoc/
Admin
The Polarion SDK provides tools, libraries, and documentation for developing custom applications and...
Tokens:1,975,005
Snippets:24,431
Trust Score:8.8
Update:1 week ago
Show doc for...
Tokens:
Raw
### getStart() - Project (WS client)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the start value for this Project.

```APIDOC
## getStart()

### Description
Gets the start value for this Project.

### Method
GET

### Class
com.polarion.alm.ws.client.types.projects.Project

### Returns
The start value for this Project.
```

--------------------------------

### start()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/startup/IStartupService.html

Starts the startup service. This method is called to initiate the service's startup process.

```APIDOC
## start()

### Description
Starts the startup service. This method is called to initiate the service's startup process.

### Method
start

### Signature
void start()

### Parameters
None

### Return Type
void

### Example
```java
IStartupService service = ...;
service.start();
```
```

--------------------------------

### getStart()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/ITrackerProject.html

Returns the start date of the project.

```APIDOC
## getStart()

### Description
Returns the start date of the project.

### Method
getStart

### Parameters
None.

### Returns
- **DateOnly** - The start date.
```

--------------------------------

### startUpdate()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/IPlanningManager.html

Starts the update process for plans.

```APIDOC
## startUpdate

### Description
Starts the update process for plans.

### Method
void startUpdate()
```

--------------------------------

### getStartTime

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/builder/model/IBuild.html

Returns the build start time.

```APIDOC
## getStartTime

### Description
Returns the build start time.

### Method
`Date getStartTime()`

### Returns
- `Date` - start time (not `null`)

### See Also
- `IJob.getStartTime()`
```

--------------------------------

### setStart(Date start)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/projects/Project.html

Sets the start value for this Project.

```APIDOC
## setStart(Date start)

### Description
Sets the start value for this Project.

### Method
Setter

### Signature
public void setStart(Date start)

### Parameters
- **start** (Date) - The start value to set.

```

--------------------------------

### getStartTime()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/builder/model/IBuild.html

Returns the build start time.

```APIDOC
## getStartTime()

### Description
Returns the build start time.

### Method
`Date getStartTime()`

### Return Type
`Date`

### Returns
The build start time.
```

--------------------------------

### getStartDate()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IPlan.html

Returns the start date of the plan.

```APIDOC
## getStartDate()

### Description
Returns the start date of the plan.

### Method
getStartDate

### Returns
- **DateOnly** - The start date.
```

--------------------------------

### getStartedOn()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IPlan.html

Returns the date when the plan was started.

```APIDOC
## getStartedOn()

### Description
Returns the date when the plan was started.

### Method
getStartedOn

### Returns
- **Date** - The start date.
```

--------------------------------

### getFromTime() - Method in interface com.polarion.alm.tracker.calendar.IWorkingTime

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Method to get the start of the working time.

```APIDOC
## getFromTime()

### Description
Method in interface com.polarion.alm.tracker.calendar.IWorkingTime. Returns the start of the working time.

### Method
Instance

### Signature
`Date getFromTime()`

### Returns
- The start of the working time.
```

--------------------------------

### getTypeId() - Method in interface com.polarion.platform.persistence.ICustomFieldType

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the id of the type used for the string (for example "text/html").

```APIDOC
## getTypeId()

### Description
Gets the id of the type used for the string (for example "text/html").

### Method
Interface method

### Signature
`String getTypeId()`

### Returns
The type id string.
```

--------------------------------

### getTypeId()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/persistence/ICustomFieldType.html

Gets the id of the type used for the string (for example 'text/html'). Returns null if the custom field type is enum.

```APIDOC
## getTypeId()

### Description
Gets the id of the type used for the string (for example "text/html"). If this method returns null, the custom field type is enum.

### Method
`@Nullable String getTypeId()`

### Returns
- **String** - The type ID, or null if the custom field type is enum.
```

--------------------------------

### Project(Boolean active, String color, Text description, Date finish, String icon, String id, User lead, String location, Date lockWorkRecordsDate, String name, String projectGroupURI, Date start, String trackerPrefix, String uri, boolean unresolvable)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/projects/Project.html

Parameterized constructor for creating a Project instance with all properties initialized.

```APIDOC
## Project(Boolean active, String color, Text description, Date finish, String icon, String id, User lead, String location, Date lockWorkRecordsDate, String name, String projectGroupURI, Date start, String trackerPrefix, String uri, boolean unresolvable)

### Description
Parameterized constructor for creating a Project instance with all properties initialized.

### Method
Constructor

### Signature
public Project(Boolean active, String color, Text description, Date finish, String icon, String id, User lead, String location, Date lockWorkRecordsDate, String name, String projectGroupURI, Date start, String trackerPrefix, String uri, boolean unresolvable)

### Parameters
- **active** (Boolean) - The active status of the project.
- **color** (String) - The color associated with the project.
- **description** (Text) - The description of the project.
- **finish** (Date) - The finish date of the project.
- **icon** (String) - The icon identifier for the project.
- **id** (String) - The unique identifier of the project.
- **lead** (User) - The lead user of the project.
- **location** (String) - The location of the project.
- **lockWorkRecordsDate** (Date) - The date when work records are locked.
- **name** (String) - The name of the project.
- **projectGroupURI** (String) - The URI of the project group.
- **start** (Date) - The start date of the project.
- **trackerPrefix** (String) - The tracker prefix for the project.
- **uri** (String) - The URI of the project.
- **unresolvable** (boolean) - Indicates if the project is unresolvable.

```

--------------------------------

### startup()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/persistence/ICalculatedFieldsService.html

Called internally during startup of the platform. This method is not intended for direct external use.

```APIDOC
## startup()

### Description
Called internally during startup of the platform. This method is not intended for direct external use.

### Method Signature
`void startup()`

```

--------------------------------

### startScheduler()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/jobs/scheduler/IJobSchedulerService.html

Starts the scheduler. Jobs scheduled while the scheduler was stopped are not executed out-of-order. The scheduler is started after initialization.

```APIDOC
## startScheduler()

### Description
Starts the scheduler. Jobs which were scheduled at the time the scheduler was stopped are not executed out-of-order. The scheduler is started after initialization.

### Method
startScheduler

### Signature
void startScheduler() throws GenericJobException

### Parameters
None

### Throws
- **GenericJobException** - if error occurs

```

--------------------------------

### getSelections()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the selections.

```APIDOC
## getSelections()

### Description
Gets the selections.

### Method
Method in interface com.polarion.alm.tracker.model.IFeatureSelection

### Returns
- The selections.
```

--------------------------------

### Plan()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-16.html

Constructor for class com.polarion.alm.ws.client.types.planning.Plan.

```APIDOC
## Constructor: Plan()

### Description
Constructor for class com.polarion.alm.ws.client.types.planning.Plan.

```

--------------------------------

### getRevisionByUri

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/tracker/TrackerWebService.html

Gets a revision.

```APIDOC
## getRevisionByUri

### Description
Gets a revision.

### Method
SDK Method

### Signature
`Revision getRevisionByUri(String revisionURI)`

### Parameters
- **revisionURI** (String) - Required - The URI of the revision.

### Returns
- **Revision** - The revision.
```

--------------------------------

### Project()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/projects/Project.html

Default constructor for creating a Project instance.

```APIDOC
## Project()

### Description
Default constructor for creating a Project instance.

### Method
Constructor

### Signature
public Project()

```

--------------------------------

### startAutoPolling()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/repository/external/IExternalRepositoryProvider.IExternalRepository.html

Starts the auto polling.

```APIDOC
## startAutoPolling()

### Description
Starts the auto polling. Called only if `allowsAutoPolling()` returns `true`.

### Method
`void startAutoPolling()`

```

--------------------------------

### wasPlanStarted

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/planning/PlanningWebService.html

Checks if the plan was started.

```APIDOC
## wasPlanStarted

### Description
Checks if the plan was started.

### Method
boolean

### Parameters
- `uri` (String) - Required - URI of the plan

### Returns
boolean - true if the plan was started, false otherwise

### Throws
- `RemoteException`

### Since
3.8.0
```

--------------------------------

### IBaselinesManager.createBaseline(String name, String description, String revision, IUser author)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/projects/model/class-use/IUser.html

Creates a project baseline.

```APIDOC
## IBaselinesManager.createBaseline(String name, String description, String revision, IUser author)

### Description
Creates a project baseline.

### Method
createBaseline

### Parameters
- **name** (String) - Required - The name of the baseline.
- **description** (String) - Required - The description of the baseline.
- **revision** (String) - Required - The revision of the baseline.
- **author** (IUser) - Required - The author of the baseline.

### Returns
- **IBaseline** - The created baseline.
```

--------------------------------

### fromAllConfigs()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/projects/ldap/ILdapSyncBuilder.IWithType.html

Synchronize using all available LDAP configurations from authentication.xml.

```APIDOC
## fromAllConfigs()

### Description
Synchronize using all available LDAP configurations from authentication.xml.

### Returns
- **T** - delegating instance of ILdapSynchronization. It delegates all calls to every instance of ILdapSynchronization delegate.
```

--------------------------------

### getUsers() - ProjectWebService

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets all users.

```APIDOC
## getUsers()

### Description
Gets all users.

### Method
GET

### Interface
com.polarion.alm.ws.client.projects.ProjectWebService

### Returns
Array of User objects.
```

--------------------------------

### getSelectionType()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the selection type.

```APIDOC
## getSelectionType()

### Description
Gets the selection type.

### Method
Method in interface com.polarion.alm.tracker.model.IFeatureSelectionItem

### Returns
- The selection type.
```

--------------------------------

### IStartupService - Interface in com.polarion.platform.startup

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-9.html

Interface for startup services.

```APIDOC
## IStartupService

### Description
Interface for startup services.
```

--------------------------------

### ProductLicense()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/security/ProductLicense.html

Default constructor for creating a new ProductLicense instance.

```APIDOC
## ProductLicense()

### Description
Default constructor for the ProductLicense class.

### Method
Constructor

### Signature
public ProductLicense()

```

--------------------------------

### getPassword() - IPassword

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Get password.

```APIDOC
## getPassword()

### Description
Get password.

### Method
GET

### Endpoint
com.polarion.platform.security.login.IPassword#getPassword()

### Parameters
None

### Response
#### Success Response (200)
- **password** (String) - The password.

#### Response Example
```json
{
  "password": "string"
}
```
```

--------------------------------

### getStart

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/ITrackerProject.html

Returns the start date of the project's tracker period.

```APIDOC
## getStart()

### Description
Returns the start date of the project's tracker period.

### Method
`DateOnly getStart()`

### Returns
- **DateOnly** - The start date.
```

--------------------------------

### getFloat()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the float value.

```APIDOC
## getFloat()

### Description
Gets the float value.

### Method
GET

### Endpoint
com.polarion.alm.tracker.model.IPriorityOpt#getFloat()

### Parameters
None

### Response
#### Success Response
- **floatValue** (float) - The float value.

#### Response Example
```json
{
  "floatValue": 1.0
}
```
```

--------------------------------

### with(IPassword<T> credentials)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/security/login/ILogin.IUsingAuthenticator.html

Use user name and password for authentication. Returns the next builder step.

```APIDOC
## with(IPassword<T> credentials)

### Description
Use user name and password for authentication.

### Method
with

### Signature
`@NotNull ILogin.IWithCredentials with(@NotNull IPassword<T> credentials)`

### Parameters
- **credentials** (IPassword<T>) - Required - User name and password packed by `Password.of(String, String)`.

### Returns
Next builder step (ILogin.IWithCredentials).
```

--------------------------------

### getName()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/security/accesstoken/IUserAccessToken.html

Gets the name of the token.

```APIDOC
## getName()

### Description
Gets the name of the token.

### Method
`@NotNull String getName()`

### Returns
- **String** - Name of the token
```

--------------------------------

### from(String source)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/security/login/ILogin.html

Defines the login source and returns the next builder step.

```APIDOC
## from(String source)

### Description
Defines the login source and returns the next builder step.

### Method
from

### Signature
`@NotNull ILogin.IBase from(@NotNull String source)`

### Parameters
- **source** (String) - Required - login source.

### Returns
- **ILogin.IBase** - next builder step.

```

--------------------------------

### getId()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/security/accesstoken/IUserAccessToken.html

Gets the token ID.

```APIDOC
## getId()

### Description
Gets the token ID.

### Method
`@NotNull String getId()`

### Returns
- **String** - ID of the token
```

--------------------------------

### ProductLicense(LicenseInfo[] concurrentLicenseData, String customerCompany, String customerEmail, String customerName, Calendar dateCreated, Calendar expirationDate, String generatedBy, String ipAddress, String licenseFormat, String licenseProfile, String macAddress, LicenseInfo[] namedLicenseData)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/security/class-use/LicenseInfo.html

Constructs a ProductLicense with the specified license data and customer information.

```APIDOC
## ProductLicense(LicenseInfo[] concurrentLicenseData, String customerCompany, String customerEmail, String customerName, Calendar dateCreated, Calendar expirationDate, String generatedBy, String ipAddress, String licenseFormat, String licenseProfile, String macAddress, LicenseInfo[] namedLicenseData)

### Description
Constructs a new ProductLicense with the given parameters.

### Constructor
`ProductLicense(LicenseInfo[] concurrentLicenseData, String customerCompany, String customerEmail, String customerName, Calendar dateCreated, Calendar expirationDate, String generatedBy, String ipAddress, String licenseFormat, String licenseProfile, String macAddress, LicenseInfo[] namedLicenseData)`

### Parameters
- **concurrentLicenseData** (LicenseInfo[]) - The concurrent license data.
- **customerCompany** (String) - The customer company.
- **customerEmail** (String) - The customer email.
- **customerName** (String) - The customer name.
- **dateCreated** (Calendar) - The date created.
- **expirationDate** (Calendar) - The expiration date.
- **generatedBy** (String) - The generator.
- **ipAddress** (String) - The IP address.
- **licenseFormat** (String) - The license format.
- **licenseProfile** (String) - The license profile.
- **macAddress** (String) - The MAC address.
- **namedLicenseData** (LicenseInfo[]) - The named license data.
```

--------------------------------

### getRevisionByUri

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/tracker/TrackerWebService.html

Gets a revision by its URI.

```APIDOC
## getRevisionByUri

### Description
Gets a revision.

### Method
`Revision getRevisionByUri(String revisionURI)`

### Parameters
- **revisionURI** (String) - Required - The URI of the revision.

### Returns
- **Revision** - The revision object.

### Throws
- `RemoteException`

### Since
3.3.0
```

--------------------------------

### PlanRecord()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-16.html

Constructor for class com.polarion.alm.ws.client.types.planning.PlanRecord.

```APIDOC
## Constructor: PlanRecord()

### Description
Constructor for class com.polarion.alm.ws.client.types.planning.PlanRecord.

```

--------------------------------

### getEnumOptionWithKey

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/tracker/TrackerWebService.html

Gets an enumeration option.

```APIDOC
## getEnumOptionWithKey

### Description
Gets an enumeration option.

### Method
EnumOption getEnumOptionWithKey(String workitemURI, String key, EnumOptionId id) throws RemoteException

### Parameters
- **workitemURI** (String) - Required - The URI of the Work Item to get the enumeration option for.
- **key** (String) - Required - The key of the field containing the enumeration option value.
- **id** (EnumOptionId) - Required - The enumeration option Id.

### Throws
- `RemoteException`

```

--------------------------------

### getEnumOptionWithEnumId

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/tracker/TrackerWebService.html

Gets an enumeration option.

```APIDOC
## getEnumOptionWithEnumId

### Description
Gets an enumeration option.

### Method
EnumOption getEnumOptionWithEnumId(String workitemURI, String enumID, EnumOptionId id) throws RemoteException

### Parameters
- **workitemURI** (String) - Required - The URI of the Work Item to get the enumeration option for.
- **enumID** (String) - Required - The Id of the enumeration.
- **id** (EnumOptionId) - Required - The enumeration option Id.

### Throws
- `RemoteException`

```

--------------------------------

### getStartTime() - Build (WS client)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the startTime value for this Build.

```APIDOC
## getStartTime()

### Description
Gets the startTime value for this Build.

### Method
GET

### Class
com.polarion.alm.ws.client.types.builder.Build

### Returns
The startTime value for this Build.
```

--------------------------------

### ITrackerProject.getStart()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/core/util/types/class-use/DateOnly.html

Returns the start date of the tracker project.

```APIDOC
## ITrackerProject.getStart()

### Description
Returns the start date of the tracker project.

### Method
`DateOnly getStart()`

### Return Type
`DateOnly`

### Package
`com.polarion.alm.tracker.model`
```

--------------------------------

### getDeserializer

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/builder/Build.html

Gets a custom deserializer.

```APIDOC
## getDeserializer

### Description
Gets a custom deserializer.

### Method
GET

### Endpoint
Build.getDeserializer(String mechType, Class _javaType, QName _xmlType)

### Parameters
#### Request Body
- **mechType** (String) - Required - The mechanism type.
- **_javaType** (Class) - Required - The Java type.
- **_xmlType** (QName) - Required - The XML type.

### Request Example
```
Deserializer deserializer = Build.getDeserializer(mechType, _javaType, _xmlType);
```

### Response
#### Success Response
- **Deserializer** - The custom deserializer.
```

--------------------------------

### getSerializer

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/builder/Build.html

Gets a custom serializer.

```APIDOC
## getSerializer

### Description
Gets a custom serializer.

### Method
GET

### Endpoint
Build.getSerializer(String mechType, Class _javaType, QName _xmlType)

### Parameters
#### Request Body
- **mechType** (String) - Required - The mechanism type.
- **_javaType** (Class) - Required - The Java type.
- **_xmlType** (QName) - Required - The XML type.

### Request Example
```
Serializer serializer = Build.getSerializer(mechType, _javaType, _xmlType);
```

### Response
#### Success Response
- **Serializer** - The custom serializer.
```

--------------------------------

### Folder(String name, String projectURI, String title, String titleOrName)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/tracker/Folder.html

Parameterized constructor for the Folder class, initializing all properties.

```APIDOC
## Folder(String name, String projectURI, String title, String titleOrName)

### Description
Parameterized constructor for the Folder class, initializing all properties.

### Method
Constructor

### Signature
`public Folder(String name, String projectURI, String title, String titleOrName)`

### Parameters
- **name** (String) - The name of the folder.
- **projectURI** (String) - The project URI associated with the folder.
- **title** (String) - The title of the folder.
- **titleOrName** (String) - The title or name of the folder.

```

--------------------------------

### IBaseWithLinkedOslcResources.getPolarionType()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/class-use/ITypeOpt.html

Gets the type of this object.

```APIDOC
## IBaseWithLinkedOslcResources.getPolarionType()

### Description
Gets the type of this object.

### Method
`default ITypeOpt getPolarionType()`

### Returns
- `ITypeOpt` - The type of this object.
```

--------------------------------

### Plan(EnumOptionId[] allowedTypes, String authorURI, EnumOptionId calculationType, Float capacity, String color, Calendar created, Float defaultEstimate, Text description, Date dueDate, String estimationField, Calendar finishedOn, Text homePageContent, String id, Boolean isTemplate, String location, String name, Plan parent, String previousTimeSpent, String prioritizationField, String projectURI, String[] projectSpanURIs, PlanRecord[] records, Integer sortOrder, Date startDate, Calendar startedOn, EnumOptionId status, String templateURI, Calendar updated, Boolean useReportFromTemplate, Custom[] customFields, String uri, boolean unresolvable)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/planning/Plan.html

Parameterized constructor for the Plan class that initializes all fields.

```APIDOC
## Plan(EnumOptionId[] allowedTypes, String authorURI, EnumOptionId calculationType, Float capacity, String color, Calendar created, Float defaultEstimate, Text description, Date dueDate, String estimationField, Calendar finishedOn, Text homePageContent, String id, Boolean isTemplate, String location, String name, Plan parent, String previousTimeSpent, String prioritizationField, String projectURI, String[] projectSpanURIs, PlanRecord[] records, Integer sortOrder, Date startDate, Calendar startedOn, EnumOptionId status, String templateURI, Calendar updated, Boolean useReportFromTemplate, Custom[] customFields, String uri, boolean unresolvable)

### Description
Parameterized constructor for the Plan class that initializes all fields.

### Method
Constructor

### Signature
`Plan(EnumOptionId[] allowedTypes, String authorURI, EnumOptionId calculationType, Float capacity, String color, Calendar created, Float defaultEstimate, Text description, Date dueDate, String estimationField, Calendar finishedOn, Text homePageContent, String id, Boolean isTemplate, String location, String name, Plan parent, String previousTimeSpent, String prioritizationField, String projectURI, String[] projectSpanURIs, PlanRecord[] records, Integer sortOrder, Date startDate, Calendar startedOn, EnumOptionId status, String templateURI, Calendar updated, Boolean useReportFromTemplate, Custom[] customFields, String uri, boolean unresolvable)`

```

--------------------------------

### getPolarionType()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IBaseWithLinkedOslcResources.html

Gets the type of this object.

```APIDOC
## getPolarionType()

### Description
Gets the type of this object.

### Method
getPolarionType

### Signature
`@Nullable default ITypeOpt getPolarionType()`

### Returns
The `ITypeOpt` for this object, or `null` if no type is assigned.
```

--------------------------------

### getStartDate

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IPlan.html

Returns the start date of the plan, or null if not set.

```APIDOC
## getStartDate

### Description
Returns the start date of the plan, or null if not set.

### Method
`@Nullable DateOnly getStartDate()`

### Returns
- **DateOnly** - The start date, or null.

```

--------------------------------

### build()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/ai/llm/CompletionOptions.Builder.html

Builds and returns a CompletionOptions instance with the configured settings.

```APIDOC
## build()

### Description
Builds and returns a CompletionOptions instance with the configured settings.

### Method
Instance Method

### Signature
`@NotNull public CompletionOptions build()`

### Parameters
None

### Returns
A `CompletionOptions` instance built from the current builder state.
```

--------------------------------

### getReportsRepository()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/builder/IBuilderService.html

Gets the reports repository.

```APIDOC
## getReportsRepository()

### Description
Gets the reports repository.

### Method
getReportsRepository

### Parameters
None

### Returns
- **IReportsRepository** - The reports repository.
```

--------------------------------

### setStartedOn

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IPlan.html

Sets the date when the plan was started.

```APIDOC
## setStartedOn

### Description
Sets the date when the plan was started.

### Method
`void setStartedOn(@Nullable Date value)`

### Parameters
- **value** (Date) - Optional - The start date to set.

```

--------------------------------

### Usage.Builder.build()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/ai/llm/class-use/Usage.html

Builds and returns a Usage instance.

```APIDOC
## Usage.Builder.build()

### Description
Builds and returns a Usage instance.

### Method
build()

### Returns
- **Usage** - The built Usage instance.
```

--------------------------------

### setStartDate

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/model/IPlan.html

Sets the start date of the plan.

```APIDOC
## setStartDate

### Description
Sets the start date of the plan.

### Method
`void setStartDate(@Nullable DateOnly value)`

### Parameters
- **value** (DateOnly) - Optional - The start date to set.

```

--------------------------------

### Build(User author, String birLocation, String buildDescriptorName, BuildRequestorSpecificData[] buildRequestorSpecificData, String buildStamp, String buildStatus, String buildTag, BuildTestResults buildTestResults, String calculationDescriptorName, Calendar creationTime, Calendar finishTime, String id, String jobId, BuildLinkedWorkItem[] linkedWorkItems, String localDeploymentSpaceName, String[] logFiles, Calendar startTime, String uri, boolean unresolvable)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/builder/class-use/BuildRequestorSpecificData.html

Constructs a new Build object with the specified parameters, including an array of BuildRequestorSpecificData.

```APIDOC
## Build(User author, String birLocation, String buildDescriptorName, BuildRequestorSpecificData[] buildRequestorSpecificData, String buildStamp, String buildStatus, String buildTag, BuildTestResults buildTestResults, String calculationDescriptorName, Calendar creationTime, Calendar finishTime, String id, String jobId, BuildLinkedWorkItem[] linkedWorkItems, String localDeploymentSpaceName, String[] logFiles, Calendar startTime, String uri, boolean unresolvable)

### Description
Constructs a new Build object with the specified parameters.

### Constructor
`Build(User author, String birLocation, String buildDescriptorName, BuildRequestorSpecificData[] buildRequestorSpecificData, String buildStamp, String buildStatus, String buildTag, BuildTestResults buildTestResults, String calculationDescriptorName, Calendar creationTime, Calendar finishTime, String id, String jobId, BuildLinkedWorkItem[] linkedWorkItems, String localDeploymentSpaceName, String[] logFiles, Calendar startTime, String uri, boolean unresolvable)`

### Parameters
- **author** (User) - The author of the build.
- **birLocation** (String) - The BIR location.
- **buildDescriptorName** (String) - The build descriptor name.
- **buildRequestorSpecificData** (BuildRequestorSpecificData[]) - The build requestor specific data.
- **buildStamp** (String) - The build stamp.
- **buildStatus** (String) - The build status.
- **buildTag** (String) - The build tag.
- **buildTestResults** (BuildTestResults) - The build test results.
- **calculationDescriptorName** (String) - The calculation descriptor name.
- **creationTime** (Calendar) - The creation time.
- **finishTime** (Calendar) - The finish time.
- **id** (String) - The ID.
- **jobId** (String) - The job ID.
- **linkedWorkItems** (BuildLinkedWorkItem[]) - The linked work items.
- **localDeploymentSpaceName** (String) - The local deployment space name.
- **logFiles** (String[]) - The log files.
- **startTime** (Calendar) - The start time.
- **uri** (String) - The URI.
- **unresolvable** (boolean) - Whether the build is unresolvable.

```

--------------------------------

### ParametersLibrary(ParameterDefinition[] parameterDefinitions)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/testmanagement/ParametersLibrary.html

Constructor that initializes the ParametersLibrary with the given array of parameter definitions.

```APIDOC
## ParametersLibrary(ParameterDefinition[] parameterDefinitions)

### Description
Constructor that initializes the ParametersLibrary with the given array of parameter definitions.

### Method
Constructor

### Signature
`public ParametersLibrary(ParameterDefinition[] parameterDefinitions)`

### Parameters
- **parameterDefinitions** (ParameterDefinition[]) - Required - The array of parameter definitions to set.
```

--------------------------------

### PlanStatistics(float done, float todo, Integer numberOfResolved, Integer numberOfUnresolved, Integer numberOfPlanned, float planned, float progress, float idealProgress, String doneAsString, String todoAsString, String plannedAsString, String idealProgressAsString, String progressAsString)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/planning/PlanStatistics.html

Parameterized constructor to initialize all fields of PlanStatistics.

```APIDOC
## PlanStatistics(float done, float todo, Integer numberOfResolved, Integer numberOfUnresolved, Integer numberOfPlanned, float planned, float progress, float idealProgress, String doneAsString, String todoAsString, String plannedAsString, String idealProgressAsString, String progressAsString)

### Description
Parameterized constructor to initialize all fields of PlanStatistics.

### Method
Constructor

### Signature
`public PlanStatistics(float done, float todo, Integer numberOfResolved, Integer numberOfUnresolved, Integer numberOfPlanned, float planned, float progress, float idealProgress, String doneAsString, String todoAsString, String plannedAsString, String idealProgressAsString, String progressAsString)`

### Parameters
- `done` (float) - The done value.
- `todo` (float) - The todo value.
- `numberOfResolved` (Integer) - The number of resolved items.
- `numberOfUnresolved` (Integer) - The number of unresolved items.
- `numberOfPlanned` (Integer) - The number of planned items.
- `planned` (float) - The planned value.
- `progress` (float) - The progress value.
- `idealProgress` (float) - The ideal progress value.
- `doneAsString` (String) - The done value as string.
- `todoAsString` (String) - The todo value as string.
- `plannedAsString` (String) - The planned value as string.
- `idealProgressAsString` (String) - The ideal progress value as string.
- `progressAsString` (String) - The progress value as string.

```

--------------------------------

### loginWithAutocreate(String userName, String credentials, String source)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/projects/IAutocreateManager.html

Performs a login operation with automatic user creation. Takes a user name, credentials, and a source string. Throws an Exception on failure.

```APIDOC
## loginWithAutocreate(String userName, String credentials, String source)

### Description
Performs a login operation with automatic user creation.

### Method
loginWithAutocreate

### Signature
Subject loginWithAutocreate(String userName, String credentials, String source) throws Exception

### Parameters
- **userName** (String) - Required - The user name for login.
- **credentials** (String) - Required - The credentials (e.g., password) for authentication.
- **source** (String) - Required - The source of the login request.

### Returns
- **Subject** - The authenticated subject after successful login.

### Throws
- **Exception** - If the login operation fails.

```

--------------------------------

### startExport(IExporterDescriptor, IExportConfiguration)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/exporter/IExportManager.html

Starts the export.

```APIDOC
## startExport(IExporterDescriptor, IExportConfiguration)

### Description
Starts the export.

### Method
startExport

### Parameters
- **exporterDescriptor** (IExporterDescriptor) - Required - The exporter descriptor.
- **config** (IExportConfiguration) - Required - The export configuration.

### Returns
IExport - The started export.
```

--------------------------------

### IProject.getLead()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/projects/model/class-use/IUser.html

Returns the lead of the project.

```APIDOC
## IProject.getLead()

### Description
Returns the lead of the project.

### Method
getLead

### Returns
- **IUser** - The lead of the project.
```

--------------------------------

### getFromDate()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/calendar/IWorkingDay.html

Returns the range start date.

```APIDOC
## getFromDate()

### Description
Returns the range start date.

### Method
`long getFromDate()`

### Returns
- `long` - the range start
```

--------------------------------

### startPulling()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/service/repository/IRepositoryService.html

Internal API, do not use. Available since version 3.8.0.

```APIDOC
## startPulling()

### Description
Internal API, do not use. Available since version 3.8.0.

### Method
void startPulling()

### Since
3.8.0
```

--------------------------------

### getPlan(String uri)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/planning/PlanningWebService.html

Loads a plan by its SubterraURI. Returns the plan object.

```APIDOC
## getPlan(String uri)

### Description
Loads a plan by its SubterraURI.

### Method
Java method

### Endpoint
PlanningWebService.getPlan

### Parameters
- `uri` (String) - Required - The SubterraURI of the plan to load.

### Returns
- `Plan` - the plan

### Throws
- `RemoteException`

### Since
3.8.0
```

--------------------------------

### PlanRecord(WorkItem)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-16.html

Constructor for class com.polarion.alm.ws.client.types.planning.PlanRecord.

```APIDOC
## Constructor: PlanRecord(WorkItem)

### Description
Constructor for class com.polarion.alm.ws.client.types.planning.PlanRecord.

### Parameters
- **WorkItem** - Description not provided.

```

--------------------------------

### getUserName() - IPassword

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Get user name.

```APIDOC
## getUserName()

### Description
Get user name.

### Method
GET

### Interface
com.polarion.platform.security.login.IPassword

### Returns
User name string.
```

--------------------------------

### main(String[] args)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/shutdown/client/ShutdownServiceClient.html

Static method that serves as the entry point for the shutdown service client. It expects command-line arguments: hostname, port, and catchPhrase.

```APIDOC
## main(String[] args)

### Description
Static method that serves as the entry point for the shutdown service client. It expects command-line arguments: hostname, port, and catchPhrase.

### Method
`public static void main(String[] args)`

### Parameters
- **args** (String[]) - Required - Command-line arguments: hostname, port, catchPhrase.

### Throws
- `Exception` - If an error occurs during shutdown service invocation.

### Usage
`hostname port catchPhrase`
```

--------------------------------

### getUserByUri(String) - ProjectWebService

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets an user.

```APIDOC
## getUserByUri(String)

### Description
Gets an user.

### Method
GET

### Interface
com.polarion.alm.ws.client.projects.ProjectWebService

### Parameters
- **uri** (String) - The URI of the user.

### Returns
User object.
```

--------------------------------

### ParametersAndDefinitions(ParameterDefinition[], Parameter[])

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/testmanagement/ParametersAndDefinitions.html

Constructor that initializes the object with the given parameter definitions and parameters.

```APIDOC
## ParametersAndDefinitions(ParameterDefinition[], Parameter[])

### Description
Constructor that initializes the object with the given parameter definitions and parameters.

### Method
Constructor

### Signature
public ParametersAndDefinitions(ParameterDefinition[] parameterDefinitions, Parameter[] parameters)

### Parameters
- **parameterDefinitions** (ParameterDefinition[]) - Required - The array of parameter definitions.
- **parameters** (Parameter[]) - Required - The array of parameters.

```

--------------------------------

### getTokenType() - IToken

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Get token type.

```APIDOC
## getTokenType()

### Description
Get token type.

### Method
GET

### Interface
com.polarion.platform.security.login.IToken

### Returns
- String - The token type.
```

--------------------------------

### enableEasyPlanningInProject(String projectId)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/IPlanningManager.html

Copies default configurations for Plans to the project.

```APIDOC
## enableEasyPlanningInProject(String projectId)

### Description
Copies default configurations for Plans to the project.

### Method
enableEasyPlanningInProject

### Parameters
- **projectId** (String) - Required - The ID of the project to copy default configurations to.

### Returns
List<String> - List of created plan IDs or similar result
```

--------------------------------

### enableEasyPlanningInProject

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/IPlanningManager.html

Copies default configurations for Plans to the project. Returns a list of report messages.

```APIDOC
## enableEasyPlanningInProject

### Description
Copies default configurations for Plans to the project.

### Method
enableEasyPlanningInProject

### Signature
@NotNull List<String> enableEasyPlanningInProject(@NotNull String projectId)

### Parameters
- `projectId` (String) - Required - ID of the project

### Returns
- `List<String>` - list of report messages. Each subprocess generates report message (successful or error).

### Since
3.8.0
```

--------------------------------

### getTargetDirectory() - LocalDeploymentDefinition

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Get target directory.

```APIDOC
## getTargetDirectory()

### Description
Get target directory.

### Method
GET

### Class
com.polarion.alm.builder.spi.LocalDeploymentDefinition

### Returns
String - The target directory.
```

--------------------------------

### getTargetDirectory() - ILocalDeploymentDefinition

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Get target directory.

```APIDOC
## getTargetDirectory()

### Description
Get target directory.

### Method
GET

### Interface
com.polarion.alm.builder.model.ILocalDeploymentDefinition

### Returns
String - The target directory.
```

--------------------------------

### createBaseline(String name, String description, String revision, IUser author)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/tracker/IBaselinesManager.html

Creates a project baseline. The baseline is not saved; users must call IPObject.save() manually.

```APIDOC
## createBaseline(String name, String description, String revision, IUser author)

### Description
Creates a project baseline. The baseline is not saved; users must call `IPObject.save()` manually.

### Method
`IBaseline createBaseline(String name, String description, String revision, IUser author)`

### Parameters
- `name` (String) - Required - Baseline name that will be rendered to users.
- `description` (String) - Required - Baseline description that will be rendered to users.
- `revision` (String) - Required - The revision for the baseline.
- `author` (IUser) - Required - The author of the baseline.

### Returns
`IBaseline` - the baseline object with the given content.
```

--------------------------------

### getRoles() - IAction

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the roles of an action.

```APIDOC
## getRoles()

### Description
Gets the roles of an action.

### Method
GET

### Endpoint
IAction.getRoles()

### Response
Returns the roles.
```

--------------------------------

### getRole() - RtLink

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the role of an RtLink.

```APIDOC
## getRole()

### Description
Gets the role of an RtLink.

### Method
GET

### Endpoint
RtLink.getRole()

### Response
Returns the role.
```

--------------------------------

### LicenseInfo(String license, int slots)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/security/LicenseInfo.html

Constructor that initializes a LicenseInfo with the given license string and slot count.

```APIDOC
## LicenseInfo(String license, int slots)

### Description
Constructor that initializes a LicenseInfo with the given license string and slot count.

### Method
Constructor

### Signature
`public LicenseInfo(String license, int slots)`

### Parameters
- `license` (String) - Required - The license value.
- `slots` (int) - Required - The number of slots.

```

--------------------------------

### fromConfigs(ILdapSecurityConfiguration... configurations)

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/projects/ldap/ILdapSyncBuilder.IWithType.html

Synchronize using several directly provided instances of LDAP configuration.

```APIDOC
## fromConfigs(ILdapSecurityConfiguration... configurations)

### Description
Synchronize using several directly provided instances of LDAP configuration.

### Parameters
- **configurations** (ILdapSecurityConfiguration...) - Required - List of configurations to synchronize.

### Returns
- **T** - delegating instance of ILdapSynchronization. It delegates all calls to every instance of ILdapSynchronization delegate.
```

--------------------------------

### getProperties() - Property

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the properties of the property.

```APIDOC
## getProperties()

### Description
Gets the properties of the property.

### Method
GET

### Class
com.polarion.qcentre.factbase.Property

### Returns
Map<String, String> - The properties.
```

--------------------------------

### getProjectId() - RtCollectionContext

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the project ID.

```APIDOC
## getProjectId()

### Description
Gets the project ID.

### Method
GET

### Endpoint
com.siemens.polarion.rt.collectors.api.RtCollectionContext#getProjectId()

### Parameters
None

### Response
#### Success Response
- **projectId** - The project ID.
```

--------------------------------

### Plan()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/alm/ws/client/types/planning/Plan.html

Default constructor for the Plan class.

```APIDOC
## Plan()

### Description
Default constructor for the Plan class.

### Method
Constructor

### Signature
`Plan()`

```

--------------------------------

### getProjectId() - RtFileProperties

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/index-files/index-7.html

Gets the project ID.

```APIDOC
## getProjectId()

### Description
Gets the project ID.

### Method
GET

### Endpoint
com.siemens.polarion.rt.collectors.api.model.RtFileProperties#getProjectId()

### Parameters
None

### Response
#### Success Response
- **projectId** - The project ID.
```

--------------------------------

### startForcePulling()

Source: https://testdrive.polarion.com/polarion/sdk/doc/javadoc/com/polarion/platform/service/repository/IRepositoryService.html

Internal API, do not use. Available since version 3.25.6.

```APIDOC
## startForcePulling()

### Description
Internal API, do not use. Available since version 3.25.6.

### Method
void startForcePulling()

### Since
3.25.6
```
Tokens:
Raw