Uses of Interface
de.espirit.firstspirit.access.project.Project
Packages that use Project
Package
Description
-
Uses of Project in de.espirit.firstspirit.access
Methods in de.espirit.firstspirit.access that return ProjectModifier and TypeMethodDescription@Nullable ProjectHost.getProject()Task.getProject()Get projectUserService.getProject()Returns the project this userservice belongs to.@Nullable ProjectConnection.getProjectById(long id) Return a project with a specific id ornullif no project exists with the given id or the project is not visible for the current user.@Nullable ProjectConnection.getProjectByName(String name) Return a project with a specific name ornullif 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.Methods in de.espirit.firstspirit.access with parameters of type ProjectModifier and TypeMethodDescriptionstatic LanguageAccessUtil.getLanguageForKey(Project project, String languageKey) Gets a single project language by its unique abbreviation.static @NotNull LanguageAccessUtil.getLanguageForKeyNotNull(Project project, String languageKey) Gets a single project language by its unique abbreviation.booleanUser.isProjectAdmin(@Nullable Project project) Tests if this user project admin for the provided project.
By default aserver adminis project admin of all projects. -
Uses of Project in de.espirit.firstspirit.access.admin
Methods in de.espirit.firstspirit.access.admin that return ProjectModifier and TypeMethodDescription@NotNull ProjectProjectStorage.createProject(String name, String description) Create a new Project.@Nullable ProjectProjectStorage.getProject(long id) Returns the project by id, regardless whether it's active or not.@Nullable ProjectProjectStorage.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.Methods in de.espirit.firstspirit.access.admin that return types with arguments of type ProjectModifier and TypeMethodDescriptionProjectStorage.getFontUsages(String name) Returns a list ofprojectsusing the font specified by the given name.Methods in de.espirit.firstspirit.access.admin with parameters of type ProjectModifier and TypeMethodDescriptionvoidProjectStorage.activateProject(Project project) Activates a deactivated project.ProjectStorage.checkProject(Project project) Checks if a project needs to be migrated to current server version.voidProjectStorage.deactivateProject(Project project) Deactivates a project.voidProjectStorage.rebuildReferences(Project project) Deprecated.voidProjectStorage.rebuildSearchIndex(Project project) Since FirstSpirit v5 this starts the project schedule entry with the name "Rebuild search index".voidProjectStorage.removeProject(Project project) Removes a project from server.voidProjectStorage.removeProject(Project project, boolean cleanDB) Removes a project from server and deletes the connected database too if cleanDB is set to truevoidProjectStorage.updateVersionInfo(Project project) Updates the project information to match the current server version. -
Uses of Project in de.espirit.firstspirit.access.packagepool
Methods in de.espirit.firstspirit.access.packagepool that return ProjectModifier and TypeMethodDescription@Nullable ProjectPackage.getPublisher()Gets theProjectthat is the package's owner.@Nullable ProjectSubscription.getSubscriber()Returns the subscriberProjectof this subscription.
The update of this subscription will be imported into the subscriber project.Methods in de.espirit.firstspirit.access.packagepool with parameters of type ProjectModifier 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 SubscriptionPackageManager.getSubscription(Package pck, Project project) Returns the subscription instance for the given package and project, ornullif there is no subscription of this package in the provided project.Package.subscribePackage(Project subscriber) Creates a newSubscriptionto this package from the givenProject.
TheSubscriptionis created with the defaultPublishGroup.Package.subscribePackage(Project subscriber, PublishGroup publishGroup) -
Uses of Project in de.espirit.firstspirit.access.project
Methods in de.espirit.firstspirit.access.project that return ProjectModifier and TypeMethodDescriptionProjectScriptContext.getProject()Return theProjectof the current script context -
Uses of Project in de.espirit.firstspirit.access.schedule
Methods in de.espirit.firstspirit.access.schedule that return ProjectModifier and TypeMethodDescription@Nullable ProjectScheduleContext.getProject()Returns the project the currently running schedule entry belongs to.@Nullable ProjectScheduleEntry.getProject()Returns the project forproject specifictasks ornullif it is a non project related entry@Nullable ProjectScheduleTaskTemplate.getProject()Returns theProjectornullif the schedule task template is server scoped.Methods in de.espirit.firstspirit.access.schedule that return types with arguments of type ProjectModifier and TypeMethodDescriptionMaintenanceModeTask.getMaintenanceProjects()All projects affected by the maintenance task.Methods in de.espirit.firstspirit.access.schedule with parameters of type ProjectModifier and TypeMethodDescription@NotNull ScheduleEntryScheduleStorage.copyScheduleEntry(@NotNull ScheduleEntry scheduleEntry, @Nullable Project project) Copies the givenscheduleEntryto another project or to server scoped, ifprojectisnull.@NotNull ScheduleEntryScheduleStorage.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 ScheduleEntryScheduleStorage.getScheduleEntry(@NotNull Project project, String name) Returns the specified schedule entry ornullif it couldn't be found.@NotNull List<ScheduleTaskTemplate>ScheduleStorage.getScheduleTaskTemplates(@Nullable Project project) Returns a list of all schedule task templates for givenproject.voidScheduleEntry.setProject(@Nullable Project project) Sets the project, if the schedule entry should be related to it.voidScheduleTaskTemplate.setProject(@Nullable Project project) Setprojectto make the schedule task template project scoped ornullfor server scoped.Method parameters in de.espirit.firstspirit.access.schedule with type arguments of type ProjectModifier and TypeMethodDescriptionvoidMaintenanceModeTask.setMaintenanceProjects(@NotNull Collection<Project> projects) Specifies the projects which are affected by the maintenance task. -
Uses of Project in de.espirit.firstspirit.access.search
Methods in de.espirit.firstspirit.access.search with parameters of type Project -
Uses of Project in de.espirit.firstspirit.access.store
Methods in de.espirit.firstspirit.access.store that return ProjectModifier and TypeMethodDescriptionStore.getProject()StoreElement.getProject()Returns the belonging project of this storeelement. -
Uses of Project in de.espirit.firstspirit.agency
Methods in de.espirit.firstspirit.agency that return ProjectMethods in de.espirit.firstspirit.agency that return types with arguments of type ProjectModifier 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.Methods in de.espirit.firstspirit.agency with parameters of type ProjectModifier and TypeMethodDescriptionstatic ProjectWebAppIdWebAppId.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 aSecurityExceptionwill be thrown.voidModuleAdminAgent.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.voidModuleAdminAgent.uninstallProjectApp(String moduleName, String projectAppName, @NotNull Project project) Removes the project application from the specified project. -
Uses of Project in de.espirit.firstspirit.module
Methods in de.espirit.firstspirit.module that return ProjectModifier and TypeMethodDescription@Nullable ProjectProjectEnvironment.getProject()Returns project.
ProjectReferencesAgent.rebuildReferences().