de.espirit.firstspirit.agency

Interface ProjectAgent

public interface ProjectAgent

Definition of an agent offering access to project specific information. To retrieve information about remote projects, a SpecialistsBroker operating on the respective remote project can be requested via the BrokerAgent.

Example:
SpecialistsBroker.requireSpecialist(ProjectAgent.TYPE)

Since:

4.2.405

See Also:

BrokerAgent

Field Summary

Fields

Modifier and Type	Field and Description
static SpecialistType<ProjectAgent>	TYPE The agent's technical type to be used to request the agent from a SpecialistsBroker.

Method Summary

Methods

Modifier and Type	Method and Description
long	getId() The id of the project.
Template	getMetaDataTemplate() Provides the meta data template.
String	getName() The full name of the project.
Map<String,RemoteProjectConfiguration>	getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> remoteCondition) Get the configurations of remote projects defined.
String	getSymbolicName() The symbolic name of the remote configuration this project is registered for.
List<TemplateSet>	getTemplateSets() Get a list of available template sets.
boolean	hasMetaDataTemplate() Indicates, whether a meta data template is defined in this project.
boolean	isAdmin(User user) Indicates, whether the given user is an administrator of the project.
boolean	isRemote() Indicates that the project is remote.
boolean	useRelease() Returns true if this project uses the release state, false if it is an auto release project.

Field Detail

TYPE

static final SpecialistType<ProjectAgent> TYPE

The agent's technical type to be used to request the agent from a SpecialistsBroker.

Since:

4.2.405

Method Detail

isRemote

boolean isRemote()

Indicates that the project is remote.

Returns:

true, if remote.

Since:

4.2.405

getName

String getName()

The full name of the project.

Returns:

The project's name.

Since:

4.2.405

getId

long getId()

The id of the project.

Returns:

the id of the project

Since:

4.2.427

getSymbolicName

String getSymbolicName()

The symbolic name of the remote configuration this project is registered for.

Returns:

The project's symbolic remote name.

Since:

4.2.405

getRemoteProjectConfigurations

@NotNull
Map<String,RemoteProjectConfiguration> getRemoteProjectConfigurations(@Nullable
                                                                            Filter<RemoteProjectConfiguration> remoteCondition)

Get the configurations of remote projects defined.

Parameters:

remoteCondition - The condition to be fulfilled for accepting a remote project or null for unconditioned acceptance.

Returns:

A map of remote project configurations with their symbolic names as key.

Since:

4.2.405

getTemplateSets

@NotNull
List<TemplateSet> getTemplateSets()

Get a list of available template sets.

Returns:

A list of template sets.

Since:

4.2.405

hasMetaDataTemplate

boolean hasMetaDataTemplate()

Indicates, whether a meta data template is defined in this project.

Returns:

true, iff a meta data template is defined.

Since:

5.0.100

getMetaDataTemplate

@NotNull
Template getMetaDataTemplate()
                             throws NoSuchElementException

Provides the meta data template.

Returns:

The meta data template or null, if no template is defined.

Throws:

NoSuchElementException - If no template is defined or the template was not found.

Since:

5.0.100

useRelease

boolean useRelease()

Returns true if this project uses the release state, false if it is an auto release project.

Returns:

false if it is an auto release project, true otherwise

Since:

4.2.405

isAdmin

boolean isAdmin(User user)

Indicates, whether the given user is an administrator of the project.

Parameters:

user - A user.

Returns:

true, if the user is a project administrator.

Since:

5.1.9

See Also:

User, UserAgent