ProjectServerSaveOptions
Inheritance: java.lang.Object
public final class ProjectServerSaveOptions
Allows to specify additional options when project is saved to Project Server or Project Online.
Constructors
| Constructor | Description |
|---|---|
| ProjectServerSaveOptions() | Initializes a new instance of the ProjectServerSaveOptions class. |
Methods
| Method | Description |
|---|---|
| getPollingInterval() | Gets interval between queue job status requests. |
| getProjectGuid() | Gets unique identifier of a project. |
| getProjectName() | Gets name of a project which is displayed in Project Server \ Project Online projects list. |
| getTimeout() | Gets timeout used when waiting for processing of save project request by a Project Server’s queue processing service. |
| setPollingInterval(double value) | Sets interval between queue job status requests. |
| setProjectGuid(UUID value) | Sets unique identifier of a project. |
| setProjectName(String value) | Sets name of a project which is displayed in Project Server \ Project Online projects list. |
| setTimeout(double value) | Sets timeout used when waiting for processing of save project request by a Project Server’s queue processing service. |
ProjectServerSaveOptions()
public ProjectServerSaveOptions()
Initializes a new instance of the ProjectServerSaveOptions class.
getPollingInterval()
public final double getPollingInterval()
Gets interval between queue job status requests. The default value is 2 seconds.
Returns: double - interval between queue job status requests.
getProjectGuid()
public final UUID getProjectGuid()
Gets unique identifier of a project. Should be unique within Project Server \ Project Online instance.
Returns: java.util.UUID - unique identifier of a project.
getProjectName()
public final String getProjectName()
Gets name of a project which is displayed in Project Server \ Project Online projects list. Should be unique within Project Server \ Project Online instance. Is the value is omitted, the value of Prj.Name property will be used instead.
Returns: java.lang.String - name of a project which is displayed in Project Server \ Project Online projects list.
getTimeout()
public final double getTimeout()
Gets timeout used when waiting for processing of save project request by a Project Server’s queue processing service. The default value for this property is 1 minute.
The processing time may be longer for large projects or in case when Project Server instance is too busy responding to other requests.
Returns: double - timeout used when waiting for processing of save project request by a Project Server’s queue processing service.
setPollingInterval(double value)
public final void setPollingInterval(double value)
Sets interval between queue job status requests. The default value is 2 seconds.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | interval between queue job status requests. |
setProjectGuid(UUID value)
public final void setProjectGuid(UUID value)
Sets unique identifier of a project. Should be unique within Project Server \ Project Online instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.util.UUID | unique identifier of a project. |
setProjectName(String value)
public final void setProjectName(String value)
Sets name of a project which is displayed in Project Server \ Project Online projects list. Should be unique within Project Server \ Project Online instance. Is the value is omitted, the value of Prj.Name property will be used instead.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | name of a project which is displayed in Project Server \ Project Online projects list. |
setTimeout(double value)
public final void setTimeout(double value)
Sets timeout used when waiting for processing of save project request by a Project Server’s queue processing service. The default value for this property is 1 minute.
The processing time may be longer for large projects or in case when Project Server instance is too busy responding to other requests.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double | timeout used when waiting for processing of save project request by a Project Server’s queue processing service. |