com.arcway.cockpit.docgen.provider.interfaces

Interface IConfiguredProject

public interface IConfiguredProject

Configured Project.

Method Summary

Modifier and Type	Method and Description
boolean	commit(java.lang.String modificationComment) Trys to perform a commit.
void	deleteFromClient() Deletes this project from client.
void	discard() Discards the local changes.
java.lang.String	getProjectName() Returns the name of the project.
java.util.Collection<IPermission>	getProjectPermissions() Returns all server permissions related to this project.
java.util.Map<java.lang.String,com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider>	getProjectRelatedReportDataProviders() Returns all data providers of this project.
java.util.Map<java.lang.String,com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider>	getProjectRelatedReportDataProvidersWithoutFilter() Returns all data providers of this project.
java.lang.String	getProjectUID() Returns the project's UID.
IConfiguredServerConnection	getServerConnection() Returns the related server connection of this project.
boolean	hasChanges() Returns true if this project currently is open and has local modifications.
boolean	isCommittable() Returns true if the project is committable (or discardable), i.e. if the project has changes and the edition allows to commit.
boolean	isOpen() Determines if this project is currently open.
boolean	open() Opens the project.

Method Detail

getServerConnection

IConfiguredServerConnection getServerConnection()

Returns the related server connection of this project.

Returns:

server connection

getProjectUID

java.lang.String getProjectUID()

Returns the project's UID.

Returns:

project UID

getProjectName

java.lang.String getProjectName()

Returns the name of the project.

Note: This name is up to date only if the project is currently open.

Returns:

the project's name

isOpen

boolean isOpen()

Determines if this project is currently open.

Returns:

true if open, false if not

open

boolean open()

Opens the project.

Must be called only if the project is closed.

Returns:

true in case of success

getProjectRelatedReportDataProviders

java.util.Map<java.lang.String,com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider> getProjectRelatedReportDataProviders()

Returns all data providers of this project.

Note: The project must be open to perform this operation!

Returns:

all project data providers

getProjectRelatedReportDataProvidersWithoutFilter

java.util.Map<java.lang.String,com.arcway.cockpit.docgen.provider.IProjectRelatedReportProvider> getProjectRelatedReportDataProvidersWithoutFilter()

Returns all data providers of this project.

Note: The project must be open to perform this operation!

Returns:

all project data providers (without filters being set)

hasChanges

boolean hasChanges()

Returns true if this project currently is open and has local modifications.

Returns:

true if open and modified, false otherwise

isCommittable

boolean isCommittable()

Returns true if the project is committable (or discardable), i.e. if the project has changes and the edition allows to commit.

Returns:

true if committable, false if not

commit

boolean commit(java.lang.String modificationComment)

Trys to perform a commit.

In case the commit fails due to some user reasons (e.g. unsaved editors), the method returns false. In case the commit fails due to some technical reasons (e.g. server timed out), the method throws an exception. In case the commit is successful, the method returns true.

Parameters:

modificationComment - commit comment (null to ask user)

Returns:

true in case of success

discard

void discard()

Discards the local changes.

In case the discardal fails due to some technical reasons (e.g. server timed out), the method throws an exception.

NOTE: After discarding, all report data providers of the project are invalid and need to be refetched calling getProjectRelatedReportDataProviders()!

deleteFromClient

void deleteFromClient()

Deletes this project from client. The project must not have changes.

getProjectPermissions

java.util.Collection<IPermission> getProjectPermissions()

Returns all server permissions related to this project.

Returns:

never null