com.arcway.cockpit.docgen.provider.interfaces

Interface IProjectOnServer

public interface IProjectOnServer

Provides information and functions related to a project on a server.

Method Summary

Modifier and Type	Method and Description
IConfiguredProject	fetchProjectFromServer() Fetches this project from server.
java.lang.String	getProjectDumpAsFileName(java.lang.String fileNamePrefix, int timeOutInSeconds) Retrieves a project dump file from the server and returns the local file name.
java.lang.String	getProjectName() Returns a string representation of the project's name.
java.lang.String	getProjectUID() Returns the project UID.
IConfiguredServerConnection	getServerConnection() Returns the server connection to the server on which this project is stored.

Method Detail

getServerConnection

IConfiguredServerConnection getServerConnection()

Returns the server connection to the server on which this project is stored.

Returns:

server connection

getProjectUID

java.lang.String getProjectUID()

Returns the project UID.

Returns:

project UID

getProjectName

java.lang.String getProjectName()

Returns a string representation of the project's name. The string is HTML encoded and can be inserted into the template without further transformation.

Returns:

project name

fetchProjectFromServer

IConfiguredProject fetchProjectFromServer()

Fetches this project from server.

The project may be opened or closed. If the project is already present on the client, this method returns the corresponding project.

Returns:

the configured project (null in case of error, details are logged into the client logfile)

getProjectDumpAsFileName

java.lang.String getProjectDumpAsFileName(java.lang.String fileNamePrefix,
                                          int timeOutInSeconds)

Retrieves a project dump file from the server and returns the local file name. The dump is loaded from the server and stored in a temporary directory. The file can be accessed during document generation. It will not be available anymore from the target output.

Parameters:

fileNamePrefix - prefix that is added to the file name

timeOutInSeconds - time out in seconds (0 for no timeout)

Returns:

absolute path name of the file (null in case of error, details are logged into the client logfile)