LoadOptions
Inheritance: java.lang.Object
public class LoadOptions
Allows to specify additional load parameters when loading a project from file or stream.
Constructors
| Constructor | Description |
|---|---|
| LoadOptions() | Initializes a new instance of the LoadOptions class. |
Methods
| Method | Description |
|---|---|
| getCancellationToken() | Gets a token which can be used to cancel a project loading operation. |
| getEncoding() | Gets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |
| getErrorHandler() | Gets a callback method to handle xml parse errors. |
| getPassword() | Gets a protection password. |
| getPrimaveraReadOptions() | Gets a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml). |
| getProjectLoadingCallback() | Gets the callback to be invoked during project loading operations. |
| setCancellationToken(CancellationToken value) | Sets a token which can be used to cancel a project loading operation. |
| setEncoding(Charset value) | Sets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |
| setErrorHandler(ParseErrorCallback value) | Sets a callback method to handle xml parse errors. |
| setPassword(String value) | Sets a protection password. |
| setPrimaveraReadOptions(PrimaveraReadOptions value) | Sets a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml). |
| setProjectLoadingCallback(IProgressNotificationCallback value) | Sets the callback to be invoked during project loading operations. |
LoadOptions()
public LoadOptions()
Initializes a new instance of the LoadOptions class.
getCancellationToken()
public final CancellationToken getCancellationToken()
Gets a token which can be used to cancel a project loading operation.
Returns: CancellationToken - a token which can be used to cancel a project loading operation.
getEncoding()
public final Charset getEncoding()
Gets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. The default encoding is UTF8.
Returns: java.nio.charset.Charset - encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats.
getErrorHandler()
public final ParseErrorCallback getErrorHandler()
Gets a callback method to handle xml parse errors.
Returns: ParseErrorCallback - a callback method to handle xml parse errors.
getPassword()
public final String getPassword()
Gets a protection password.
Returns: java.lang.String - a protection password.
getPrimaveraReadOptions()
public final PrimaveraReadOptions getPrimaveraReadOptions()
Gets a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml).
Returns: PrimaveraReadOptions - a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml).
getProjectLoadingCallback()
public final IProgressNotificationCallback getProjectLoadingCallback()
Gets the callback to be invoked during project loading operations. Currently supported for MPP format.
Returns: IProgressNotificationCallback - the callback to be invoked during project loading operations.
setCancellationToken(CancellationToken value)
public final void setCancellationToken(CancellationToken value)
Sets a token which can be used to cancel a project loading operation.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | CancellationToken | a token which can be used to cancel a project loading operation. |
setEncoding(Charset value)
public final void setEncoding(Charset value)
Sets encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. The default encoding is UTF8.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.nio.charset.Charset | encoding which is used to read a project from HTML, MPX, XER and Primavera XML formats. |
setErrorHandler(ParseErrorCallback value)
public final void setErrorHandler(ParseErrorCallback value)
Sets a callback method to handle xml parse errors.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ParseErrorCallback | a callback method to handle xml parse errors. |
setPassword(String value)
public final void setPassword(String value)
Sets a protection password.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | a protection password. |
setPrimaveraReadOptions(PrimaveraReadOptions value)
public final void setPrimaveraReadOptions(PrimaveraReadOptions value)
Sets a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | PrimaveraReadOptions | a specified instance of the PrimaveraReadOptions class which can be used to customize the behavior of loading Primavera formats (Primavera P6 XER or Primavera P6 Xml). |
setProjectLoadingCallback(IProgressNotificationCallback value)
public final void setProjectLoadingCallback(IProgressNotificationCallback value)
Sets the callback to be invoked during project loading operations. Currently supported for MPP format.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | IProgressNotificationCallback | the callback to be invoked during project loading operations. |
