Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
S
- SATURDAY - Enum constant in enum class de.espirit.common.util.WeekDay
-
A week day.
- save() - Method in interface de.espirit.firstspirit.access.Lockable
-
Saves this object.
- save() - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup
-
Makes the changes persisten on the server.
- save() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Call to this method makes all changes to this subscription persistent on the server.
- save() - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Writes all changes made to this server configuration to the FirstSpirit server and saves the belonging configuration file.
- save() - Method in interface de.espirit.firstspirit.access.store.mediastore.Media
-
Save all changes made to media object.
- save() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef
-
Saves the node and all childs, shortcut for
save(null, true)
. - save() - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Saves the node and all childs, shortcut for
save(null, true)
. - save(String) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Saves the node and all childs.
- save(String, boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Saves this node.
- SaveOperation - Interface in de.espirit.firstspirit.store.operations
-
Operation to save a
store element
with defined options. - ScheduleContext - Interface in de.espirit.firstspirit.access.schedule
-
A context with access to schedule entry execution-related objects.
- ScheduleEntry - Interface in de.espirit.firstspirit.access.schedule
-
Defines a single entry for a job list of
tasks
to be scheduled. - ScheduleEntry.ParallelExecutionMode - Enum Class in de.espirit.firstspirit.access.schedule
-
The modes used to set the
ParallelExecutionMode
of this entry - ScheduleEntryControl - Interface in de.espirit.firstspirit.access.schedule
-
Provides information on a currently running or a historic schedule entry.
- ScheduleEntryRunningException - Exception in de.espirit.firstspirit.access.schedule
-
Thrown when a
ScheduleEntry
is started multiple times anditsScheduleEntry.ParallelExecutionMode
isScheduleEntry.ParallelExecutionMode.DISALLOWED
. - ScheduleEntryRunningException() - Constructor for exception de.espirit.firstspirit.access.schedule.ScheduleEntryRunningException
- ScheduleEntryState - Interface in de.espirit.firstspirit.access.schedule
-
Interface representing a schedule entry execution state.
- ScheduleEntryStatistic - Interface in de.espirit.firstspirit.access.schedule
-
Definition of a statistics container for a scheduled entry.
- ScheduleStorage - Interface in de.espirit.firstspirit.access.schedule
-
FirstSpirit storage for schedule management.
- ScheduleTask - Interface in de.espirit.firstspirit.access.schedule
-
A single task to be executed within a
scheduled job
. - ScheduleTaskTemplate - Interface in de.espirit.firstspirit.access.schedule
-
Schedule task templates can be used for project or server scoped actions.
- ScheduleTaskTestResult - Interface in de.espirit.firstspirit.access.schedule
-
Interface representing a schedule task test result.
- Schema - Interface in de.espirit.firstspirit.access.store.templatestore
-
Definition of a database schema description.
- SCHEMA_READ_ONLY - Enum constant in enum class de.espirit.firstspirit.access.Task.ErrorCode
-
Database schema is read-only.
- SchemaContainer - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface providing methods for elements which can have
schemas
as children. - SchemaFolder - Interface in de.espirit.firstspirit.access.store.templatestore
-
Definition of a container having schema entries.
- Schemes - Interface in de.espirit.firstspirit.access.store.templatestore
-
This interface represants the subroot for
schemas
in templatestore. - Script - Interface in de.espirit.firstspirit.access.store.templatestore
-
This interface provides methods to handle the scripts in the
TemplateStore
- SCRIPT_REFERENCE - Static variable in interface de.espirit.firstspirit.access.ReferenceEntry
-
script:"name", e.g. in $CMS_RENDER(script:"",
- ScriptContainer - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface providing methods for elements which can have
scripts
as children. - ScriptContext - Interface in de.espirit.firstspirit.access
-
Common properties
:
------------------
isWebClient (java.lang.Boolean) - since 4.2.404 - indicates whether this script context is executed in webclient or not.
(Note: This property has been deprecated with 5.0.12, use#isEnv(Env.WEBEDIT)
instead) - ScriptEngine - Interface in de.espirit.firstspirit.access.script
-
Type definition of a script engine.
- ScriptEngineRegistry - Interface in de.espirit.firstspirit.access.admin
-
Registry to handle the different script engines.
- ScriptFolder - Interface in de.espirit.firstspirit.access.store.templatestore
-
Definition of a container that holds scripts.
- Scripts - Interface in de.espirit.firstspirit.access.store.templatestore
-
This interface represants the subroot for
scripts
in templatestore. - ScriptTask - Interface in de.espirit.firstspirit.access.schedule
-
Definition of a task to execute a script.
- ScriptTask.Type - Enum Class in de.espirit.firstspirit.access.schedule
-
the script task
- search(Project, Request) - Method in interface de.espirit.firstspirit.access.search.SearchService
-
Initiates a search on data with the given request.
- search(R, String, int) - Method in interface de.espirit.firstspirit.service.treedata.TNodeProvider
-
Searches the given
text
. - SEARCH_DATA - Static variable in interface de.espirit.firstspirit.service.treedata.TNodeProvider
-
Search
flag: search data (like labels, properties, etc.). - SEARCH_EXACT - Static variable in interface de.espirit.firstspirit.service.treedata.TNodeProvider
-
Search
flag: enables exact search; default is a not-exact search. - SEARCH_ID - Static variable in interface de.espirit.firstspirit.service.treedata.TNodeProvider
-
Search
flag: search ids. - SearchService - Interface in de.espirit.firstspirit.access.search
-
Please consider using
QueryAgent
.
Service interface for searching within FIRSTspirit.
UsegetService(SearchService.class)
to request an instance of this service. - searchTasks(Long, TaskQuery) - Method in interface de.espirit.firstspirit.access.search.SearchService
-
Deprecated.since 4.1.10 - no replacement
- SECOND - Enum constant in enum class de.espirit.firstspirit.access.schedule.MonthlyExecutionSchedule.WeekOfMonth
-
The second week of the month.
- Section<T extends SectionTemplate> - Interface in de.espirit.firstspirit.access.store.pagestore
-
This interface provides methods to handle the sections of Pages in the PageStore.
- SECTION_KEY - Static variable in interface de.espirit.firstspirit.access.editor.ContentAreaListValue
-
Deprecated.Section entry key.
- SECTION_KEY - Static variable in interface de.espirit.firstspirit.access.editor.PageRefEditorValue
-
Deprecated.Key for the name of a referenced section.
- SECTION_KEY - Static variable in interface de.espirit.firstspirit.access.editor.ReferenceEditorValue
-
Deprecated.Key to store the name of a section referenced to.
- SECTION_TEMPLATE - Static variable in interface de.espirit.firstspirit.access.store.templatestore.Template
-
Type of the template: Section template.
- SECTION_TEMPLATE_REFERENCE - Static variable in interface de.espirit.firstspirit.access.editor.reference.Reference
-
Type string identifying a reference to a
SectionTemplate
- SectionList - Interface in de.espirit.firstspirit.access.editor.value
-
Deprecated.since 5.0.501 - usages of CMS_INPUT_CONTENTAREALIST should be replaced with
FS_CATALOG
. - SectionList.DataSheet - Interface in de.espirit.firstspirit.access.editor.value
-
Deprecated.since 5.2.21 - no replacement
- SectionListEntry - Interface in de.espirit.firstspirit.access.editor.value
-
Definition of a section as entry in a list.
- SectionReference<T extends SectionTemplate> - Interface in de.espirit.firstspirit.access.store.pagestore
-
Interface providing means to operate on section references.
- SectionTemplate - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface providing means to operate on section templates.
- SectionTemplates - Interface in de.espirit.firstspirit.access.store.templatestore
- Select - Interface in de.espirit.or.query
-
Model representing a Select statement to
query
entites from anor session. - SELECTION_KEY - Static variable in interface de.espirit.firstspirit.access.editor.OptionsEditorValue
-
Deprecated.Key for a single selection entry.
- SELECTION_KEY - Static variable in interface de.espirit.firstspirit.access.editor.TableTemplateProvider
-
Key to store the selection.
- SELECTION_VALUE_KEY - Static variable in interface de.espirit.firstspirit.access.editor.OptionsEditorValue
-
Deprecated.Key for the selection entry's value.
- SELECTION_VALUE_KEY - Static variable in interface de.espirit.firstspirit.access.editor.TableTemplateProvider
-
Key to store the selection's value.
- selectManualTransition(Transition) - Method in interface de.espirit.firstspirit.access.WorkflowContext
-
Select manual workflow transition parameters (show dialog).
- sendEMail(Activity, State) - Method in interface de.espirit.firstspirit.access.WorkflowContext
-
Called to send a email if a new task state is reached.
- sendEMail(Transition) - Method in interface de.espirit.firstspirit.access.WorkflowContext
-
Called to send a email on transition activation.
- sendEMail(String, String, String) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext
-
Sends an email to the defined receivers
- sender - Variable in class de.espirit.firstspirit.access.MailHeader
-
Deprecated.since 5.2.601 - use
MailHeader.Builder.sender(String)
andMailHeader.getSender()
instead - sender(String) - Method in class de.espirit.firstspirit.access.MailHeader.Builder
-
Sets the sender of this mail header.
- sendMail(MailHeader, String, String, Attachment...) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a mail using the given configured mail header.
- sendMail(MailHeader, String, String, String, boolean, Attachment...) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a mail using the given configured mail header and the set type of the message.
- sendMail(String, String, String) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a textual mail the set recipient(s), where the message is assumed to be of type "plain".
- sendMail(String, String, String, Attachment...) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a mail the set recipient(s), where the message is assumed to be of type "plain".
- sendMail(String, String, String, String) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a textual mail using the given sender name to the set recipient(s), where the message is assumed to be of type "plain".
- sendMail(String, String, String, String, boolean, Attachment...) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a mail using the given sender name to the set recipient(s), where the message is assumed to be of type "plain".
- sendMail(String, String, String, String, String) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a textual mail using the given sender name to the set recipient(s).
- sendMail(String, String, String, String, String, boolean, Attachment...) - Method in interface de.espirit.firstspirit.access.MailService
-
Send a mail using the given sender name to the set recipient(s).
- SendMailException - Exception in de.espirit.firstspirit.server.mailmanagement
-
This exception is thrown if an e-mail could not be sent.
- SendMailException(Throwable) - Constructor for exception de.espirit.firstspirit.server.mailmanagement.SendMailException
-
Creates a new exception with the specified cause.
- sendMessage(String) - Method in interface de.espirit.firstspirit.access.MessageService
-
Sends the given message to all users logged in on the server.
This message will be visible in all java- and webeditclients and in all webmonitor and startpage sessions. - sendMessage(String, Group) - Method in interface de.espirit.firstspirit.access.MessageService
-
Sends the given message to the users contained in the given usergroup.
- sendMessage(String, List<User>) - Method in interface de.espirit.firstspirit.access.MessageService
-
Sends the given message to the users specified by the given recipients list.
- SERIALIZABLE - Enum constant in enum class de.espirit.or.Layer.TransactionIsolationLevel
-
Isolation level, see
Connection.TRANSACTION_SERIALIZABLE
. - SERVER_BACKUP_POSTFIX - Static variable in interface de.espirit.firstspirit.access.backup.ServerBackupFile
-
Postfix to add to the server backup file.
- SERVER_RELEASE - Enum constant in enum class de.espirit.firstspirit.storage.RevisionOperation.OperationType
-
Indicates a server release operation
- ServerActionHandle<T extends ActionProgress,
R extends Serializable> - Interface in de.espirit.firstspirit.access -
This interface provides methods to handle server actions like e.g.
- ServerActionNotFoundException - Exception in de.espirit.firstspirit.access
-
Thrown, if no server action existed for a requested action id.
- ServerActionNotFoundException(String, long) - Constructor for exception de.espirit.firstspirit.access.ServerActionNotFoundException
-
Constructor for this exception.
- serverBackupDone() - Method in interface de.espirit.firstspirit.access.AdminService
-
Signal that the external server backup is finished.
- ServerBackupFile - Interface in de.espirit.firstspirit.access.backup
-
This class represents a server backup file.
- serverBackupPrepare(long, long) - Method in interface de.espirit.firstspirit.access.AdminService
-
Call this method to signal the server to prepare for an external server backup.
- ServerBackupProgress - Interface in de.espirit.firstspirit.access.backup
-
Progress action for the server backup progress.
- ServerConfiguration - Interface in de.espirit.firstspirit.access
-
Interface providing means to operate on server configuration.
- ServerConfiguration.PluggabilityFeaturesConfiguration - Enum Class in de.espirit.firstspirit.access
-
The Java Servlet Specification 3.0 introduced "pluggability" features which require the server to scan web applications for annotations.
- ServerConfigurationAgent - Interface in de.espirit.firstspirit.agency
-
Agent providing access to the server configuration.
- ServerInformationAgent - Interface in de.espirit.firstspirit.agency
-
Agent providing information of the FirstSpirit server.
- ServerInformationAgent.VersionInfo - Interface in de.espirit.firstspirit.agency
-
Interface representing the FirstSpirit version.
- ServerInformationAgent.VersionInfo.Mode - Enum Class in de.espirit.firstspirit.agency
-
Indicates the mode which is currently active.
- ServerInformationAgent.VersionInfo.Quality - Enum Class in de.espirit.firstspirit.agency
-
Indicates the quality level of the related FirstSpirit version.
- ServerProperties - Class in de.espirit.firstspirit.server.configuration
-
A list of all accessible server properties.
- ServerProperties() - Constructor for class de.espirit.firstspirit.server.configuration.ServerProperties
- ServerProperty<PROPERTY_TYPE> - Interface in de.espirit.firstspirit.server.configuration
-
A configurable property of the FirstSpirit server, e.g. the socket port number.
- ServerReleaseOperation - Interface in de.espirit.firstspirit.storage
-
Indicates a
server release
operation - SERVICE_NAME - Static variable in interface de.espirit.firstspirit.access.packagepool.PackageManager
-
Name of this service.
- ServiceNotFoundException - Exception in de.espirit.firstspirit.access
-
This exception is thrown if an service is requested
Connection.getService(String)
which doesn't exists on the server or is not running. - ServiceNotFoundException() - Constructor for exception de.espirit.firstspirit.access.ServiceNotFoundException
- ServicesBroker - Interface in de.espirit.firstspirit.access
-
Interface for a class that brokers services.
- Servlet - Enum constant in enum class de.espirit.firstspirit.access.schedule.DeployTask.Target
-
Deploy via servlet.
- ServletTarget - Interface in de.espirit.firstspirit.access.schedule
-
Deployment of contents using the FirstSpirit deployment servlet (e.g. used to deploy contents into a local file system remotely)
- Session - Interface in de.espirit.or
-
Session is the entry point for a connection to a database.
- set(Referenceable) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Sets the referenced element.
- set(Object) - Method in interface de.espirit.firstspirit.forms.FormField
-
Set the value of this field.
- set(Language, Link) - Method in interface de.espirit.firstspirit.access.editor.LinkEditorValue
-
Deprecated.Set the value object for the specified language.
- set(Language, T) - Method in interface de.espirit.firstspirit.access.editor.EditorValue
-
Deprecated.Set the value object for the specified language.
- set(IDProvider) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
Set a new element reference of type
IDProvider
and infer settings for UID and UidType. - set(String) - Method in interface de.espirit.firstspirit.access.editor.value.DomElement
-
Sets the given xml.
- set(Element) - Method in interface de.espirit.firstspirit.access.editor.value.DomElement
-
Sets root element.
- set(Element) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Set the permission definition element.
- setAbbreviation(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the abbreviation of the user
- setAccessFileContent(String) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setActivateDeployments(boolean) - Method in class de.espirit.firstspirit.access.export.ImportParameters
-
Define whether
schedule entries
imported during theproject import
should be activated (default) or not. - setActivateProject(boolean) - Method in class de.espirit.firstspirit.access.export.ImportParameters
-
Define whether the imported project should be activated after
project import
or not. - setActive(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Activates / Deactivates this subscription.
- setActive(boolean) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Activate or deactivate the TemplateSet
- setActive(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Provide
true
if thisScheduleEntry
should be activated,false
otherwise. - setActive(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide
true
if this task should be active,false
otherwise. - setActive(boolean) - Method in interface de.espirit.firstspirit.access.User
-
Set activation state of user.
- setActiveWebServer(String, String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the specified webserver id on the specified webscope.
- setActiveWebserverConfiguration(String, String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the configuration of the given webserver as active for the named web application.
- setAdmin(boolean) - Method in interface de.espirit.firstspirit.access.project.Group
-
Sets or clears the admin flag of this group.
- setAdminMail(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the administrators email address used to send notification mails to.
- setAdminMode(boolean) - Method in interface de.espirit.firstspirit.access.User
-
Enable admin mode for this user with extended permissions.
- setAggregateByValue(boolean) - Method in interface de.espirit.or.schema.ComposedAttribute
-
Defines whether the relation is of aggregating nature.
- setAlign(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines the alignment to be applied.
- setAllowed(String, Collection<String>) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Sets the allowed groups for the given operation.
- setAllowedExtensions(Set<String>) - Method in interface de.espirit.firstspirit.access.project.MediaConstraints
-
Set the allowed file name extensions.
- setAllowedGroups(Group[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission
-
Set several groups that should be allowed to execute the workflow.
- setAllowedGroups(Group[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowTransitionPermission
-
Defines the user groups allowed to perform the transition.
- setAllowedUsers(User[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission
-
Set several user that should be allowed to execute the workflow.
- setAllowedUsers(User[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowTransitionPermission
-
Defines the users allowed to perform the transition.
- setAllowEmpty(YesNo) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets whether empty is allowed for this form element.
- setAllowEmpty(YesNo) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement
-
Set, whether leaving the form empty is allowed.
- setAllowEveryone(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines to allow everyone to access this project.
- setAllowInteractiveExecution(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Provide
true
if interactive execution should be allowed,false
otherwise (default). - setAllowLanguageHiding(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set if project users are allowed to switch the display of language tabs in this project.
- setAllowUidChanges(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set allow UID changes project flag.
- setAlternativeUrls(Collection<String>, ContentProducer, Language, TemplateSet) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties
-
Set the list of alternative URLs for the specified parameter set.
- setAltText(String) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Sets an alt text for the medium.
- setAlwaysActive(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Sets the always active flag for this script.
- setAlwaysActive(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow
-
Set always active parameter.
- setAppendDateToDirectoryName(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FileTarget
-
Provide
true
if date should be append to directory name (default). - setAppendLogFiles(boolean) - Method in interface de.espirit.firstspirit.access.schedule.MailTask
-
Provide
true
if log files should be attached to this mail,false
otherwise - setAppletEditors(List<String>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Deprecated.since 5.0 - no replacement
- setArchive(boolean) - Method in interface de.espirit.firstspirit.access.store.pagestore.Page
-
Set generate archived version of this page.
- setAreas(List<? extends Area>) - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium
-
Allows to define the areas mapping to links.
- setAttributeReference(String[], String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping
-
Defines the attribute reference for this mapping.
- setAttributeReference(String[], String, boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping
-
Defines the attribute reference for this mapping allowing for language dependency.
- setAvailable(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Set this package available / not available.
- setBackup(boolean) - Method in class de.espirit.firstspirit.access.export.ExportParameters
- setBackupCachedPictures(boolean) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set export cached picture resolutions state.
- setBackupEmail(String) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines the e-mail address to send back up mails to.
- setBackupRestore(boolean) - Method in class de.espirit.firstspirit.access.export.ImportParameters
-
Set to true if this import is a project backup restore.
- setBackupTableData(boolean) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set table data backup mode.
- setBackupTableData(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines whether to back up table data.
- setBackupType(BackupType) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines the type of backup to be performed.
- setBarAdmin(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set to bar the
server admin
from using/editing the project. - setBodies(List<? extends TemplateBody>) - Method in interface de.espirit.firstspirit.access.store.templatestore.PageTemplate
-
Set the list of bodies for this template.
- setBorderWidth(Integer) - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium
-
Defines the border width to be used.
- setBrokenLinkMedia(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the UID of a media element to be shown when displaying a broken link.
- setBrokenLinkPage(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the UID of a page reference to be used when displaying a broken link.
- setBrowserEngineFileExtensions(String) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Set the file name extensions bound to the integrated office application engine.
- setCacheWeight(double) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set cache weight.
- setCancelScheduleWhenNoChanges(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide
true
if execution should be canceled if there are no changes,false
otherwise - setCaseSensitive(boolean) - Method in class de.espirit.firstspirit.access.search.Request
-
Set the request to be case sensitive or not.
- setCdata(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines the format to represent CDATA.
- setCdata(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines this style to represent CDATA.
- setChangeable(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the changeable flag for this subscription.
- setChangeState(int) - Method in interface de.espirit.firstspirit.access.store.PackagePoolItem
-
Sets the change state for this PackagePoolItem.
- setChannelSource(TemplateSet, String) - Method in interface de.espirit.firstspirit.access.store.templatestore.ChannelSourceProvider
-
Sets the given source for the template channel specified by the given template set
- setCheckFreeSpace(boolean) - Method in class de.espirit.firstspirit.access.export.ImportParameters
-
Set to true if a check for sufficient free disk space on the server should be performed before the import process is started.
- setClassLoader(ClassLoader) - Method in interface de.espirit.firstspirit.access.script.ScriptEngine
-
Defines the class loader to be used on executing the script.
- setClusterFirstSpiritPath(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Defines the path for the first spirit cluster server.
- setClusterMasterHost(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the host for the master cluster server.
- setClusterMasterPort(int) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the port for the master cluster server.
- setClusterNodeName(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Defines the name of the cluster node.
- setClusterSlaveName(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the name of the slave cluster server.
- setColor(Color) - Method in interface de.espirit.firstspirit.access.Workflowable
-
Set a new color.
- setColSpan(int) - Method in interface de.espirit.firstspirit.access.editor.value.TableCell
-
Provide the colspan for this table cell.
- setColumn(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide the number of the column this rule should be used for.
The column region is set toRegion.NUMBER
automatically. - setColumn(Column) - Method in interface de.espirit.or.schema.SimpleAttribute
- setColumnRegion(StyleTemplateLink.Region) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide the column
region
to be used for this rule. - setColumnWidth(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping
-
Set the column's width to the given value.
- setComment(String) - Method in interface de.espirit.firstspirit.store.operations.SaveOperation
-
Defines the comment to be used for saving.
- setComment(String) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Sets a comment.
- setComment(String) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Sets the comment for this package.
- setComment(String) - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion
-
Sets the comment of this PackageVersion.
- setComment(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines the comment for this group.
- setComment(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec
-
Set the comment of the folder for the specific language
- setComment(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Defines the comment for this script.
- setComment(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Template
-
Set the comment of the Template
- setComment(String) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Set comment
- setCompression(byte) - Static method in class de.espirit.firstspirit.access.ConnectionManager
-
Set the used compression.
- setConflictMode(byte) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the conflict mode for this subscription.
- setConnection(Connection) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Sets the connection to be used for permissions.
- setConnectionRetry(int) - Method in class de.espirit.or.ConnectionConfiguration
-
Set number of max retries for the connection.
- setConnectionRetryCycle(long) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the retry cycle for the connection (milliseconds).
- setConnectionTimeout(long) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the connection timeout in milliseconds.
- setConnectionTimeout(Long) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set ftp connection timeout parameter in seconds. -1 means no timeout,
null
means "use default value". - setConstraint(Constraint) - Method in interface de.espirit.or.query.Select
-
Set the select constraint to
constraint
. - setContent(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateChannel
-
Sets the formatting content for this channel.
- setContextFree(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow
-
Defines this workflow to operate context free.
- setConversion(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateChannel
-
Defines the conversion mode to be used with respect to the defined conversion tables in the project.
- setConversionTable(ConversionTable) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Defines the conversion table to be used with this template set.
- setConversionTable(String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the conversion table of the template set
- setConvertEntities(ConvertEntity) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the mode for entity conversions.
- setCopyAllowed(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTemplate
-
(Dis-)allow copying of this template.
- setCopyAllowed(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate
-
Enable or disable the possibility to copy entities.
- setCreateGenerateTag(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Should a tagged repository revision be created for this generation.
- setCreateMediaFiles(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide
true
if media files should be created,false
otherwise. - setCreateNewIds(boolean) - Method in class de.espirit.firstspirit.access.export.ImportParameters
-
Define whether the
project import
should create new ids (default) or keep the ids existing in theexport file
. - setCropData(PictureCropData) - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution
-
Sets the crop information related to the original resolution, or
null
to remove. - setCustomData(Data) - Method in interface de.espirit.firstspirit.access.Task
-
Deprecated.since 5.2.19, use
Task.setCustomFormData(FormData)
. - setCustomData(Data) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Deprecated.since 5.0.207 use
TransitionParameters.setCustomFormData(FormData)
- setCustomFormData(FormData) - Method in interface de.espirit.firstspirit.access.Task
-
Set this task's custom form data.
- setCustomFormData(FormData) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Sets the custom form data for this task.
- setCustomProperties(String, Map<String, String>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set user defined project properties.
- setCustomScriptName(String, String) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Deprecated.since 5.0.39 - no replacement
- setData(Data) - Method in interface de.espirit.firstspirit.access.link.Link
-
Deprecated.since 4.2.440 - use
Link.setFormData(de.espirit.firstspirit.forms.FormData)
instead - setData(Data) - Method in interface de.espirit.firstspirit.access.store.pagestore.DataProvider
-
Deprecated.since 4.2.440 - use
DataProvider.setFormData(de.espirit.firstspirit.forms.FormData)
instead - setDatabase(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the database name.
- setDatabaseLayer(Layer) - Method in interface de.espirit.firstspirit.access.AdminService
-
Save changes made on a database layer.
- setDataRenderDepth(int) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Sets the render depth of linked
Dataset
s in theJsonOutput
. - setDataTimeout(Long) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set ftp data transfer timeout parameter in seconds. -1 means no timeout,
null
means "use default value". - setDebugMode(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
If debug mode is switched on java stack traces are included in the template log.
- setDefaultExceptionHandler(ExceptionHandler) - Static method in class de.espirit.firstspirit.access.ConnectionManager
-
Sets the default
ExceptionHandler
for all connections without an own handler. - setDefaultExpression(Object) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Sets the default expression to be used for output when some value evaluates to null or undefined.
- setDefaultPublishGroup(PublishGroup) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager
-
Sets the default publish group.
- setDefaults(Data) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomEditorProvider
-
Deprecated.since 5.2.20, use
GomEditorProvider.setFormDefaults(FormData)
. - setDefaults(Data) - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider
-
Deprecated.since 5.0.100 Use
GomSourceProvider.setFormDefaults(FormData)
instead. - setDefaultStyleTemplate(StyleTemplate) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate
-
Provide the
StyleTemplate
that should be used for any table cell which style isn't explicitly overriden using aStyleTemplateLink
definition - setDefaultTemplateSet(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines the default template set to be used.
- setDefaultTimeFormat(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the default time format used to parse the directory listings provided by the ftp server.
Anull
value means that a default date format of the locale en_US is used. - setDefaultValue(EditorValue<?>) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the editor providing the default value for this form element.
- setDefaultValue(EditorValue<?>) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement
-
Set the default value for the form element.
- setDefaultValue(T) - Method in interface de.espirit.or.schema.SimpleAttribute
-
Set the default value of this attribute to
value
. - setDeletable(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide
true
if the region defined in this link should be deletable,false
otherwise.
Note: This setting takes effect for row and column rules only. - setDeleteDirectory(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide
true
if directory should be deleted before generation,false
otherwise - setDeleteWorkflow(Workflow) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set delete Workflow.
- setDeploymentErrorHandling(int) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the code for how to handling deployment errors.
- setDeprecated(boolean) - Method in interface de.espirit.or.query.Select
-
Set this select to deprecated or not.
- setDescription(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the description of the project
- setDescription(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Sets the given
String
as description. - setDescription(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide the description of this task.
- setDescription(Language, String) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Sets the editorial description of the resolution for the given language
- setDescription(Language, String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the editorial description of this TemplateSet for the given language
- setDescription(String) - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup
-
Sets the description of this publish group
- setDescription(String) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Sets the technical description of the resolution
- setDescription(String) - Method in interface de.espirit.firstspirit.access.store.LanguageInfo
-
Sets the description parameter.
- setDescription(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.File
-
Set the description of the current media.
- setDescription(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture
-
Set the description of the current media.
- setDescription(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo
-
Sets the description.
- setDescription(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo
-
Set the description.
- setDescription(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Defines the description of this script.
- setDirectory1(String) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setDirectory2(String) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setDisplayName(Language, String) - Method in interface de.espirit.firstspirit.access.store.IDProvider
-
Sets the display name (label) for the specified language.
- setDisplayName(String) - Method in interface de.espirit.firstspirit.access.store.LanguageInfo
-
Sets the display name for this storeelement for the underlying language
- setDisplayName(Language, String) - Method in interface de.espirit.firstspirit.access.Language
-
Sets the display name of the Language for the given language
- setDisplayName(Language, String) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Sets the display name of the resolution for the given language
- setDisplayName(Language, String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the display name of the TemplateSet for the given language
- setDocumentGroup(DocumentGroup) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Sets the given document group as referenced element.
- setDomLink(Language, Element) - Method in interface de.espirit.firstspirit.access.editor.LinkEditorValue
-
Deprecated.Sets a link from a DOM definition.
- setDriver(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the driver.
- setDropEditorName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Set the name of the editor that should be used as a drop target.
- setDueDate(Date) - Method in interface de.espirit.firstspirit.access.Task
-
Set task due date
- setDueDate(Date) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Set due date.
- setEditable(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide
true
if the region defined in this link should be editable,false
otherwise. - setEditors(List<Principal>) - Method in interface de.espirit.firstspirit.access.Task
-
Set allowed editors
- setEditors(List<Principal>) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Set editors.
- setElement(IDProvider) - Method in class de.espirit.firstspirit.agency.SnippetContext
-
Sets the element to be used as context information source for snippet building.
- setElementName(String) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Set the element name.
- setEmail(String) - Method in interface de.espirit.firstspirit.access.project.Group
-
Sets the email address of the group
- setEmail(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Sets the e-mail address(es) that should be used for status mails.
- setEmail(String) - Method in interface de.espirit.firstspirit.access.schedule.MailTask
-
Provide the email-addresses of recipients seperated by ";"
- setEMail(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the email address that will be notified when the project generation is ready!
- setEMail(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the email address of the user.
- setEmptyPage(Page) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines the empty page.
- setEncoding(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.File
-
Set the encoding of the current file-media
- setEncryption(byte) - Static method in class de.espirit.firstspirit.access.ConnectionManager
-
Set the used encryption.
- setErrorCode(String) - Method in exception de.espirit.common.CheckedException
-
Set the error code for the exception.
- setErrorOut(PrintWriter) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Sets the error output writer.
- setErrorOut(Writer) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Shortcut for
setErrorOut(new PrintWriter(out))
. - setErrorThreshold(long) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide the threshold of errors until generation should be canceled.
- setExceptionHandler(ExceptionHandler) - Method in interface de.espirit.firstspirit.access.Connection
-
Sets the
ExceptionHandler
for this connection. - setExecuteInFault(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide
true
if this task is to be executed even on previous errors,false
to be skipped. - setExecuteOnClusterNode(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Switch if the task execution should run on a cluster node.
- setExecuteParallel(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide
true
if this task should be allowed to be executed parallel,false
otherwise. - setExportCachedPictures(boolean) - Method in class de.espirit.firstspirit.access.export.ExportParameters
-
Set export cached picture resolutions state.
- setExportCachedPictures(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask
-
Set export cached picture resolutions state.
- setExportDeletedElements(boolean) - Method in class de.espirit.firstspirit.access.export.ExportParameters
-
Define whether deleted elements should be exported during belonging project export or not.
- setExportDeletedElements(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask
-
Defines whether deleted elements shall be exported.
- setExportElementCount(int) - Method in interface de.espirit.firstspirit.access.store.ExportHandler
- setExportTableData(boolean) - Method in class de.espirit.firstspirit.access.export.ExportParameters
-
Define whether contentstore table data should be exported (
true
) during the belonging project export or not {false
}. - setExportTableData(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask
-
Defines whether table data is to be exported.
- setExtension(String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the extension of the TemplateSet
- setExtension(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.File
-
Set the Extension The extension is also set by the upload methods.
- setExtension(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution
-
Set the file extension.
- setExternalName(String) - Method in interface de.espirit.firstspirit.access.project.ExternalGroup
-
Sets the name of the external group.
- setExternalUrlEditorName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Defines the name of the editor component used for external urls.
- setExtract(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Snippet
-
Set the extract expression for this snippet.
- setFallbackTimeFormat(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the fallback time format used to parse the directory listings provided by the ftp server, if this cannot be parsed with the
default time format
. - setFetchSize(int) - Method in interface de.espirit.or.query.Select
-
Sets the fetch size for this select which will be applied to the result
EntityList
returned byexecuteQuery(Select)
. - setFile(long, InputStream, String) - Method in interface de.espirit.firstspirit.access.store.mediastore.File
-
Set new data for the file including its extension and content length.
- setFilename(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.Media
-
Set the filename of the current media.
- setFilename(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines the file name for this group.
- setFilename(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef
-
Set a filename suggestions which may be used for creating urls.
- setFiletypeBindings(Map<String, String>) - Method in interface de.espirit.firstspirit.access.User
-
Set the file type bindings
- setFilterParams(Map<String, Object>) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines filter parameters by the given map.
- setFocus(FocusArea) - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData
-
Configures the focus area associated with this crop selection.
- setFolder(MediaFolder) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Sets the folder of the binary medium.
- setFolderName(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Sets the folder (given by its name) where pages should be generated in.
- setFontName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines the font name to be used for styling.
- setForbidden(String, Collection<String>) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Sets the forbidden groups for the given operation.
- setForbidPolyglotDataHierarchy(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines, whether to forbid to use language dependent forms on arbitrary levels in data hierarchy.
- setForceEditorIds(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Tells the generation context whether or not the editor identifier should be generated regardless of the current environment.
- setFormatTag(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines this format's tag.
- setFormatVersion(String) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Sets the json format version for rendering.
- setFormData(FormData) - Method in interface de.espirit.firstspirit.access.link.Link
-
Sets the given
formdata container
for this link. - setFormData(FormData) - Method in interface de.espirit.firstspirit.access.store.pagestore.DataProvider
-
Sets the given
formdata container
of this element. - setFormDefaults(FormData) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomEditorProvider
-
Set the default values for all editors based on the given form data.
- setFormDefaults(FormData) - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider
-
Set the default values via a form data object.
- setFreeSpaceShutdownLimit(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Set server minimum free space shutdown limit in one of the supported formats.
- setFreeSpaceWarnLimit(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Set server minimum free space warning limit in one of the supported formats.
- setFtpServerType(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Provide the ftp server type.
- setGDataApiCredentials(Pair<String, String>) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Deprecated.since 5.2.180904 - no replacement
- setGenerate(boolean) - Method in interface de.espirit.firstspirit.access.Language
-
Activates/deactivates the generation of this language.
- setGenerateAbsoluteLinks(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines whether absolute links shall be generated.
- setGenerateAnchor(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateExtension
-
Defines whether to generate an anchor tag when rendering the related template.
- setGenerateFlag(Language, TemplateSet, boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Set the generate flag for a specific language/template set combination.
- setGenerateFor(TemplateSet[]) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines to generate this group for the given list of template sets.
- setGenerateForToAll() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines to generate for all template sets.
- setGenerationSource(GenerateTask.GenerationSource) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Set the source version to use for generation.
- setGenericProperty(String, String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set eneric properties
- setGomElementTag(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement
-
Sets the tag name, the instance gets produced for.
- setGomElementTag(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
-
Define the tag for this GOM element.
- setGomElementTag(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList
-
Sets the tag name, the instance gets produced for.
- setGomProvider(GomEditorProvider) - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider
-
Set the GOM provider to be used by this template.
- setGomSource(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider
-
Set the xml describing the template form.
- setGraphicalNavigationMedia(int, Media) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRefFolder
-
Sets the
media
for the graphical navigation for the given graphical navigation state (on ofPageRefFolder.MEDIA
,PageRefFolder.MEDIA_MOUSEOVER
,PageRefFolder.MEDIA_SELECTED
,PageRefFolder.MEDIA_SELECTED_MOUSEOVER
)
To reset the picture for a specific state call withnull
for param 'media' - setGraphicsEngineActive(boolean) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Activate the internal graphics engine.
- setGraphicsEngineFileExtensions(String) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Set the file name extensions bound to the integrated office application engine.
- setHddDirectories(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Set directories to check the hdd free space left (comma separated).
- setHddShutdownLimit(int) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Deprecated.since 5.2.230209 - replaced by
ServerConfiguration.setFreeSpaceShutdownLimit(String)
. - setHddShutdownLimitActive(boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets wether or not the server will be shut down if limit is exceeded.
- setHddWarnLimit(int) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Deprecated.since 5.2.230209 - replaced by
ServerConfiguration.setFreeSpaceWarnLimit(String)
. - setHddWarnLimitActive(boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets wether or not a warning mail should be issued if limit is exceeded.
- setHeader(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Snippet
-
Set the header expression for this snippet.
- setHeight(int) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Sets the height of the resolution
- setHeight(Integer) - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium
-
Sets the image's height.
- setHFill(YesNo) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets, whether to horizontally fill a form by this form element.
- setHidden(boolean) - Method in interface de.espirit.firstspirit.access.store.pagestore.Body
-
Set the state of the body: hide/show
- setHidden(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Set if the template should be hidden.
- setHidden(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Template
-
Set if the template should be hidden.
- setHidden(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateBody
-
Set hidden parameter of this TemplateBody
- setHidden(YesNo) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the form element to be hidden or not.
- setHidden(YesNo) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement
-
Set, whether the form will be hidden.
- setHorizontalSpace(Integer) - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium
-
Sets the horizontal spacing for the image.
- setHost(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Provide the host of the ftp server
- setHost(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the host.
- setHTMLEncoding(String) - Method in interface de.espirit.firstspirit.access.Language
-
Set the HTMLEncoding
- setHtmlMode(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Tells the generation context whether or not html code will be generated currently.
- setHtmlTemplateProvider(HtmlTemplateProvider) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Provides means to inject arbitrary templates into the JSON rendering.
- setHttpProxyHost(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Sets the port used for http proxy.
- setHttpProxyLogin(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the login used for http proxy.
- setHttpProxyPassword(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the password used for http proxy login.
- setHttpProxyPort(int) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the port used for http proxy.
- setIgnoreValidation(boolean) - Method in interface de.espirit.firstspirit.access.Language
-
Defines, whether validation should be performed.
- setImageFlipped(boolean) - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData
-
Sets/mark the image flipped.
- setImageRotation(int) - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData
-
Sets the image rotation in degree.
- setImportElementCount(int) - Method in interface de.espirit.firstspirit.access.store.ImportHandler
-
How many StoreElements are going to be imported
- setIncludeConfiguration(GomIncludeConfiguration) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement
-
Set the configuration for an included element.
- setIncludeConfiguration(GomIncludeConfiguration) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement
-
Defines the included configuration for this element (may be null).
- setIncludeConfiguration(GomIncludeConfiguration) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList
-
Set the configuration for an included element.
- setInfo(String) - Method in interface de.espirit.firstspirit.access.template.TemplateDocument
-
Set descriptive text shown in template stack traces.
- setInherited(boolean) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Defines the permissions to be inherited.
- setInheritWorkflowPermission(boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Sets a
boolean
flag to enable or disable the inheritance of workflow permissions for thisStoreElement
.
Iftrue
the WorkflowPermissions of parentStoreElement
used,false
otherwise.
Note:
Store
has no parent andStoreElement.inheritWorkflowPermission()
return alwaysfalse
- setInlineMediaPreviewEnabled(boolean) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide
true
if inline preview for media should be enabled,false
otherwise. - setInlinePreviewConstraints(InlinePreviewConstraints) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set the
inline preview settings
of this project. - setInlinePreviewControlAdjustable(boolean) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide
true
if the content highlighting mode should be adjustable by user,false
otherwise. - setInlinePreviewControlOption(InlinePreviewConstraints.InlinePreviewControlOption) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide the default respectively fixed
content highlighting mode
.
Note: depends on return value ofInlinePreviewConstraints.isInlinePreviewControlAdjustable()
. - setInlinePreviewEnabled(boolean) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide
true
if inline preview for contents should be enabled,false
otherwise. - setInterval(long) - Method in interface de.espirit.firstspirit.access.schedule.IntervalExecutionSchedule
-
Provide the interval the dependent
ScheduleEntry
should be executed (inmilliseconds
). - setIsBackup(boolean) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set backup flag, used for backup file target directory (export or backup directory).
- setIsBackup(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines this to be a backup operation.
- setJunction(Request.Junction) - Method in class de.espirit.firstspirit.access.search.Request
-
Set the junction for clauses within this request.
- setKeepAspectRatio(boolean) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Provide
true
if aspect ratio of the original resolution should be kept,false
otherwise (default) - setKey(boolean) - Method in interface de.espirit.or.schema.SimpleAttribute
- setKey(K) - Method in class de.espirit.common.util.Pair
-
Set the key of the pair,
null
keys are allowed. - setKeywords(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec
-
Set the keywords for the folder
- setKeywords(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Sets the keywords for this pagereference for the underlying language of this PageLangSpec.
- setKeyWords(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot
-
Sets the keywords of this sitestoreroot for the project master language.
- setKeyWords(String, Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot
-
Sets the keywords of this sitestoreroot for the given language.
- setLabel(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec
-
Set the label (menu-name) of the folder
- setLabel(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Deprecated.since 4.0.17 originally replaced by LangInfos-Tag, now for hiding in GOM and enable attribute to tag conversion.
- setLabel(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomLangInfoProvider
-
Deprecated.since 4.0.17 originally replaced by LangInfos-Tag, now for hiding in GOM and enable attribute to tag conversion.
- setLabel(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo
-
Sets the label.
- setLabel(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo
-
Set the label.
- setLabelAndDescription(String, String, String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the label and description for a specific language.
- setLang(LanguageAbbreviation) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo
-
Sets the language for this information.
- setLang(LanguageAbbreviation) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo
-
Set the language the information is given for.
- setLanguage(Language) - Method in interface de.espirit.firstspirit.access.AdminService
-
Write back changed language to the server.
- setLanguages(List<Language>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets all projects languages.
- setLayer(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema
-
Set the database layer to use for this schema.
- setLayer(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the layer.
- setLayers(List<String>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the layer names for this project.
- setLayout(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema
-
Defines the type of the layout used for arranging the schema's entries.
- setLazyLoad(boolean) - Method in interface de.espirit.or.schema.ComposedAttribute
-
Defines whether to load values on demand.
- setLDAPSection(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the lDAPSection attribute of the User object
- setLDAPUser(boolean) - Method in interface de.espirit.firstspirit.access.User
-
Sets the LDAPUser attribute of the User object
- setLifespan(long, long) - Method in interface de.espirit.firstspirit.access.store.pagestore.Content2Section
-
Content sections support no lifespan - will result in an
UnsupportedOperationException
. - setLifespan(long, long) - Method in interface de.espirit.firstspirit.access.store.pagestore.Section
-
Set the lifespan of the current section.
- setLifespan(long, long) - Method in interface de.espirit.firstspirit.access.store.pagestore.SectionReference
-
Throws an
UnsupportedOperationException
. - setLinefeed(String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Not evaluated by FirstSpirit.
- setLink(Link) - Method in interface de.espirit.firstspirit.access.editor.value.LinkDomNode
-
Updates the link.
- setLinkExtension(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateExtension
-
Set the link-extension of the TemplateExtension
- setLocalActiveMode(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
The client to server communication may be performed in local active (default) or passive mode.
- setLocale(Locale) - Method in interface de.espirit.firstspirit.access.Language
-
Sets the locale for this language
- setLocale(Locale) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Defines the locale to be used for further evaluation.
- setLocaleKey(String) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Defines the locale key to be used for further evaluation.
- setLock(boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Lock or unlock this element and all children.
- setLock(boolean, boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Lock or unlock this element, if
recursive == true
all children are also (un)locked. - setLogin(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the login name which is used to log on the ftp server
- setLogin(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the login name
- setLoginName(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Deprecated.since 5.0.100 - use
RemoteProjectConfiguration.setLoginUser(User,String)
instead - setLoginName(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the login name.
- setLoginPassword(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Deprecated.since 5.0.100 - use
RemoteProjectConfiguration.setLoginUser(User,String)
instead - setLoginPassword(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the password of the user.
- setLoginUser(User, String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Sets the user and password which should be used for the remote project connection.
- setManual(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FixedExecutionSchedule
- setMappings(TableTemplate.Mapping[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate
-
Set the
TableTemplate.Mapping
s for this template. - setMasterLanguage(boolean) - Method in interface de.espirit.firstspirit.access.Language
-
Sets this language as master language
- setMasterLanguage(Language) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set master language of the project
- setMathContext(MathContext) - Method in class de.espirit.firstspirit.access.template.MathematicalContext
-
Sets the matthematical context
- setMaxFileSize(long) - Method in interface de.espirit.firstspirit.access.project.MediaConstraints
-
Set the project wide maximum file size setting for non image files in byte.
- setMaxImageSize(long) - Method in interface de.espirit.firstspirit.access.project.MediaConstraints
-
Set the project wide maximum image(file) size setting in byte.
- setMaximumApplicationWidth(int) - Method in interface de.espirit.firstspirit.access.project.Project
-
Provide the maximum allowed width of the inline preview frame or
-1
if there should be no restriction. - setMaximumColumnCount(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate
-
Set the maximum column count.
- setMaximumRowCount(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate
-
Set the maximum row count.
- setMaximumWarningCount(int) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the maximum number of acceptable warnings.
- setMaxPageCount(int) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines the maximum number of pages to be generated.
- setMaxResultCount(int) - Method in interface de.espirit.or.query.Select
-
Set the maximum number of entities this select will return.
- setMaxRevisionAge(long) - Method in class de.espirit.firstspirit.access.export.ExportParameters
-
Set the maximum age in milliseconds of export element revisions to include in the export.
- setMaxRevisionAge(long) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask
-
Sets the max revision age in milli seconds
- setMaxRevisionCount(long) - Method in class de.espirit.firstspirit.access.export.ExportParameters
-
Set the maximum count of revisions of an export element to include in the export.
- setMaxRevisionCount(long) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask
-
Defines the maximum number of revisiions to back up.
- setMaxStackSize(int) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Defines the maximum stack size for evaluation.
- setMaxStringLength(int) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the maximum string length.
- setMedia(Media) - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode
-
Provide the
Media
that should be used as bullet icon. - setMedia(Media) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Sets the given media object as referenced element.
- setMediaConstraints(MediaConstraints) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set the
media constraints settings
of this project. - setMediaExtensionCheckEnabled(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Activate the project level based media filename extension restrictions.
- setMediaPlayerFileExtensions(String) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Set the file name extensions bound to the integrated office application engine.
- setMediaSizeLimitEnabled(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Activate the project level based file size limitations for files (non-image files) and images.
- setMedium(Media) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Sets the medium of the binary medium.
- setMembers(List<PageRef>) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageGroup
-
Set the members for this page group from the given list keeping the given order.
- setMemoryLimit(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the maximum percentage of memory to be used.
- setMemoryWarnActive(boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Provide
true
to enable the memory warning,false
otherwise.
If enabled a notification email will be send to the configuredemail address
. - setMessage(String) - Method in exception de.espirit.firstspirit.access.template.ParsingError
-
Sets the error output message.
- setMeta(Data) - Method in interface de.espirit.firstspirit.access.store.IDProvider
-
Deprecated.since 4.2.450 - use
IDProvider.setMetaFormData(de.espirit.firstspirit.forms.FormData)
instead - setMetadata(FormData) - Method in class de.espirit.firstspirit.agency.SnippetContext
-
Sets the meta data to be used for snippet building.
- setMetaDataRendering(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Turns the meta data for elements on or off.
- setMetadataTemplate(long) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set Metadata template id.
- setMetadataTemplate(Template) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the metadata template for this project.
- setMetaFormData(FormData) - Method in interface de.espirit.firstspirit.access.store.IDProvider
-
Sets the given
formdata container
of this element. - setMetaInheritanceRendering(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Activates or deactivates the rendering of inherited meta data values.
- setMinimumColumnCount(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate
-
Set the minimum column count.
- setMinimumRowCount(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate
-
Set the minimum row count.
- setMode(Request.Mode) - Method in class de.espirit.firstspirit.access.search.Request
-
Sets the mode for matching.
- setMotD(String, String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets or deletes the Message of the Day of the specified language.
- setMotDVisible(boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets whether to show the Message of the Day or not.
- setName(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the name of the project
- setName(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Provide the name of this
ScheduleEntry
. - setName(String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide the name of this task.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateBody
-
Sets the name parameter of this TemplateBody
- setName(String) - Method in interface de.espirit.or.schema.EntityType
-
Set the name of this entity type to
name
. - setName(Designator) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the form element name.
- setName(Designator) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement
-
Set the name that identifies the editor's value.
- setName(String) - Method in interface de.espirit.firstspirit.access.Language
-
Sets the name
- setName(String) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Sets the name for this package.
- setName(String) - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup
-
Sets the name of this PublishGroup.
- setName(String) - Method in interface de.espirit.firstspirit.access.project.Group
-
Sets group's name.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.contentstore.ContentFolder
-
Set the name of the ContentStore-folder
- setName(String) - Method in interface de.espirit.firstspirit.access.store.DataValue
-
Deprecated.since 5.2.21 - see type
- setName(String) - Method in interface de.espirit.firstspirit.access.store.globalstore.GCAFolder
-
Set the name of the GCA-folder
- setName(String) - Method in interface de.espirit.firstspirit.access.store.globalstore.GlobalContentArea
-
Calling this method has no effect.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.pagestore.Body
-
Set the name of a body
- setName(String) - Method in interface de.espirit.firstspirit.access.store.pagestore.Section
-
Set the name of a section
- setName(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageGroup
-
Set the name of the page-group
- setName(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the name of the pagereference
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateFolder
-
Defines the name for this folder.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.SchemaFolder
-
Defines the folder's name.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Defines the name of the script.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.ScriptFolder
-
Sets the name of this script folder.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.SectionTemplates
-
Setting the name has no effect, calls will be ignored.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping
-
Set the name of this table template to the given name.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateFolder
-
Set the name of this folder
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowFolder
-
Sets the name of this workflow folder.
- setName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflows
-
Setting the name has no effect, calls will be ignored.
- setName(String) - Method in interface de.espirit.or.schema.Attribute
-
Set the name of this attribute to
name
. - setNextExecutionTime(Date) - Method in interface de.espirit.firstspirit.access.schedule.ExecutionSchedule
-
Provide the
Date
theScheduleEntry
should be executed next time. - setNoBreak(YesNo) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Set whether the next form element should follow immediately in the same line as this one.
- setNonDisplayedSectionsRendering(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Sets the NonDisplayedSectionsRendering-parameter NonDisplayedSectionsRendering indicates whether non-displayed
Section
should be rendered - setNoSchemaSyncLayers(List<String>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the layers for which no schema sync should be performed.
- setNotTranslatedAlternativePage(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the UID of a page reference for a page to be shown if no translation is given.
- setNotTranslatedMediaStrategy(Project.MediaNotTranslatedStrategy) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the strategy to be applied for not translated media.
- setNotTranslatedPageStrategy(int) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the strategy to be applied for not translated pages.
- setOfficeEngineFileExtensions(String) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Deprecated.since 5.2.191201 - no replacement
- setOrSchema(Schema) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema
-
Set the database schema.
- setOut(Writer) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Sets the writer for the output.
- setOutOfMemoryWarnActive(boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Activates / deactivates the out of memory warning for the FirstSpirit server.
- setOutputLengthLimit(int) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Set the length limit of the generated JSON output.
- setOverwriteDuringImport(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Defines how to handle elements which causes an
uid
conflict duringimport
of this package.
Iftrue
(default) existing elements intarget project
with the same uid will be overwritten with the package pool item of this package.
Iffalse
existing elements will be retained and the package pool item of this package will inserted with an unifieduid
- setOverwriteDuringImport(boolean, Class<? extends PackagePoolItem>...) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Set overwrite handling for specified types.
- setPage(Page) - Method in interface de.espirit.firstspirit.access.store.sitestore.AltPageRef
-
Set the page from PageStore that will be alternative page for an pagereference
- setPage(Page) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Set the page that is to be used in the generation context
- setPage(Page) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef
-
Set the page of the pagereference
- setPageGroup(PageGroup) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef
-
Set the page-group of the pagereference
- setPageRef(PageRef) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Sets the given page ref as referenced element.
- setParallelExecutionMode(ScheduleEntry.ParallelExecutionMode) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Changes the
ParallelExecutionMode
to the given mode. - setParameter(String, String) - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask
-
Set a parameter value having the given name to the provided value.
- setParameter(String, Object) - Method in interface de.espirit.or.query.Select
-
Sets the value for the
parameter
specified by the givenidentifier. - setParameter(Parameter) - Method in class de.espirit.or.query.Compare
-
Sets the parameter of this compare.
- setParameter(String, String) - Method in interface de.espirit.firstspirit.access.database.Layer
-
Setter for layer parameter.
- setParams(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the parameter for the connection.
- setParentContext(Context) - Method in interface de.espirit.firstspirit.access.template.Context
-
Sets the parent context for this one.
- setParseFile(boolean) - Method in interface de.espirit.firstspirit.access.store.mediastore.Media
-
Set if the media must be parsed during the generation (only
Media.FILE
) - setPassword(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the password which is used for login
- setPassword(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the password used for login
- setPassword(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the password.
- setPath(String) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setPath(String) - Method in interface de.espirit.firstspirit.access.schedule.DeployTarget
-
Set the target path.
- setPermission(Group, Permission) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Set the defined permission for the given group.
- setPermission(User[], Permission) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Set the defined permission for several users.
- setPermission(User, int) - Method in class de.espirit.firstspirit.access.search.Request
-
Sets the permissions for searched elements.
- setPermission(User, Permission) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
Set the defined permission for the given user.
- setPermissionCheck(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Activates / Deactivates the permission check for this project
- setPermissionVariable(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set Metadata variable used for permissions
- setPhoneNumber(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the phone number.
- setPicture(Resolution, long, InputStream, String) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture
-
Uploads the picture data for the given resolution by reading from the given input stream.
- setPictureEditorName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Set the variable name from the
form
which is used to get an image to display from link instancescreated with this template
. - setPlainUrl(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the plain url
- setPluggabilityFeaturesConfiguration(ServerConfiguration.PluggabilityFeaturesConfiguration) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the configuration of pluggability features for web applications.
- setPoolCheckInterval(long) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the interval in which the connection pool will be checked.
- setPoolMax(int) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the maximum number of pool connections.
- setPoolMin(int) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the minimum number of pool connections.
- setPoolTimeout(long) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the timeout for a pool connection
- setPort(int) - Method in class de.espirit.or.ConnectionConfiguration
-
Set port number.
- setPre(String) - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode
-
Provide the string that should be used as bullet if style style is set to
USER_DEFINED
. - setPrecision(int) - Method in class de.espirit.firstspirit.access.template.MathematicalContext
-
Set precision, see
MathContext.getPrecision()
. - setPrefix(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Sets the prefix for this remote project configuration.
- setPrefixTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Set the template which is used to render the prefix, e.g. a table of contents
- setPresentationChannel(String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the PresentationChannel of the TemplateSet
- setPresentationChannelId(long) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Defines the presentation channel of this template set.
- setPreset(Preset) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the preset mode to be used for default values.
- setPreset(Preset) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement
-
Set the mode to be applied for fallback values.
- setPrettyPrinting(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Turns the prettyPrinting setting on or off.
- setPreviewImage(byte[]) - Method in interface de.espirit.firstspirit.access.store.mediastore.File
-
Set a the image data source to create a preview-thumbnail from.
- setPreviewImage(byte[]) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture
-
Set the image data source to create a preview-thumbnail from.
- setPreviewImage(byte[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.PreviewImageProvider
-
Sets the preview image from an array of bytes which were read from an image file containing a supported image format, such as GIF or JPEG.
- setPreviewPageRef(PageRef) - Method in interface de.espirit.firstspirit.access.store.templatestore.MasterTemplate
- setPreviewRulesEvaluation(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Tells the generation context whether or not rules should be evaluated for the editor identifiers.
- setPriority(Task.Priority) - Method in interface de.espirit.firstspirit.access.Task
-
Set task priority
- setPriority(Task.Priority) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Set priority.
- setPriority(Priority) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions
-
Set the priorities for this permissions.
- setProject(Project) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry
-
Sets the project, if the schedule entry should be related to it.
- setProject(Project) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTemplate
-
Set
project
to make the schedule task template project scoped ornull
for server scoped. - setProjectCategory(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Set the name of the project category, for example "myRemoteCategory" not ""category:myRemoteCategory".
- setProjectLogo(InputStream) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set the project logo
- setProjectName(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Set the name of the project which should be related to this configuration.
- setProperty(String, Object) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the project property
name
to the givenvalue
. - setProperty(String, Object) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext
-
Creates a property entry for the given value identified by the given name.
- setProperty(String, Object) - Method in interface de.espirit.firstspirit.access.ScriptContext
-
Creates a property entry for the given value identified by the given name.
- setProperty(String, String) - Method in interface de.espirit.firstspirit.storage.Tag
-
Set value of a property.
- setProxy(Proxy) - Static method in class de.espirit.firstspirit.access.ConnectionManager
-
Set the proxy used for creating new connections.
- setProxyHost(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the host for ftp proxy.
- setProxyLogin(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the login used for ftp proxy.
- setProxyPassword(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the password used for ftp proxy login.
- setProxyPort(int) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the port for ftp proxy.
- setProxyType(FtpTarget.FtpProxyType) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Set the protocol used for ftp proxy.
- setPublic(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTemplate
-
Set
value
totrue
, if this template should be visible for other projects,false
if this template should be only available for local usage. - setPublishGroup(PublishGroup) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the given publish group for this subscription
- setQuery(Query) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines the query to be used for fetching records.
- setQuickstart(List<Quickstart>) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the list of quickstart items.
- setQuotaHDD(long) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the harddisk quota for this project.
- setQuotaMail(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the e-mail address to inform about quota issues.
- setQuotaPages(long) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the quota for pages allowed in this project.
- setQuote(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines whether to quote the format.
- setQuote(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines whether to quote the style.
- setReadOnly(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Read only packages: Content in subscribing may not be changed.
- setReadOnly(boolean) - Method in interface de.espirit.or.schema.Attribute
-
Set the read only property of this attribute to
readOnly
. - setReadOnlyLayers(List<String>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines the names of read only layers.
- setRealname(String) - Method in interface de.espirit.firstspirit.access.User
-
Sets the realname of the user.
- setRecordCountPerPage(int) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines the maximum number of records to be rendered on each page.
- setRecursionEnabled(boolean) - Method in interface de.espirit.firstspirit.store.operations.SaveOperation
-
Defines, whether child elements should be saved, too.
- setRedirectTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the template which should be used to generate
external
orrelated project
linksofpage reference nodes
.
If the redirect template is set tonull
a default redirect html is used: - setReferenceCategory(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Set the reference category which is used to categorize "external" links.
- setReferencedObject(Object) - Method in interface de.espirit.firstspirit.access.editor.reference.Reference
-
Sets the (local) referenced object.
- setReferenceName(String) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Defines the name for the reference.
- setRelease(boolean) - Method in class de.espirit.firstspirit.agency.SnippetContext
-
Sets the release type to be used for snippet building.
- setReleaseMode(byte) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the release mode for this subscription.
- setRemote(String) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Defines the symbolic remote project name, if the reference points to a remote project.
- setRemoteName(String) - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium
-
Sets a remote name for the medium
- setRemoteProjectConfiguration(RemoteProjectConfiguration) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set RemoteProjectConfiguration used for releated project.
- setRemoteProjectConfigurations(List<RemoteProjectConfiguration>) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the list of remote project configuratiosn for this project
- setRemoteSymName(String) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
If the set element is a remote project reference, this method set the symbolic remote project name definied in the local project configuration.
- setRenderExternalLinks(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the
render external links
flag.
Whentrue
apage
with an external link willgenerate like a normal content page.
Withfalse
(default) a redirect meta html will be rendered as result page forpages
which point to an external target. - setReplaceable(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateExtension
-
Set if the file-extension can be overwriten
- setRequired(boolean) - Method in interface de.espirit.or.schema.Attribute
-
Set the required property of this attribute to
flag
. - setResolution(Resolution) - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium
-
Define the resolution to be used for the medium
- setResolutions(Resolution[]) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set the Resolutions of this project
- setResolveDynamicContent(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Sets the resolve dynamic content setting.
- setRestoreProjectId(long) - Method in class de.espirit.firstspirit.access.export.ImportParameters
- setRevisionCommentMode(Store.Type, Project.CommentMode) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set revison comment mode for a specific store.
- setRevisionDate(Date) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set revision date to backup.
- setRevisionId(long) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set revision id to backup, use -1 for latest revision.
- setRoundingMode(RoundingMode) - Method in class de.espirit.firstspirit.access.template.MathematicalContext
-
Sets the rounding mode for this context.
- setRow(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide the number of the row this rule should be used for.
The row region is set toRegion.NUMBER
automatically. - setRowHeight(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate
-
Set the height of the displayed rows to the given value.
- setRowRegion(StyleTemplateLink.Region) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide the row
region
to be used for this rule. - setRowSpan(int) - Method in interface de.espirit.firstspirit.access.editor.value.TableCell
-
Provide the rowspan for this table cell.
- setRulesetDefinition(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.RulesetContainer
-
Sets the given
definition
of rule sets. - setRulesetDefinition(String) - Method in interface de.espirit.firstspirit.store.access.templatestore.RulesetContainer
-
Deprecated.Sets the given
definition
of rule sets. - setSchema(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the schema name
- setSearchRelevancy(Relevancy) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets the relevancy level for this GOM element.
- setSection(Section<?>) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Defines a section being referenced together with the element.
- setSection(Section<?>) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
Set the section to be referenced.
- setSectionName(String) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
Use this to set the section.
- setSectionName(String) - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference
-
Defines a section to be referenced together with the main element.
- setSectionName(String) - Method in interface de.espirit.firstspirit.access.editor.value.SectionListEntry
-
Set the section's name.
- setSectionTemplateRendering(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Turns the template rendering for
Section
type elements on or off. - setSecureAccessURL(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set URL for secure media access
- setSecureDefaultAllow(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set default allow access if no permissions are configured.
- setSecureMediaFolder(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set fodler used for secure media
- setSelectedOption(Option) - Method in interface de.espirit.firstspirit.access.editor.value.OptionModel
-
Set the selected option.
- setSelectedWebServer(String, String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Deprecated.since 5.2.180906 - no replacement
- setSelectedWebserverConfiguration(String, String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Deprecated.since 5.2.180906 - no replacement
- setSelection(Rectangle2D) - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData
-
Sets the selection rectangle.
- setSelectStatement(Select) - Method in interface de.espirit.firstspirit.access.store.templatestore.Query
-
Defines the select statement to be used for this query.
- setSelectStatement(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Query
-
Defines the select statement to be used for this query, derived from the given xml format.
- setSendBackupMail(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines whether to send a back up mail.
- setSendBackupMailOnError(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines whether to send a back up mail on error.
- setServerLanguageLocale(Locale) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
If the ftp server uses alphabetic month names in it's timestamps the short month names of this locale is used for date parsing.
- setServerProperty(ServerProperty<PROPERTY_TYPE>, PROPERTY_TYPE) - Method in interface de.espirit.firstspirit.agency.ServerConfigurationAgent
-
Modifies the current value of a server property.
- setServerTimeZone(TimeZone) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
This property is used to interpret file dates, for a list of valid id's see
TimeZone
.
Anull
value means that the time zone of the FirstSpirit server is used. - setServletUrl(String) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Set the url where deployment servlet is stored
- setShouldGenerateComment(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines whether comments should be generated.
- setShowInPageGroup(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the state if this pagereference shold be shown in the PageGroup
- setShowInSiteMap(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec
-
Set the state if this menu shold be shown at the SiteMap
- setShowInSiteMap(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the state if this menu shold be shown at the pagereference
- setShowReferenceNames(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the show reference name parameter for this project which indicates wether reference names should be shown or not (e.g. in create dialogs).
- setSiteMapLabel(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the label of the sitemap
- setSiteMapPicture(Picture) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Sets the sitemap picture for this pagereference.
- setSiteMapPictureRef(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Sets the sitemap picture as string reference.
- setSitemapVariableName(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params
-
Defines the name for the sitemap variable.
- setSize(int) - Method in interface de.espirit.or.schema.SimpleAttribute
- setSmartCropping(boolean) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Configures whether or not this resolution is intended for smart cropping (enabled by default).
- setSnippet(Snippet) - Method in interface de.espirit.firstspirit.access.store.templatestore.SnippetContainer
-
Set the snippet as defined in the given object.
- setSource(String) - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask
-
Sets the source code of this script.
- setSourceDirectory(String) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Provide the source directory, relative to the schedule directory.
- setStart(int) - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode
-
Provide the starting point of numbering.
- setStartNode(IDProvider) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setStartNode(StartNode) - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreFolder
-
Sets the given StartNode as startnode of this sitestore folder.
- setStartnodesDefinableByUser(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide
true
if the startnodes should be definable by the user,false
otherwise (default). - setStartTime(Date) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext
-
Set the start time, e.g. to generate an old version of the project.
- setStateToFailed() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext
-
Sets the run state of this execution to failed.
- setStateToSuccess() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext
-
Sets the run state of this execution to successful.
- setStatisticStart(long) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the start time for statistics.
- setStoredUrl(String, ContentProducer, Language, TemplateSet, Object) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties
-
Set the stored URL for the specified parameters set.
- setStoredUrl(String, MediaFolder, Language) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties
-
Set the stored URL for the specified parameter set.
- setStoredUrl(String, Media, Language, Resolution) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties
-
Set the stored URL for the specified parameter set.
- setStoredUrl(String, SiteStoreFolder, Language, TemplateSet) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties
-
Set the stored URL for the specified parameter set.
- setStores(Collection<Store.Type>) - Method in class de.espirit.firstspirit.access.search.Request
-
Sets the store types to be searched with this request.
- setStoreType(Store.Type) - Method in class de.espirit.firstspirit.agency.SnippetContext
-
Sets the store type to be used for snippet building.
- setStrict(boolean) - Static method in class de.espirit.firstspirit.common.text.Designator
-
Set the designator to be strict, i.e., an
InvalidDesignatorException
will be thrown in case of designators not matching the pattern. - setStyle(ListDomNode.Style) - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode
-
Provide the list style of this list dom node.
- setStyleAttributes(Map<String, String>) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines the style attributes.
- setSubject(String) - Method in interface de.espirit.firstspirit.access.schedule.MailTask
-
Provide the subject of this email
- setSuccessCondition(GenerateTask.SuccessCondition) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide a
SuccessCondition
- setSuffixTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Set the template which is used to render the suffix, e.g. an index
- setSymbolicName(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Set the symbolic name for this configuration.
- setSystem(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines this to be a system format.
- setTag(String) - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion
-
Sets the user defined version TAG of this package version.
- setTagName(String) - Method in class de.espirit.firstspirit.access.export.BackupParameters
-
Set custom backup tag extension.
- setTagName(String) - Method in interface de.espirit.firstspirit.access.editor.EditorValue
-
Deprecated.Set the tag name associated with this editor.
- setTagName(String) - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2
-
Defines the tag name for this task.
- setTags(Collection<String>) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Set the tags for this resolution.
- setTarget(DeployTarget) - Method in interface de.espirit.firstspirit.access.schedule.DeployTask
-
Set the deployment target (e.g.
- setTargetTemplate(StyleTemplate) - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink
-
Provide the
StyleTemplate
to be linked to. - setTask(Task) - Method in interface de.espirit.firstspirit.access.UserService
-
Set the task.
- setTask(Task) - Method in interface de.espirit.firstspirit.access.Workflowable
-
Set the given
Task
. - setTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.store.pagestore.Page
-
Set the template for this page.
- setTemplate(SectionTemplate) - Method in interface de.espirit.firstspirit.access.store.pagestore.SectionReference
-
Throws an
UnsupportedOperationException
. - setTemplate(TableTemplate) - Method in interface de.espirit.firstspirit.access.store.pagestore.Content2Section
-
Throws an
UnsupportedOperationException
as changing the template is not supported. - setTemplate(ScheduleTaskTemplate) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask
-
Provide the
ScheduleTaskTemplate
this task should use. - setTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.store.globalstore.ProjectProperties
-
Sets the template for this project properties.
- setTemplate(LinkTemplate) - Method in interface de.espirit.firstspirit.access.link.Link
- setTemplate(T) - Method in interface de.espirit.firstspirit.access.store.pagestore.Section
-
Set the template for this section.
- setTemplateAttributeRendering(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Sets the template attribute output setting on or off.
- setTemplateExtension(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup
-
Defines the extension used for resolving templates.
- setTemplateInspectionEnabled(boolean) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Enables or disables the template inspection for this template set.
- setTemplatePackage(TemplatePackage) - Method in interface de.espirit.firstspirit.access.packagepool.ContentPackage
-
Sets the given TemplatePackage as the dependent template package for this ContentPackage.
Before the import of this ContentPackage the dependent TemplatePackage will be imported. - setText(String) - Method in interface de.espirit.firstspirit.access.editor.value.SectionListEntry
-
Set the text for this section.
- setText(String) - Method in interface de.espirit.firstspirit.access.link.Link
-
Sets the text for this link.
- setText(String) - Method in interface de.espirit.firstspirit.access.schedule.MailTask
-
Provide the text of this email
- setTextEditorFileExtensions(String) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
"png,jpg,jpeg,bmp,gif,psd" Set the file name extensions bound to the integrated office application engine.
- setTextEditorName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate
-
Set the variable name from the
form
which is used to get the display text from link instancescreated with this template
. - setThumbnail(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Snippet
-
Sets the expression for the thumbnail of this snippet.
- setTimeout(long) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Provide the timeout in milliseconds.
- setToDefault() - Method in interface de.espirit.firstspirit.forms.FormField
-
Set the field to its default value.
- setToolTip(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines the tooltip for this style.
- setTransition(Transition) - Method in interface de.espirit.firstspirit.access.TransitionParameters
-
Set target transition.
- setTransitionPermissions(WorkflowTransitionPermission[]) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission
-
Set several permission for the workflow transitions.
- setType(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Sets the type of the script.
- setType(DeployTask.Type) - Method in interface de.espirit.firstspirit.access.schedule.DeployTask
-
Provide the
used for deploymentType
- setType(GenerateTask.Type) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide the
Type
GenerateTask
. - setType(WebServerConfiguration.Type) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setType(ScriptTask.Type) - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask
-
Sets the script type.
- setUid(String) - Method in interface de.espirit.firstspirit.access.store.IDProvider
-
Sets the unique identifier.
- setUid(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
The uid of format templates is used as tag name in dom and dom-table instances.
- setUid(String) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
Set the Uid of the referenced element.
- setUid(String) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Deprecated.since 5.0.18 - remove resolution from project and create new instance instead.
- setUid(String) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Sets the unique identifier of this TemplateSet.
- setUid(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomEditorProvider
-
Set the unique identifier for this provider.
- setUidConversionTable(ConversionTable) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Set conversion table used for creating UIDs suggestions from display names.
- setUidType(IDProvider.UidType) - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference
-
Set the
IDProvider.UidType
of the referenced element. - setUpdateMode(byte) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the update mode for this subscription.
- setUrl(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the external URL of the pagereference
- setUrlCreator(String) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Set the public name or class name of the url creator used to generate urls for nodes of the remote project.
- setUrlCreatorClassName(String) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Deprecated.since 5.0 - use
GenerateTask.setUrlCreatorSpecification(UrlCreatorSpecification)
. - setUrlCreatorSpecification(UrlCreatorSpecification) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Set the url creator specifiaction.
- setUrlPrefix(String) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Provide the url prefix
- setUrlPrefix(String) - Method in interface de.espirit.firstspirit.access.UrlCreator
-
Deprecated.Set an url prefix.
- setUseAclDb(boolean) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Set Access Control databse usage.
- setUseAsciiMode(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Provide
true
if text files should be transfered in ASCII mode (default). - setUseBlockTransferMode(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Toggle between block transfer mode and stream mode (default).
- setUseCurrentUser(boolean) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Set
true
if the credentials of the current user should be used for the remote connection instead of thelogin name
and thepassword hash
. - setUseCustomAccessFile(boolean) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setUseCustomConnection(String, String) - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask
-
Use a custom user
Connection
to execute this script. - setUseDefaultHtmlTemplateProvider(boolean) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings
-
Shortcut for setting the DefaultHtmlTemplateProvider as the current htmlTemplateProvider on or off.
- setUseEntryAllocator(boolean) - Method in interface de.espirit.firstspirit.access.schedule.MailTask
-
Defines whether the e-mail allocator of the schedule entry should be used.
- setUseExternalUrl(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
Set the state if this pagereference should use an external URL.
- setUseHttpProxy(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget
-
Provide
true
if http proxy should be used,false
otherwise (default). - setUseHttps(boolean) - Static method in class de.espirit.firstspirit.access.ConnectionManager
-
Set if https protocol should be used for servlet communication.
- setUseLanguages(YesNo) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement
-
Sets whether to use different values in each language or not.
- setUseMappingBasedSchemaMerge(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Defines, whether to use the mapping based schema import during the import with ExternalSync/ContentTransport.
- setUseMasterLanguageForData(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Set if the master language should be used for the data mapping for not translated pages.
- setUseNameSpaceEnhancement(boolean) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Set use name space enhancement.
- setUseNameSpaceEnhancement(boolean, Class<? extends PackagePoolItem>...) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Set use name space enhancement for specified types.
- setUseProjectStartpage(boolean) - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration
-
Deprecated.since 5.0 - no replacement
- setUseProxy(boolean) - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Provide
true
if ftp proxy should be used,false
otherwise (default). - setUser(User) - Method in interface de.espirit.firstspirit.access.admin.UserStorage
-
Write back a user to server.
- setUser(String) - Method in class de.espirit.or.ConnectionConfiguration
-
Set the username.
- setUserBindings(Map<String, String>) - Method in interface de.espirit.firstspirit.access.User
-
Sets and saves the current user bindings.
- setUseRelatedProjects(boolean) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Defines whether to use related projects.
- setUseRelatedProjectUrl(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec
-
State if this pagereference should use an URL to a related project.
- setUseRelease(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Activates/deactives use of the release mechanism.
- setUseRelease(boolean) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Defines whether or not a released version of store elements is required for referencing.
- setUseReleasePermission(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission
-
Define if the release permission should be used.
- setUseRemoteMedia(boolean) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Defines whether to use remote media.
- setUseRemoteSchemata(boolean) - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration
-
Defines whether to use remote schemata.
- setUserService(UserService) - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo
-
Sets the userservice which will be used to load underlying nodes.
- setUseServerLockForDataset(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set how
dataset
editing access is synced on server. - setUseSystemConnection() - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask
-
Use a default system
Connection
to execute this script and clear all custom connection credentials. - setUseWebEdit(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Set Webedit use
- setUseWebeditApplet(boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Deprecated.since 5.0 - no replacement
- setUseWebeditForPreview(boolean) - Method in interface de.espirit.firstspirit.access.project.TemplateSet
-
Deprecated.since 5.0.302 - no replacement
- setValidationEnabled(boolean) - Method in interface de.espirit.firstspirit.store.operations.SaveOperation
-
Defines, whether validation shall be performed on the element's data.
- setValidator(Validator<T>) - Method in interface de.espirit.or.schema.Attribute
-
Set the validator of this attribute to
validator
. - setValidFrom(Date) - Method in interface de.espirit.firstspirit.access.store.sitestore.AltPageRef
-
Set the date from that the this alternative page is valid
- setValue(Attribute<T>, T) - Method in interface de.espirit.or.schema.Entity
-
Set the value of the attribute
attribute
tovalue
. - setValue(String, T) - Method in interface de.espirit.or.schema.Entity
-
Set the value of the attribute with
name
to the givenvalue
. - setValue(Object) - Method in class de.espirit.or.query.Compare
-
Sets the value the
attribute
of this compare will becompared with. - setValue(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.GomLabeledValueEntry
-
Sets the value for this entry.
- setValue(V) - Method in class de.espirit.common.util.Pair
-
Set the value of the pair,
null
values are allowed. - setValueFromText(Language, String) - Method in interface de.espirit.firstspirit.access.SimpleEditorValue
-
Set the value.
- setValueNode(Element) - Method in interface de.espirit.firstspirit.access.editor.EditorValue
-
Deprecated.Set values of editor by dataXml element.
- setVariable(String, String) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Sets a value to a variable with the given name.
- setVariable(String, Serializable) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext
-
Sets a variable to this context.
- setVariableValue(String, Object) - Method in interface de.espirit.firstspirit.access.template.Context
-
Set a variable value within this local context.
- setVariableValue(String, Object) - Method in interface de.espirit.firstspirit.access.template.Evaluator
-
Stores the given value for the variable with the given name.
- setVerticalSpace(Integer) - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium
-
Sets the vertical spacing for the image.
- setView(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Sets the view mode for this format.
- setView(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines the view mdoe for this style.
- setViewScript(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script
-
Defines the view script of this script.
- setViewScript(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow
-
Set view script.
- setVisible(boolean) - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec
-
Set the state if this menu should be shown at the FrontEnd
- setVisible(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate
-
Defines whether the format shall be visible.
- setVisible(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style
-
Defines the style to be visible.
- setVisible(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping
-
Enable or disable the visibility.
- setVisible(boolean) - Method in interface de.espirit.or.schema.SimpleAttribute
- setWarningThreshold(long) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask
-
Set the threshold of warnings until generation should be canceled.
- setWebAppsConfigChanged(String, boolean) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the specified change state on the specified webscope
- setWebedit(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow
-
Use
true
to mark this workflow as a webedit workflow. - setWebeditDefaultTemplate(PageTemplate) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the default page template that should be used in webedit, or
null
for no default page template. - setWebeditDefaultWorkflow(Workflow) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the default workflow that should be used in webedit, or
null
for no default workflow. - setWebeditPreviewUrl(String) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the preview url for webedit.
- setWebeditSupported(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate
-
Provide
true
to allow usage of this table template in WebEdit,false
otherwise. - setWebeditSystemFolder(PageFolder) - Method in interface de.espirit.firstspirit.access.project.Project
-
Sets the pagefolder which should be used as webedit system folder.
- setWebEditTemplateSet(TemplateSet) - Method in interface de.espirit.firstspirit.access.project.Project
-
sets the templateSet for webedit
- setWebstartConfiguration(WebstartConfiguration) - Method in interface de.espirit.firstspirit.access.admin.JavaClientQuickstart
-
Sets the webstart configuration.
- setWebstartConfiguration(String, WebstartConfiguration) - Method in interface de.espirit.firstspirit.access.ServerConfiguration
-
Sets the configuration of webstart for the given application.
- setWeekDay(WeekDay) - Method in interface de.espirit.firstspirit.access.schedule.MonthlyExecutionSchedule
-
Provide the
WeekDay
dependentScheduleEntry
should be executed. - setWeekOfMonth(MonthlyExecutionSchedule.WeekOfMonth) - Method in interface de.espirit.firstspirit.access.schedule.MonthlyExecutionSchedule
-
Provide the
WeekOfMonth
dependentScheduleEntry
should be executed. - setWidth(int) - Method in interface de.espirit.firstspirit.access.project.Resolution
-
Sets the width of the resolution
- setWidth(Integer) - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium
-
Sets the images width.
- setWizardMode(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Query
-
Defines to used the wizard mode for definition.
- setWorkflow(byte, Workflow) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Map the given workflow to the given event type.
- setWorkflow(byte, Workflow) - Method in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Sets the given workflow for the given event type.
- setWorkflowModel(Workflow) - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow
-
Defines the workflow model for this workflow.
- setWorkflowPermission(WorkflowPermission) - Method in interface de.espirit.firstspirit.access.store.StoreElement
- setWorkflowPermissions(WorkflowPermission[]) - Method in interface de.espirit.firstspirit.access.store.StoreElement
- setWriteLock(boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement
-
A write lock is a flag to prevent changes e.g. while a workflow is active for this element.
- setZoomFactor(float) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide the browsers default respectively fixed zoom factor.
Note: depends on return value ofInlinePreviewConstraints.isZoomFactorAdjustable()
. - setZoomFactorAdjustable(boolean) - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints
-
Provide
true
if the browsers zoom factor should be adjustable by user,false
otherwise. - shouldGenerate() - Method in interface de.espirit.firstspirit.access.Language
-
Should this language be generated?
- showActionDialog() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext
-
Show ActionDialog and forward all values (including the selected transition) to the
TransitionParameters
object for thisTask
, if a target transition is selected.
All values are updated automatically. - showForm() - Method in interface de.espirit.firstspirit.access.GuiScriptContext
-
Opens a dialog showing the whole form of the underlying
GuiScriptContext.getScript()
without language tabs and returns theFormData
resulting on user input. - showForm(boolean) - Method in interface de.espirit.firstspirit.access.GuiScriptContext
-
Opens a dialog showing the whole form of the underlying
GuiScriptContext.getScript()
and returns theFormData
resulting on user input. - showForm(boolean, String) - Method in interface de.espirit.firstspirit.access.GuiScriptContext
-
Opens a dialog showing a sub part (specified by given name) of the form of the underlying
GuiScriptContext.getScript()
and returns theFormData
resulting on user input. - showReferenceNames() - Method in interface de.espirit.firstspirit.access.project.Project
-
Indicates whether reference names should be shown (e.g. in create dialogs) for this project or not.
- showUidAsTreeLabel() - Method in interface de.espirit.firstspirit.access.Host
-
Indicates whether the
uid
should be used as tree label or not. - showWebeditButtons() - Method in interface de.espirit.firstspirit.access.GenerationContext
-
Deprecated.since 5.0.101 - no replacement.
- SimpleAttribute<T> - Interface in de.espirit.or.schema
-
Definition of a simple attribute.
- SimpleEditorValue - Interface in de.espirit.firstspirit.access
-
Base interface for input components providing a simple text representation.
- since() - Element in annotation interface de.espirit.common.ApiDoc
- since() - Element in annotation interface de.espirit.common.GomDoc
-
Version, since when the type is available.
- SINGLE - Static variable in interface de.espirit.firstspirit.service.treedata.editor.TNodes
-
Selection value: single selected.
- SINGLE_PAGE_PARAMS - Static variable in class de.espirit.firstspirit.access.store.MultiPageParams
- SINGLE_PAGE_PARAMS - Static variable in class de.espirit.firstspirit.access.store.PageParams
-
Static instance which may be used as page params for 'single pages'.
- SITE - Enum constant in enum class de.espirit.firstspirit.base.store.PreviewUrl.Type
-
Preview URL of type site.
- SITE - Enum constant in enum class de.espirit.firstspirit.base.store.StoreType
-
SiteStore
- SITE_STORE_FOLDER_REFERENCE - Static variable in interface de.espirit.firstspirit.access.ReferenceEntry
-
pagefolder:"name", e.g. in $CMS_RENDER(pagefolder:"name",
- SITE_STORE_REFERENCE - Static variable in interface de.espirit.firstspirit.access.ReferenceEntry
-
Reference from/to a site-store element.
- SITESTORE - Enum constant in enum class de.espirit.firstspirit.access.store.Store.Type
- SITESTORE_FOLDER - Enum constant in enum class de.espirit.firstspirit.access.store.IDProvider.UidType
-
UidType for
SiteStoreFolder
- SITESTORE_LEAF - Enum constant in enum class de.espirit.firstspirit.access.store.IDProvider.UidType
-
UidType for
PageRef
andDocumentGroup
- SiteStoreFolder - Interface in de.espirit.firstspirit.access.store.sitestore
-
Interface providing means to operate on site store folders.
- SiteStoreRoot - Interface in de.espirit.firstspirit.access.store.sitestore
-
This interface provides methods to handle the SiteStore-Root
- SiteStoreVariableValue - Interface in de.espirit.firstspirit.access.editor
-
Deprecated.since 5.2.21 - use
FormField
instead - size() - Method in class de.espirit.or.query.ComposedConstraint
-
Returns the number of sub constraints.
- size() - Method in interface de.espirit.or.schema.Identifier
-
Returns the value count of this identifier.
- size() - Method in class de.espirit.or.schema.KeyValue
-
Provides the size of the key value.
- SMALLER - Enum constant in enum class de.espirit.or.query.Constraint.Type
-
Type identifying the
LessThan
constraint - SMALLER_OR_EQUAL - Enum constant in enum class de.espirit.or.query.Constraint.Type
-
Type identifying the
LessThanEqual
constraint - SNAPSHOT - Enum constant in enum class de.espirit.firstspirit.access.export.BackupType
- SNAPSHOT_EXPORT_EXTENSION - Static variable in interface de.espirit.firstspirit.access.export.ExportFile
- SNAPSHOT_EXPORT_SUFFIX - Static variable in interface de.espirit.firstspirit.access.export.ExportFile
- Snippet - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface representing a snippet definition.
See the section 'Snippet' of the ODFS (online documentation - /help/odfs/template-develo/snippets/index.html) for further information. - SnippetAgent - Interface in de.espirit.firstspirit.agency
-
Agent providing access to stored element snippet information.
- SnippetAgent.Fallback - Interface in de.espirit.firstspirit.agency
-
Fallback configuration object definition.
- SnippetContainer - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface providing means to access snippet definitions.
- SnippetContext - Class in de.espirit.firstspirit.agency
-
A configuration definition to provide contextual information being used in snippet building.
- SnippetContext() - Constructor for class de.espirit.firstspirit.agency.SnippetContext
-
Creates a snippet context with default values for type (
Store.Type.PAGESTORE
and release (false
). - SnippetProvider - Interface in de.espirit.firstspirit.store.snippets
-
Interface providing access to template snippet definitions.
- SOCKET - Static variable in interface de.espirit.firstspirit.access.admin.WebstartConfiguration
-
Connection mode socket.
- SOCKET_DEFAULT_COMPRESSION - Static variable in class de.espirit.firstspirit.access.ConnectionManager
-
Default compression level for SOCKET-mode.
- SOCKET_DEFAULT_ENCRYPTION - Static variable in class de.espirit.firstspirit.access.ConnectionManager
-
Default encryption level for SOCKET-mode.
- SOCKET_MODE - Static variable in class de.espirit.firstspirit.access.ConnectionManager
-
Use Socket-Mode for communication
- SOCKET_PORT - Static variable in class de.espirit.firstspirit.server.configuration.ServerProperties
-
Socket port of the FirstSpirit server.
- SocketParam(String, int, byte, byte, Proxy) - Constructor for class de.espirit.firstspirit.access.ConnectionManager.SocketParam
-
Constructs this container by the given arguments.
- SOLE_LANGUAGE - Static variable in interface de.espirit.firstspirit.access.editor.EditorValue
-
Deprecated.Language used for language independent editor values.
- split(String) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.split(String)
. - split(String, int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.split(String, int)
. - SS_DOCUMENTGROUP - Enum constant in enum class de.espirit.firstspirit.base.store.StoreElementType
-
SiteStore document group.
- SS_FOLDER - Enum constant in enum class de.espirit.firstspirit.base.store.StoreElementType
-
SiteStore folder.
- SS_GROUP - Enum constant in enum class de.espirit.firstspirit.base.store.StoreElementType
-
SiteStore group.
- SS_PAGE - Enum constant in enum class de.espirit.firstspirit.base.store.StoreElementType
-
SiteStore page reference.
- SS_ROOT - Enum constant in enum class de.espirit.firstspirit.base.store.StoreElementType
-
SiteStore root.
- STABLE - Enum constant in enum class de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo.Quality
-
Quality state representing a stable version.
- STANDARD - Enum constant in enum class de.espirit.firstspirit.access.store.templatestore.gom.ConvertEntity
-
Conversion mode for standard unicode characters.
- start - Variable in class de.espirit.firstspirit.access.store.templatestore.gom.Range
-
The range's start.
- startDifferentialBackup(BackupParameters) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Start differential project repository backup export.
- startExport(ExportParameters) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Start project export.
- startImport(ImportParameters) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Start project import.
- startIncrementalBackup(BackupParameters) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Start incremental project repository backup export.
- StartNode - Interface in de.espirit.firstspirit.access.store.sitestore
-
This interface combines elements which could be start nodes in sitestore.
- startPartialInstall(long, Map<String, String>, List<ExportFile>) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Install incremental or differential backup file into a existing project.
- startProjectRevert(long, String) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Revert a project to a state after a snapshot has been installed.
- startSnapshotExport(BackupParameters) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage
-
Start project snapshot export.
- startsWith(String) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.startsWith(String)
. - startsWith(String, int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.startsWith(String, int)
. - State - Interface in de.espirit.firstspirit.workflow.model
-
This interface represents an state in an workflow-model.
- STATE - Static variable in interface de.espirit.firstspirit.workflow.model.WorkflowElement
-
This workflow-element implements State.
- STATE_KEY - Static variable in interface de.espirit.firstspirit.access.editor.ToggleEditorValue
-
Deprecated.Key to store the toggle state.
- states() - Method in interface de.espirit.firstspirit.workflow.model.Workflow
-
Returns all states that belongs to this workflow.
- STATISTIC_START - Static variable in class de.espirit.firstspirit.server.configuration.ServerProperties
-
Full hour at which statistics data is gathered on a daily basis.
- stopExecution() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryControl
-
Stops the execution of this schedule entry.
- stopMaintenance(long) - Method in interface de.espirit.firstspirit.access.AdminService
-
Deprecated.since 5.2.518, 5.2.605 - use
MaintenanceModeAgent.stopMaintenanceMode(MaintenanceModeInfo)
. - stopServer() - Method in interface de.espirit.firstspirit.access.AdminService
-
Initiates shutdown of the FIRSTspirit Server.
- Store - Interface in de.espirit.firstspirit.access.store
-
These are the valid store types:
Store.Type.PAGESTORE
Store.Type.MEDIASTORE
Store.Type.CONTENTSTORE
Store.Type.SITESTORE
Store.Type.TEMPLATESTORE
Store.Type.GLOBALSTORE
- STORE_ELEMENT - Enum constant in enum class de.espirit.firstspirit.access.Task.Mode
-
Mode for
StoreElement
. - STORE_ELEMENT_NOT_FOUND - Enum constant in enum class de.espirit.firstspirit.access.Task.ErrorCode
-
StoreElement
not found. - STORE_ELEMENT_REFERENCE - Static variable in interface de.espirit.firstspirit.access.ReferenceEntry
-
Reference from/to a store element.
- STORE_ELEMENT_TASK_NOT_REFERENCED - Enum constant in enum class de.espirit.firstspirit.access.Task.ErrorCode
-
Task
is not referenced inStoreElement
. - Store.Type - Enum Class in de.espirit.firstspirit.access.store
-
The type of this store (e.g.
- StoreElement - Interface in de.espirit.firstspirit.access.store
- StoreElementFilter - Class in de.espirit.firstspirit.access.store
- StoreElementFilter() - Constructor for class de.espirit.firstspirit.access.store.StoreElementFilter
- StoreElementFilter(Class<StoreElement>) - Constructor for class de.espirit.firstspirit.access.store.StoreElementFilter
- StoreElementFolder - Interface in de.espirit.firstspirit.access.store
-
Marker interface identifying folder elements.
- StoreElementType - Enum Class in de.espirit.firstspirit.base.store
-
The type of a
StoreElement
. - StoreListener - Interface in de.espirit.firstspirit.access.store
-
Listener to receive
Store
changes. - StoreType - Enum Class in de.espirit.firstspirit.base.store
-
The type of a
Store
. - STRATEGY_COPY - Static variable in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Strategy for update conflicts (the local copy and the original have been modified): .
- STRATEGY_ERROR - Static variable in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Strategy for update conflicts (the local copy and the original have been modified): An error is reported and the update / import process is cancelled.
- STRATEGY_IGNORE_NOT_TRANSLATED - Static variable in interface de.espirit.firstspirit.access.project.Project
-
Translation strategy
- STRATEGY_OVERRIDE - Static variable in interface de.espirit.firstspirit.access.packagepool.Subscription
-
Strategy for update conflicts (the local copy and the original have been modified): Override local changes.
- STRATEGY_REPLACE_NOT_TRANSLATED_WITH_BROKEN_LINK_PAGE - Static variable in interface de.espirit.firstspirit.access.project.Project
-
Translation strategy
- STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE - Static variable in interface de.espirit.firstspirit.access.project.Project
-
Translation strategy
- STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE - Static variable in interface de.espirit.firstspirit.access.project.Project
-
Translation strategy
- structureChanged(StoreElement) - Method in interface de.espirit.firstspirit.access.store.StoreListener
-
Called if the path of the given
storeElement
was changed. - Style - Interface in de.espirit.firstspirit.access.store.templatestore
-
Definition of a container defining style specifica.
- StyleTemplate - Interface in de.espirit.firstspirit.access.store.templatestore
-
Interface providing means to operate on style templates.
- StyleTemplateLink - Interface in de.espirit.firstspirit.access.store.templatestore
-
Definition for defining a link to a style template from a rendering component.
- StyleTemplateLink.Region - Enum Class in de.espirit.firstspirit.access.store.templatestore
-
The region targeted by this link.
- subscribePackage(Project) - Method in interface de.espirit.firstspirit.access.packagepool.Package
-
Creates a new
Subscription
to this package from the givenProject
.
TheSubscription
is created with the defaultPublishGroup
. - subscribePackage(Project, PublishGroup) - Method in interface de.espirit.firstspirit.access.packagepool.Package
- Subscription - Interface in de.espirit.firstspirit.access.packagepool
-
This interface provides methods to handle the subscription to a corporate-content
package
. - subSequence(int, int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.subSequence(int, int)
. - substring(int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.substring(int)
. - substring(int, int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType
-
Delegates to
String.substring(int, int)
. - SUBTYPE_HTML - Static variable in interface de.espirit.firstspirit.access.MailService
-
HTML mail type.
- SUBTYPE_PLAIN - Static variable in interface de.espirit.firstspirit.access.MailService
-
Plain mail type.
- SUCCESS - Enum constant in enum class de.espirit.firstspirit.access.schedule.RunState
-
Task execution finished successfully.
- SUNDAY - Enum constant in enum class de.espirit.common.util.WeekDay
-
A week day.
- supply(Image.Consumer<O>) - Method in interface de.espirit.firstspirit.agency.Image
-
Supply the image to the given consumer.
- syncSchemaWithDB(Schema, boolean) - Method in interface de.espirit.or.Session
-
Update the database structure with the given
schema
. - SYST_MVS - Static variable in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Deprecated.since 4.2.34 - replaced by
FtpTarget.FtpServerType.MVS
.getId()
- SYST_NT - Static variable in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Deprecated.since 4.2.34 - replaced by
FtpTarget.FtpServerType.WIN
.getId()
- SYST_OS400 - Static variable in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Deprecated.since 4.2.34 - replaced by
FtpTarget.FtpServerType.OS400
.getId()
- SYST_UNIX - Static variable in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Deprecated.since 4.2.34 - replaced by
FtpTarget.FtpServerType.UNIX
.getId()
- SYST_VMS - Static variable in interface de.espirit.firstspirit.access.schedule.FtpTarget
-
Deprecated.since 4.2.34 - replaced by
FtpTarget.FtpServerType.VMS
.getId()
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form