Uses of Interface
de.espirit.firstspirit.access.project.Project
Package
Description
-
Uses of Project in de.espirit.firstspirit.access
Modifier and TypeMethodDescription@Nullable Project
Host.getProject()
Task.getProject()
Get projectUserService.getProject()
Returns the project this userservice belongs to.@Nullable Project
Connection.getProjectById
(long id) Return a project with a specific id ornull
if no project exists with the given id or the project is not visible for the current user.@Nullable Project
Connection.getProjectByName
(String name) Return a project with a specific name ornull
if no project exists with the specified name.Project[]
Connection.getProjects()
Get all active projects allowed for the current user.
Checks if the current user is server admin and is allowed to edit a project using java client or webedit.
UseProjectStorage.getProjects(boolean)
to get projects unfiltered.Modifier and TypeMethodDescriptionstatic Language
AccessUtil.getLanguageForKey
(Project project, String languageKey) Gets a single project language by its unique abbreviation.static @NotNull Language
AccessUtil.getLanguageForKeyNotNull
(Project project, String languageKey) Gets a single project language by its unique abbreviation.boolean
User.isProjectAdmin
(@Nullable Project project) Tests if this user project admin for the provided project.
By default aserver admin
isproject admin of all projects. -
Uses of Project in de.espirit.firstspirit.access.admin
Modifier and TypeMethodDescription@NotNull Project
ProjectStorage.createProject
(String name, String description) Create a new Project.@Nullable Project
ProjectStorage.getProject
(long id) Returns the project by id, regardless whether it's active or not.@Nullable Project
ProjectStorage.getProject
(String name) Returns the project by name, regardless whether it's active or not.Quickstart.getProject()
Returns the project this quickstart configuration is related to.Project[]
ProjectStorage.getProjects()
Returns all (active and inactive) projects.Project[]
ProjectStorage.getProjects
(boolean active) Returns either all active or inactive projects.Modifier and TypeMethodDescriptionProjectStorage.getFontUsages
(String name) Returns a list ofprojects
using the font specified by the given name.Modifier and TypeMethodDescriptionvoid
ProjectStorage.activateProject
(Project project) Activates a deactivated project.ProjectStorage.checkProject
(Project project) Checks if a project needs to be migrated to current server version.void
ProjectStorage.deactivateProject
(Project project) Deactivates a project.void
ProjectStorage.rebuildReferences
(Project project) Deprecated.void
ProjectStorage.rebuildSearchIndex
(Project project) Since FirstSpirit v5 this starts the project schedule entry with the name "Rebuild search index".void
ProjectStorage.removeProject
(Project project) Removes a project from server.void
ProjectStorage.removeProject
(Project project, boolean cleanDB) Removes a project from server and deletes the connected database too if cleanDB is set to truevoid
ProjectStorage.updateVersionInfo
(Project project) Updates the project information to match the current server version. -
Uses of Project in de.espirit.firstspirit.access.packagepool
Modifier and TypeMethodDescription@Nullable Project
Package.getPublisher()
Gets theProject
that is the package's owner.@Nullable Project
Subscription.getSubscriber()
Returns the subscriberProject
of this subscription.
The update of this subscription will be imported into the subscriber project.Modifier and TypeMethodDescriptionPackageManager.createContentPackage
(String name, Project project) Creates a new content package with the given name and the given project as master project.PackageManager.createTemplatePackage
(String name, Project project) Creates a new template package with the given name and the given project as master project.PackageManager.getPackages
(Project masterProject) Returns a read-only list of all existingPackage
's for which the given project is master project@Nullable Subscription
PackageManager.getSubscription
(Package pck, Project project) Returns the subscription instance for the given package and project, ornull
if there is no subscription of this package in the provided project.Package.subscribePackage
(Project subscriber) Creates a newSubscription
to this package from the givenProject
.
TheSubscription
is created with the defaultPublishGroup
.Package.subscribePackage
(Project subscriber, PublishGroup publishGroup) -
Uses of Project in de.espirit.firstspirit.access.project
Modifier and TypeMethodDescriptionProjectScriptContext.getProject()
Return theProject
of the current script context -
Uses of Project in de.espirit.firstspirit.access.schedule
Modifier and TypeMethodDescription@Nullable Project
ScheduleContext.getProject()
Returns the project the currently running schedule entry belongs to.@Nullable Project
ScheduleEntry.getProject()
Returns the project forproject specific
tasks ornull
if it is a non project related entry@Nullable Project
ScheduleTaskTemplate.getProject()
Returns theProject
ornull
if the schedule task template is server scoped.Modifier and TypeMethodDescriptionMaintenanceModeTask.getMaintenanceProjects()
All projects affected by the maintenance task.Modifier and TypeMethodDescription@NotNull ScheduleEntry
ScheduleStorage.copyScheduleEntry
(@NotNull ScheduleEntry scheduleEntry, @Nullable Project project) Copies the givenscheduleEntry
to another project or to server scoped, ifproject
isnull
.@NotNull ScheduleEntry
ScheduleStorage.createScheduleEntry
(@NotNull String scheduleEntryName, @Nullable Project project) Creates a new schedule entry for the provided project.@NotNull List<ScheduleEntryControl>
ScheduleStorage.getHistory
(Date from, Date until, int maxCount, @NotNull Project project) Get the execution history of schedule entries of the given project.@NotNull List<ScheduleEntry>
ScheduleStorage.getScheduleEntries
(@NotNull Project project) Returns a list of schedule entries depending to givenproject
.@Nullable ScheduleEntry
ScheduleStorage.getScheduleEntry
(@NotNull Project project, String name) Returns the specified schedule entry ornull
if it couldn't be found.@NotNull List<ScheduleTaskTemplate>
ScheduleStorage.getScheduleTaskTemplates
(@Nullable Project project) Returns a list of all schedule task templates for givenproject
.void
ScheduleEntry.setProject
(@Nullable Project project) Sets the project, if the schedule entry should be related to it.void
ScheduleTaskTemplate.setProject
(@Nullable Project project) Setproject
to make the schedule task template project scoped ornull
for server scoped.Modifier and TypeMethodDescriptionvoid
MaintenanceModeTask.setMaintenanceProjects
(@NotNull Collection<Project> projects) Specifies the projects which are affected by the maintenance task. -
Uses of Project in de.espirit.firstspirit.access.search
-
Uses of Project in de.espirit.firstspirit.access.store
Modifier and TypeMethodDescriptionStore.getProject()
StoreElement.getProject()
Returns the belonging project of this storeelement. -
Uses of Project in de.espirit.firstspirit.agency
Modifier and TypeMethodDescription@NotNull Collection<Project>
ModuleAdminAgent.getProjectAppUsages
(String moduleName, String projectAppName) Returns ids of all projects using the specified project application.@NotNull Collection<Project>
ModuleAdminAgent.ModuleResult.getUpdatedProjectApps()
Returns the projects where project-app components are updated.Modifier and TypeMethodDescriptionstatic ProjectWebAppId
WebAppId.Factory.create
(Project project, WebEnvironment.WebScope webScope) Creates a project-local web-app identifier.@NotNull FileSystem<?>
ModuleAdminAgent.getProjectAppConfig
(String moduleName, String projectAppName, @NotNull Project project) Returns an access to the project-app configuration directory; read-write-access if the user is project admin, read-only-access if the user is project user, otherwise aSecurityException
will be thrown.void
ModuleAdminAgent.installProjectApp
(String moduleName, String projectAppName, @NotNull Project project) Installs or updates a project application to the specified project.Provide the project that should be opened.
Note: If anelement is provided
, this setting will take no effect.void
ModuleAdminAgent.uninstallProjectApp
(String moduleName, String projectAppName, @NotNull Project project) Removes the project application from the specified project. -
Uses of Project in de.espirit.firstspirit.module
Modifier and TypeMethodDescription@Nullable Project
ProjectEnvironment.getProject()
Returns project.
ProjectReferencesAgent.rebuildReferences()
.