G-Index (FirstSpirit Access-API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y Z _
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

G

Gadget - Interface in de.espirit.common.base.ui: Marker interface for graphical user interface components.
GadgetContext<E extends GomElement> - Interface in de.espirit.firstspirit.module: API for context information that is provided to Gadget implementations on construction.
Important: The context may change during its lifetime, hence, objects retrieved via the context may be altered or replaced.
GadgetFactory<G extends Gadget,E extends GomElement,C extends GadgetContext<? extends E>> - Interface in de.espirit.firstspirit.module: Interface for a factory that is able to produce a Gadget.
GadgetIdentifier - Class in de.espirit.firstspirit.ui.gadgets: Identifier for gadgets providing information to find named form elements in a gadget model.
GadgetIdentifierProvider - Interface in de.espirit.firstspirit.ui.gadgets: Implementing Gadgets provide an identifier.
GCABody - Interface in de.espirit.firstspirit.access.store.globalstore: Interface representing a body in globalstore.
GCAFolder - Interface in de.espirit.firstspirit.access.store.globalstore: This interface represents folders in globalstore
GCAPage - Interface in de.espirit.firstspirit.access.store.globalstore: Interface providing means to operate on global store pages.
GCASection - Interface in de.espirit.firstspirit.access.store.globalstore: Interface providing means top operate on global store sections.
GENERATE - Enum constant in enum class de.espirit.firstspirit.access.schedule.RemoteTaskType: Marks that generation tasks may be executed.
GENERATE_FULL - Static variable in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Name for default full generation task.
GENERATE_PARTLY - Static variable in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Name for default partial generation task.
generateAbsoluteLinks() - Method in interface de.espirit.firstspirit.access.project.Project: Indicates whether absolute links should be generated.
GenerateElementOperation - Interface in de.espirit.firstspirit.agency: Operation for a synchronous execution of a schedule entry generating a PageRef.
GenerateTask - Interface in de.espirit.firstspirit.access.schedule: Generation task.
GenerateTask.EntityEntry - Interface in de.espirit.firstspirit.access.schedule: An entry referencing an Entity and a PageRef node.
GenerateTask.GenerationSource - Enum Class in de.espirit.firstspirit.access.schedule: Source used for generating.
GenerateTask.SuccessCondition - Enum Class in de.espirit.firstspirit.access.schedule: The condition the generate task should be marked as "finished successful"
GenerateTask.Type - Enum Class in de.espirit.firstspirit.access.schedule: The generation Type used for this generate task
Generating - Interface in de.espirit.firstspirit.scheduling.aspects: Aspect providing means to access information on a performed generation task.
GENERATION - Enum constant in enum class de.espirit.firstspirit.access.BaseContext.Env: Definition of generation environment.
GenerationAgent - Interface in de.espirit.firstspirit.scheduling.agency: Agent providing means to support operating on generating tasks.
GenerationContext - Interface in de.espirit.firstspirit.access: Context definition for generation tasks.
GenerationScriptContext - Interface in de.espirit.firstspirit.access: Context for a script within the generation task.
Generator<R> - Interface in de.espirit.common.function: Deprecated.
since 5.2.231004 - Use Supplier instead
GENERATOR - Static variable in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabAppearance: Deprecated.
since 5.2.231004 - Use ApplicationTabAppearance.BUILDER_GENERATOR instead
GENERATOR - Static variable in interface de.espirit.firstspirit.client.gui.applications.browser.BrowserApplicationConfiguration: Deprecated.
since 5.2.231004 - Use BrowserApplicationConfiguration.CONFIG_GENERATOR instead
GENERATOR - Static variable in interface de.espirit.firstspirit.client.gui.applications.MultiApplicationConfiguration: Deprecated.
since 5.2.231004 - Use MultiApplicationConfiguration.MULTI_CONFIG_GENERATOR instead
GENERATOR - Static variable in interface de.espirit.firstspirit.client.gui.applications.SwingApplicationConfiguration: Deprecated.
since 5.2.231004 - Use SwingApplicationConfiguration.CONFIG_GENERATOR instead
GENERATOR - Static variable in interface de.espirit.firstspirit.server.mediamanagement.exif.ExifData: Deprecated.
since 5.2.231004 - Use ExifData.EXIF_DATA_GENERATOR instead
GENERIC_LINK - Static variable in interface de.espirit.firstspirit.access.link.Link: Deprecated.
since 5.1.43 - no replacement, since 5.0 every link should be "generic".
get() - Method in interface de.espirit.firstspirit.access.editor.value.DomElement: Returns root element.
get() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the referenced element.
get() - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Provides the permissions definition element.
get() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Get the reference of the element currently set in this TargetReference.
get() - Method in interface de.espirit.firstspirit.agency.MPPViewportAgent: Returns a new configuration object containing the multi-perspective viewports of the current project.
get() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabAppearance.Builder: Returns the ApplicationTabAppearance object based on this builder.
get() - Method in interface de.espirit.firstspirit.client.plugin.report.Image: Returns the contained image object.
get() - Method in interface de.espirit.firstspirit.forms.FormField: Provides the current value of the field.
get() - Method in interface de.espirit.firstspirit.forms.RemoteFormField: Provides the current value of the field.
get() - Method in interface de.espirit.firstspirit.server.mediamanagement.exif.ExifValue: The raw value of the extracted exif meta data.
get(int) - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
since 5.2.21 - see type
get(int) - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams.ContentPageParams: Provides a single record stored at the given position.
get(int) - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the record stored at the given index.
get(int) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfos: Provide the language information entry stored at the given index.
get(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomEditorProvider: Getter for GomElements.
get(int) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfos: Getter for GomLangInfos.
get(int) - Method in interface de.espirit.firstspirit.json.JsonArray: Returns the element at the specified position in this array.
get(String) - Method in interface de.espirit.firstspirit.json.JsonObject: Get the value with the specified key.
get(Language, String) - Method in interface de.espirit.firstspirit.forms.FormData: Provides a property container describing the field with the given name.
get(Language, String) - Method in interface de.espirit.firstspirit.forms.RemoteFormData: Provides a property container describing the field with the given name.
get(Language) - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.

Get the value object in the specified language.
get(Language) - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Get the value object in the specified language.
get(Language) - Method in interface de.espirit.firstspirit.access.editor.PictureEditorValue: Deprecated.

Get the value object in the specified language.
get(Language) - Method in interface de.espirit.firstspirit.client.access.editor.CatalogEditorValue: Deprecated.

Get the value object in the specified language.
get(Language) - Method in interface de.espirit.firstspirit.client.access.editor.IndexEditorValue: Deprecated.

Get the value object in the specified language.
get(Language, String) - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreVariableFormData: Provides a property container describing the field with the given name.
get(AspectType<A>) - Method in class de.espirit.firstspirit.aspects.AspectMap: Get the correctly typed aspect for a type.
get(DataAccessAspectType<A>) - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.DataAccessAspectMap: Get the correctly typed aspect for a type.
get(SessionAspectType<A>) - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.SessionAspectMap: Get the correctly typed aspect for a type.
get(SessionBuilderAspectType<A>) - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.SessionBuilderAspectMap: Get the correctly typed aspect for a type.
get(StreamBuilderAspectType<A>) - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.StreamBuilderAspectMap: Get the correctly typed aspect for a type.
get(Parameter<T>) - Method in interface de.espirit.firstspirit.client.plugin.report.ParameterMap: Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
get(ApplicationAspectType<A>) - Method in class de.espirit.firstspirit.scheduling.aspects.ApplicationAspectMap: Get the correctly typed aspect for a type.
get(TransferType<A>) - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.transfer.CommodityContainer: Get the correctly typed commodities for a type.
get(Parameter<T>) - Method in interface de.espirit.firstspirit.webedit.plugin.report.ParameterMap: Deprecated.

Returns the value to which the specified key is mapped, or null if this map contains no mapping for the key.
get(String) - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
since 5.2.21 - see type
get(String) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfos: Provide the language information entry for the given language.
get(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfos: Get a language information entry by the language it is defined for.
get(K) - Method in interface de.espirit.common.util.Dict: Returns the value mapped to the given key or null if the given key isn't mapped.
getAbbreviation() - Method in interface de.espirit.firstspirit.access.Language: Get the abbreviation used for this language, for example "DE" for "German".
getAbbreviation() - Method in interface de.espirit.firstspirit.access.User: Gets the abbreviation of the user.
getAccessFileContent() - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration: Deprecated.
since 5.0 - no replacement
getAcquireAccessLabel() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.DataAccessControlling: Provides a label being used for an action to acquire access.
getActionId() - Method in interface de.espirit.firstspirit.access.ServerActionHandle: Returns the unique id of the belonging server action.
getActionId() - Method in exception de.espirit.firstspirit.access.ServerActionNotFoundException: Returns the invalid server action id being used.
getActionName() - Method in interface de.espirit.firstspirit.access.ServerActionHandle: Returns the name of the belonging server action.
getActions(ClientPluginScope<A>) - Method in interface de.espirit.firstspirit.client.plugin.ClientPlugin: Deprecated.
since 5.0.100 use a specific plug-in type instead (see hierarchy).
getActivatedCustomEvents() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion: Deprecated.
since 5.0.39 - no replacement
getActivateDeployments() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Indicates whether schedule entries imported during theproject import will be activated (default) or not.
getActivateProject() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Indicates whether the imported project will be activated after the project import (default) or not.
getActiveMaintenanceModes() - Method in interface de.espirit.firstspirit.agency.MaintenanceModeAgent: A maintenance mode task is active if one of the stages mentioned in MaintenanceModeTask.MaintenanceStage is active.
getActiveWebServer(String) - Method in interface de.espirit.firstspirit.access.project.Project: Gets the webserver id for the specified webscope
getActiveWebserverConfiguration(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Gets the active webserver for the named web application.
getActivities(IDProvider) - Method in interface de.espirit.firstspirit.access.editor.PermissionsAgent: Provides activities for the given element containing permissions as defined in the meta data field of the fieldname configured in the project.
getActivities(IDProvider, String) - Method in interface de.espirit.firstspirit.access.editor.PermissionsAgent: Provides activities for the given element containing permissions as defined in the meta data field of the given fieldname.
getActivityNames() - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Provides a list of names for defined activities.
getAddedElements() - Method in interface de.espirit.firstspirit.storage.ChildrenChangeDetail: Returns an unmodifiable list of elements which were added during the change of the belonging children list.
getAddedReferences() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail: Returns the set of added references.
getAdminMail() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the administrators email address used to send notification mails to.
getAdminMode() - Method in interface de.espirit.firstspirit.access.User: Returns true if admin mode is enabled for this user.
getAlign() - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Provides the alignment to be applied.
getAll() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams.ContentPageParams: Provides all records for the overall parameters definition.
getAllChildren() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns a list of all (recursive) group children of this group.
getAllChilds() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Deprecated.
since 4.2.200 - use Group.getAllChildren() instead
getAllNameSpaceEnhancements() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Get all defined NameSpaceEnhancement Settings for this package.
getAllOverwriteDuringImportSettings() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Get all defined OverwriteDuringImport Settings for this package.
getAllowed(String) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Returns all allowed group IDs, if the permissions are not inherited.
getAllowedBodies() - Method in interface de.espirit.firstspirit.access.store.templatestore.Allowed: Returns the immutable list of template bodies for which the belonging template is allowed.
Use Allowed.addAllowedBody(TemplateBody) and Allowed.removeAllowedBody(TemplateBody) to modify this list.
getAllowedExplicit(String) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Returns all explicitly allowed group paths, if the permissions are not inherited.
getAllowedExtensions() - Method in interface de.espirit.firstspirit.access.project.MediaConstraints: Get the allowed file name extensions.
getAllowedGroupNames() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: The server administrator may always connect to the server, even if the maintenance mode is active.
getAllowedGroups() - Method in interface de.espirit.firstspirit.access.editor.Activity: Provides a set of names of groups allowed for this activity.
getAllowedGroups() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission: Get all groups which users are allowed to execute the workflow.
getAllowedGroups() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowTransitionPermission: Provides the user groups allowed to perform the transition.
getAllowedGroups() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns all groups that are allowed to do this transition.
getAllowedLinkTemplates() - Method in interface de.espirit.firstspirit.access.editor.DomEditorValue: Deprecated.

Get a list of allowed link types.
getAllowedLinkTemplates() - Method in interface de.espirit.firstspirit.access.editor.DomTableEditorValue: Deprecated.

Get a list of allowed link types.
getAllowedLinkTemplates() - Method in interface de.espirit.firstspirit.access.editor.LinkEditorValue: Deprecated.

Get a list of allowed link types.
getAllowedLinkTemplates() - Method in interface de.espirit.firstspirit.access.editor.LinkListEditorValue: Deprecated.

Get a list of allowed link types.
getAllowedRedirectHosts() - Method in interface de.espirit.firstspirit.agency.ServerConfigurationAgent: In order to prevent redirections to potentially malicious hosts, a whitelist of allowed host names can be configured for the FirstSpirit server.
getAllowedSectionTemplates() - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.

Returns an unmodifiable iterable of allowed section templates which could be used to create new sections.
getAllowedTemplates() - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.
since 4.2.200 - use ContentAreaListValue.getAllowedSectionTemplates() instead
getAllowedTemplates(TemplateBody) - Method in interface de.espirit.firstspirit.access.store.templatestore.PageTemplate: Get the list of section- or table templates which are allowed for this page template for the given template body.
Note: If there aren't any allowed definitions for this pagetemplate, all existing section- and table templates will be returned.
getAllowedTemplates(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.PageTemplate: Get the list of section or table templates which are allowed for this template for a given body
getAllowedUsers() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: The server administrator may always connect to the server, even if the maintenance mode is active.
getAllowedUsers() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowPermission: Get all users which are allowed to execute the workflow.
getAllowedUsers() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowTransitionPermission: Provides the users allowed to perform the transition.
getAllowedUsers() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns all user that are allowed to do this transition.
getAllowEmpty() - Method in interface de.espirit.firstspirit.access.editor.DateEditorValue: Deprecated.

Provides an indicator specialized for dates and may be different from what DateEditorValue.getForm() provides.
getAllowEmpty() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Indicates, whether the form element allows to stay empty.
getAllowEmpty() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement: Indicates, whether leaving the form empty is allowed.
getAllowEveryone() - Method in interface de.espirit.firstspirit.access.project.Project: Indicates whether everyone is allowed to access this project.
getAllowInteractiveExecution() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: true if interactive execution is allowed, false otherwise (default).
getAllowLanguageHiding() - Method in interface de.espirit.firstspirit.access.project.Project: Returns true if project users are allowed to switch the display of language tabs in this project.
getAllowUidChanges() - Method in interface de.espirit.firstspirit.access.project.Project: Returns true if project users are allowed to change UIDs.Admins may always change UIDs.If the UID of an element may be changed is also determined by the change permission of the corresponding element.
getAllPages(StoreElement) - Method in interface de.espirit.firstspirit.access.store.globalstore.GlobalStoreRoot: Deprecated.
since 5.0.100 - use getChildren(GCAPage.class) instead
getAllParents() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns a list of all parents existing on the parent path of this group.
getAllScripts() - Method in interface de.espirit.firstspirit.access.store.templatestore.ScriptContainer: Deprecated.
since 5.0.100 - use getChildren(Script.class), true instead
getAllTextsType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Convenience accessor providing the transfer type representing an all text access.
getAlternativeTypes() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides alternative value types the mapping can work with.
getAlternativeUrls(ContentProducer, Language, TemplateSet) - Method in interface de.espirit.firstspirit.access.store.globalstore.URLProperties: Get the list of alternative URLs for the specified parameter set.
getAltText() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the alt text.
getAlwaysActive() - Method in interface de.espirit.firstspirit.access.store.templatestore.Workflow: Deprecated.
since 5.1.32 use Workflow.isAlwaysActive()
getAnchorName() - Method in interface de.espirit.firstspirit.access.editor.value.SectionListEntry: Get the section's anchor name.
getAnnotation(Class<T>) - Method in class de.espirit.firstspirit.access.store.templatestore.gom.Item: Provides all annotations defined for the given class.
getApiType() - Method in interface de.espirit.firstspirit.server.scheduler.DeployTargetFactory: Provides the API type of this factory.
getApiType() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleTaskFactory: Provides the API type for tasks being created by this factory.
getAppearance() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabConfiguration: The appearance for the application tab.
getAppendDateToDirectoryName() - Method in interface de.espirit.firstspirit.access.schedule.FileTarget: Returns true if date should be append to directory name, false otherwise.
getAppendLogFiles() - Method in interface de.espirit.firstspirit.access.schedule.MailTask: true if log files should be attached to this mail, false otherwise
getAppletEditors() - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.0 - no replacement
getApplication() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTab: Returns the application inside this tab.
getApplication(ApplicationType<T, C>, Object) - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationService: Returns an application specified by the given type and tabIdentifier or null ifit doesn't exists.
getApplicationIcon() - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the current application icon.
getApplicationWindow() - Method in interface de.espirit.firstspirit.agency.UIAgent: Provide the application window.
getAreas() - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium: Provides the areas defined for mapping to links.
getAspect(AspectType<A>) - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Request an aspect from the aspectable.
getAspect(AspectType<T>) - Method in interface de.espirit.firstspirit.aspects.Aspectable: Request an aspect from the aspectable.
getAspect(ValueEngineerAspectType<T>) - Method in interface de.espirit.firstspirit.client.access.editor.ValueEngineer: Request an aspect of the given type.
getAspect(DataAccessAspectType<A>) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessPlugin: Look up a specific aspect that may be supported by this plug-in.
Attention: This method may be called very often and must return very fast.
getAspect(SessionAspectType<A>) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessSession: Look up a specific aspect that may be supported by this plug-in.
Attention: This method may be called very often and must return very fast.
getAspect(SessionBuilderAspectType<A>) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessSessionBuilder: Look up a specific aspect that may be supported by this builder.
Attention: This method may be called very often and must return very fast.
getAspect(StreamBuilderAspectType<A>) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataStreamBuilder: Look up a specific aspect that may be supported by this builder.
Attention: This method may be called very often and must return very fast.
getAspect(ScheduleTaskAspectType<A>) - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskControl: Provides aspects of the underlying task.
getAspect(ApplicationAspectType<A>) - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskApplication: Look up a specific aspect that may be supported by this application.
getAssociation(String) - Method in interface de.espirit.firstspirit.webedit.DataAssociationHandler: Gets the association belonging to the specified identifier, or null if theidentifier is invalid or unknown.
getAssociationType() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.DataAssociating: Returns the type of data assocation this aspect is working on.
getAttribute() - Method in exception de.espirit.firstspirit.access.DuplicateReferenceNameException: Returns the name of the uid attribute.
getAttribute() - Method in class de.espirit.or.query.Order: Returns the name of the attribute this order criteria is related to.
getAttribute(String) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.UrlGenerationContext: Lookup an attribute with the given name in this generation context.If the attribute is not available Optional.empty() will be returned.
getAttribute(String) - Method in interface de.espirit.firstspirit.generate.functions.json.JsonGenerationContext: Lookup an attribute with the given name in the current stack.
getAttribute(String) - Method in interface de.espirit.or.schema.EntityType: Return the attribute with the given name.
getAttribute(String, Class<T>) - Method in interface de.espirit.or.schema.EntityType: Provides the attribute with the given name if it is of the requested type.
getAttribute(Object, String) - Method in interface de.espirit.firstspirit.access.template.Evaluator: Reads the value for the named attribute from the given instance.
getAttribute(String) - Method in class de.espirit.firstspirit.client.access.editor.Node: The value of the attribute with the specified name.
getAttributeName() - Method in class de.espirit.or.query.AbstractConstraint: Return the name of the attribute this constraint belongs to.
getAttributeName() - Method in interface de.espirit.or.query.AttributeConstraint: Return the name of the attribute this constraint belongs to.
getAttributeNames() - Method in interface de.espirit.or.schema.Entity: Return a collection of the attributes declared for this entity.
getAttributeNames() - Method in interface de.espirit.or.schema.EntityType: Return a name list of all declared attributes.
getAttributeReference(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the chain of attributes names to the attribute which should be displayed.
getAttributes() - Method in interface de.espirit.or.schema.EntityType: Return all declared attributes by this entity type.
getAuthorisedUsers() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Gets an unmodifiable list of authorised User's of this package.
getAvailableAttributeName(String) - Method in interface de.espirit.or.schema.EntityType: Provides the next available name for an attribute starting with name as its base.
getAvailableCustomScriptNames() - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Deprecated.
since 5.0.39 - no replacement
getAvailableLayerIds() - Method in interface de.espirit.firstspirit.access.database.Layer: Returns the ids of all available layers in the system.
getAvailableRulesets(long) - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService
getAvailableRulesetsFromCache(long) - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService
getAvailableUrlCreatorSpecifications() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Get available url creators.
getAverageDuration() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryStatistic: Returns the average execution time in milliseconds
getBackupCachedPictures() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get export cached picture resolutions state.
getBackupDate() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupFile: Returns the date of the backup or ServerBackupFile.UNKNOWN_BACKUP_DATE if the date of the backup is unknown.
getBackupEmail() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2: Provies the e-mail address to send a back up mail to.
getBackupEmail() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Get email address for backup information
getBackupRestore() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Returns true if this import is a project backup restore.
getBackupTableData() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Include table data in backup.
getBackupTableData() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2: Indicates whether to back up table data.
getBackupType() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2: Provides the type of backup to be performed.
getBasePath() - Method in interface de.espirit.firstspirit.access.GenerationContext: Provides the base path for this generation.
getBaseType() - Method in interface de.espirit.firstspirit.server.mediamanagement.mime.MimeType: Returns the base type.
getBaseUrl() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The base url.
getBCCRecipients() - Method in class de.espirit.firstspirit.access.MailHeader: A semicolon-separated list of blind carbon copy (BCC) recipients.
getBegin() - Method in class de.espirit.firstspirit.access.search.Match: Provides the starting position of the match within the text it bases upon.
getBodies() - Method in interface de.espirit.firstspirit.access.store.templatestore.PageTemplate: Returns the list of template bodies which are defined in this template.
getBody(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.PageTemplate: Returns the template body specified by the given name or null if no body exists with the given name.
getBodyByName(String) - Method in interface de.espirit.firstspirit.access.store.pagestore.Page: Searches for the body with the given name in this page.
getBorderColor() - Method in enum class de.espirit.firstspirit.ui.gadgets.aspects.Mark: Provides the color to be used for markup.
getBorderThickness() - Method in enum class de.espirit.firstspirit.ui.gadgets.aspects.Mark: Provides the thickness to be used for markup.
getBorderType() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabAppearance: The type of colored border line between main and sub tabs related to the store color specified by the store type.
getBorderWidth() - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium: Provides the border width to be used.
getBounds() - Method in interface de.espirit.firstspirit.webedit.plugin.focus.FocusArea: Bounds as pixels specifying the focus area in relation to the original image size, where the top-left corner is represented by the coordinate 0x0.
getBranch() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the name of the branch of the belonging FirstSpirit version or null.
Non-existent branch (null) indicates that the belonging FirstSpirit version is a stable version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return 'BETA'. If the FirstSpirit server runs with "5.0.50.68430" this method will return null.
getBrokenLinkMedia() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the UID of a media element to be shown when displaying a broken link.
getBrokenLinkPage() - Method in interface de.espirit.firstspirit.access.project.Project: Provides a UID of a page reference to be shown when displaying a broken link.
getBrokenReferences() - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.2.301, use ProjectReferencesAgent.getBrokenReferences(boolean).
getBrokenReferences(boolean) - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.2.301, use ProjectReferencesAgent.getBrokenReferences(boolean).
getBrokenReferences(boolean) - Method in interface de.espirit.firstspirit.agency.ProjectReferencesAgent: Get all broken references from all current or release stores.
getBroker() - Method in interface de.espirit.firstspirit.access.Connection: Returns broker without project binding.
getBroker() - Method in interface de.espirit.firstspirit.client.access.editor.ValueEngineerContext: Provides access to a specialitsts broker.
getBroker() - Method in interface de.espirit.firstspirit.module.GadgetContext: Provides access to a specialists broker.
getBroker() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Provides access to a specialists broker.
getBroker() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Access the broker providing access to specialists on application knowledge.
getBroker() - Method in interface de.espirit.firstspirit.webedit.plugin.translation.TranslationContext: A request local specialists broker, providing access to client operations.
getBroker(long) - Method in interface de.espirit.firstspirit.agency.BrokerAgent: Get hold of a broker operating on the given revision.
getBroker(String) - Method in interface de.espirit.firstspirit.agency.BrokerAgent: Try getting hold of a broker for a remote project registered under the given symbolic name.
getBrokerByProjectId(long) - Method in interface de.espirit.firstspirit.agency.BrokerAgent: Returns a broker related to the project specified by given projectId or null if no project exists with the given ID or the current user has no access to the project.
getBrokerByProjectName(String) - Method in interface de.espirit.firstspirit.agency.BrokerAgent: Returns a broker related to the project specified by given projectName or null if no project exists with the given name or the current user has no access to the project.
getBrowserEngineFileExtensions() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Returns a comma separated list file name extensions.
getBrowserType() - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewItem: Returns the browser type to be used for opening an application tab, or null if the current default browser should be used.
getBuild() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the build number of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '31'.
getBuilder() - Static method in class de.espirit.firstspirit.access.MailHeader: Create a new builder for a MailHeader.
getBuilder() - Method in interface de.espirit.firstspirit.agency.ProcessAgent: Get a fresh process builder instance.
getBuilder(ClientUrlAgent.ClientType<T>) - Method in interface de.espirit.firstspirit.agency.ClientUrlAgent: Returns a client type respecting url builder.
getBuildVersion() - Method in interface de.espirit.firstspirit.access.export.ProjectInfo
getByteCount() - Method in interface de.espirit.firstspirit.feature.FeatureProgress: The byte count written up to now during feature transport file creation.
getBytes() - Method in class de.espirit.firstspirit.common.text.AbstractTextType: Delegates to String.getBytes().
getBytes(int, int, byte[], int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType: Delegates to String.getBytes(int, int, byte[], int).
getBytes(String) - Method in class de.espirit.firstspirit.common.text.AbstractTextType: Delegates to String.getBytes(String).
getCaasSlots() - Method in interface de.espirit.firstspirit.license.LicenseService: Returns maximum available number of CaaS slots.
getCacheWeight() - Method in interface de.espirit.firstspirit.access.project.Project: Get cache weight.
getCallMode() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext: Returns the call mode of the current Task
getCancelScheduleWhenNoChanges() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: true if execution should be canceled if there are no changes, false otherwise.
getCaseMode() - Method in interface de.espirit.or.Layer: Provides the mode for letter case handling.
getCaseMode() - Method in interface de.espirit.or.schema.Schema: Get the case mode of the underlying database: lower, upper, or mixed case.
getCaseModeForDbName() - Method in interface de.espirit.or.Layer: Case mode for database name.
getCatalog() - Method in interface de.espirit.or.Layer: Return the catalog (database) assigned with this layer.
getCategory() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Returns the category of an external reference.
getCategory() - Method in interface de.espirit.firstspirit.client.access.editor.ExternalReferenceHolder: The category of the reference.
getCategory() - Method in class de.espirit.firstspirit.event.TrackingEvent: Returns the category to group tracking points by, if available
getCategory() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ExternalReference: Get the category of the reference.
getCCRecipients() - Method in class de.espirit.firstspirit.access.MailHeader: A semicolon-separated list of carbon copy (CC) recipients.
getCdata() - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Indicates this style to represent CDATA.
getCell(int, int) - Method in interface de.espirit.firstspirit.access.editor.value.Table: Gets the cell of this table with the given row & col index or null if no cell exists with these indices.
getCell(Language, int, int) - Method in interface de.espirit.firstspirit.access.editor.DomTableEditorValue: Deprecated.

Gets the cell of this dom table with the given row & col index or null if no cell exists with these indices.
getCenter() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.CircleArea: Provide the center coordinate of the circle.
getChanged() - Method in interface de.espirit.or.Session: Return the set of modified and not yet committed entities in this session.
getChangedEntities() - Method in interface de.espirit.firstspirit.storage.ContentOperation: Returns an unmodifiable collection of entity infos indicating entities which were changed during the belonging content commit of this content operation
getChangedStoreElements() - Method in interface de.espirit.firstspirit.storage.RevisionMetaData: Returns an unmodifiable map of storeelement changes indicating all changes processed in the belonging revision.
getChangeFlag() - Method in interface de.espirit.firstspirit.storage.DataChangeDetail.EditorChange: Returns the change flag of this editor change.
getChangeFlag() - Method in interface de.espirit.firstspirit.storage.DataChangeDetail: Returns the change flag of the underlying data change.
DataChangeDetail.ChangeFlag.ADDED if the belonging data xml was initially created DataChangeDetail.ChangeFlag.CHANGED if the belonging data xml has been changed
getChangeFlag() - Method in interface de.espirit.firstspirit.storage.PermissionChangeDetail: Returns the change flag of this permission change.
getChanges() - Method in interface de.espirit.firstspirit.event.RevisionEvent: Get all change operations for this revision.
getChangeState() - Method in interface de.espirit.firstspirit.access.store.PackagePoolItem: Returns the change state of this PackagePoolItem either PackagePoolItem.UNMODIFIED, PackagePoolItem.MODIFIED or PackagePoolItem.BLOCKED. -1 will be returned for items which aren't subscribed item'sor if the state could not be established
getChangeType() - Method in interface de.espirit.firstspirit.storage.RevisionChangeDetail: Returns the change type this revision change detail belongs to.
getChannel(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate: Provides the channel specifica with respect to the given template set.
getChannel(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Provides the channel specifica for the given template set.
getChannelSource(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.templatestore.ChannelSourceProvider: Get the source for the channel specified by the given templateset.
getChar() - Method in interface de.espirit.firstspirit.client.common.text.CharContainer: Provide the charactor of this container.
getCharacterReplacer(boolean) - Method in interface de.espirit.firstspirit.access.GenerationContext: Get a character replacer instance for replacing special characters in the content that will be generated
getCharacterReplacer(boolean) - Method in interface de.espirit.firstspirit.access.project.ConversionTable: Provides an object that enables to convert a text based on this conversion table.
getChars(int, int, char[], int) - Method in class de.espirit.firstspirit.common.text.AbstractTextType: Delegates to String.getChars(int, int, char[], int).
getCheckFreeSpace() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Returns true if a check for sufficient free disk space is performed on the server before the import process is started to make sure the import completes successfully.
getChild(String) - Method in interface de.espirit.firstspirit.io.FileHandle: Get a handle on the child with the given name.
getChildAt(int) - Method in interface de.espirit.firstspirit.access.template.TemplateElement: Provides the child element stored at the given index.
getChildCount() - Method in interface de.espirit.firstspirit.access.store.StoreElement
getChildCount() - Method in interface de.espirit.firstspirit.access.template.TemplateElement: Provides the number of children of this element.
getChildCount() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns the number of children.
getChildIndex(StoreElement) - Method in interface de.espirit.firstspirit.access.store.StoreElement
getChildModel(boolean) - Method in interface de.espirit.firstspirit.access.editor.value.OptionModel: Get a child model, i.e., a reference to the option model that can store a seperate option as selection.
A child model can be said to operate strict, i.e., only values contained in the model can be set as selected.
getChildren() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns all direct child nodes.
getChildren() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Get the element's direct children.
getChildren() - Method in class de.espirit.firstspirit.client.access.editor.Node: The list of child nodes.
getChildren() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns a collection of all direct sub group children.
getChildren() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns children.
getChildren() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportElementInfo: Provides the information containers for the element's children.
getChildren(boolean) - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns children, maybe recursivly.
getChildren(Class<T>) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Get the element's direct children that are instances of the given type.
getChildren(Class<T>, boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Get the element's children that are instances of the given type.
getChildren(Filter.TypedFilter<T>, boolean) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Get the element's children passing the given typed filter.
getCircleBuilder() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.ImageMapAgent: Provides a builder for circular areas.
getClassLoader() - Method in interface de.espirit.firstspirit.access.Connection: Returns a class loader which can load classes from the server and from module libraries.
getClassLoader() - Method in interface de.espirit.firstspirit.access.ModuleAgent: Returns a class loader instance which is capable of loading all global module classes.
getClauses() - Method in class de.espirit.firstspirit.access.search.Match: Provides the clauses, which were matched.
getClauses() - Method in class de.espirit.firstspirit.access.search.Request: Provides the clauses to be matched for this request.
getCleanupAge() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns the minimum number of days of version history to keep on partial cleanup.
getClickItem() - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.ReportItemsProviding.Adapter: Returns the click item of this report plugin.
getClickItem() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.ReportItemsProviding: Returns the click item of this report plugin.
getClientJarSize() - Method in class de.espirit.firstspirit.access.ConnectionManager.ClientJarInputStream: Provides the size of the jar.
getClientVersion() - Method in exception de.espirit.firstspirit.access.store.VersionMismatchException
getClusterFirstSpiritPath() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Gets the path of the cluster server.
getClusterMasterHost() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the host of the master cluster server.
getClusterMasterPort() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the port of the master cluster server.
getClusterNodeName() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: If the task execution should run on a cluster node a node may be specified for execution.
getClusterSlaveName() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the name of the slave cluster server.
getColor() - Method in enum class de.espirit.firstspirit.access.editor.value.Modification: Returns the color related to the modification.
getColor() - Method in interface de.espirit.firstspirit.access.Workflowable: Get the color of the current state.
getColor() - Method in interface de.espirit.firstspirit.webedit.plugin.status.WebeditStatusNote: Returns the color associated with this status information.
getColor() - Method in interface de.espirit.firstspirit.workflow.model.State: Returns the color that represents this state in the tree-model.
getColSpan() - Method in interface de.espirit.firstspirit.access.editor.value.TableCell: Returns the colspan defined for this table cell.
getColumn() - Method in interface de.espirit.firstspirit.access.editor.value.TableCell: Return the column index of this cell.
getColumn() - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink: Returns the number of the column this rule should be used for.
For regions different to Region.CUSTOM -1 will be returned.
getColumn() - Method in exception de.espirit.firstspirit.access.template.ParsingError: Provides the column where the problem occurred.
getColumn() - Method in interface de.espirit.or.schema.SimpleAttribute
getColumnRegion() - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink: Returns the column region set for this rule.
getColumns() - Method in interface de.espirit.firstspirit.access.editor.value.Table: Returns the numer of existing columns in this table
getColumns(Language) - Method in interface de.espirit.firstspirit.access.editor.DomTableEditorValue: Deprecated.

Provides the number of columns for the given language.
getColumnWidth() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Width of displayed columns.
getComment() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Gets a comment.
getComment() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Returns the comment of this package.
getComment() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion: Returns the comment of this PackageVersion.
getComment() - Method in interface de.espirit.firstspirit.access.schedule.TaskResult: Returns the comment set in the ScheduleContext.
getComment() - Method in interface de.espirit.firstspirit.access.store.ElementInfo
getComment() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: Provides a comment for this group.
getComment() - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec: Get the comment of the folder in the specific language.
getComment() - Method in interface de.espirit.firstspirit.access.store.templatestore.Script: Provides the comment set for this script.
getComment() - Method in interface de.espirit.firstspirit.access.store.templatestore.Template: Get the comment of the Template
getComment() - Method in interface de.espirit.firstspirit.access.TaskErrorInfo: Get error comment, if it has been set.
getComment() - Method in interface de.espirit.firstspirit.access.TaskState: The user specified state comment.
getComment() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Get task comment.
getComment() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the comment of this revision.
getComment() - Method in interface de.espirit.firstspirit.storage.Tag: Returns the comment of this tag.
getCommitOrCreationTime() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the time of commit or the creation time if the revision is not commited yet.
getComparator() - Method in enum class de.espirit.or.CaseMode: CaseMode.UPPER_CASE.getComparator().compare("products", "PRODUCTS") will yield 0.
getComponent() - Method in interface de.espirit.firstspirit.ui.gadgets.swing.SwingComponentProvider: Provides a Swing based component.
getComponentByName(String) - Method in class de.espirit.firstspirit.module.descriptor.ModuleDescriptor: Returns a component by its name or null if it couldn't be found.
getComponentClass() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns component class-name.
getComponentFactory() - Method in interface de.espirit.firstspirit.client.gui.applications.SwingApplicationConfiguration: Returns the component factory which will be used to create the swing component used for the swing application which will be created based on this configuration.
getComponents() - Method in class de.espirit.firstspirit.module.descriptor.ModuleDescriptor: Returns all components of this module.
getComponents(Class<?>) - Method in interface de.espirit.firstspirit.access.ModuleAgent: Returns all components which implements or extends the given type.
getCompression() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the compression level to apply when using Java Web Start.
getCompression() - Method in class de.espirit.firstspirit.access.ConnectionManager.SocketParam: Provides the compression type used.
getCompression(int) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Get the used compression for the specified connection mode.
getConcurrentTaskHandling() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: Indicates if other tasks may be executed while the maintenance mode is active.
getConcurrentTaskHandling() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: Indicates if other tasks may be executed while the maintenance mode is active.
getConfDir() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Returns the configuration directory of this environment.
getConfiguration() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns configuration string.
getConfiguration() - Method in interface de.espirit.firstspirit.module.descriptor.Descriptor: Returns configuration string.
getConfigurationClass() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns configuration class-name.
getConfigurator(Class<C>) - Method in interface de.espirit.firstspirit.ui.operations.DisplayElementOperation: Provides an instance of a configurator as requested by the given type.
getConflictMode() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: The conflict mode defines a strategy to handle conflicts which occurs during the import of this subscription.
A conflict occurs, when the local copy and the source of a subscribed element both have been changed since the last update of the subscription.
getConflictNode(int) - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the conflicted node at the specified index.
Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
getConflictNodeCount() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the count of nodes which caused conflicts during belonging package import.
getConnection() - Method in interface de.espirit.firstspirit.access.AdminService: Provides access to the connection.
getConnection() - Method in interface de.espirit.firstspirit.access.Host: Return the Connection
getConnection() - Method in interface de.espirit.firstspirit.access.ScriptContext: Return the Connection for the script context
getConnection() - Method in interface de.espirit.firstspirit.access.UserService: Get the connection of this userservice.
getConnection() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Returns the connection.
getConnection(String, int, int, String, String, CallbackHandler) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Create a connection accessor to a FirstSpirit server.
getConnection(String, int, int, String, String) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Create a connection to a FIRSTspirit server instance, the physical connection is not already established after this call.
getConnection(String, int, int, String, String, String) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Create a connection to a FIRSTspirit server instance, the physical connection is not already established after this call.
getConnection(String, int, int, String, String, Map<?, ?>) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Create a connection to a FIRSTspirit server instance, the physical connection is not already established after this call.
getConnection(String, int, int, String, Map<?, ?>) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Create a connection to a FIRSTspirit server instance, the physical connection is not already established after this call.
getConnectionConstant() - Method in enum class de.espirit.or.Layer.TransactionIsolationLevel: Isolation level which could be passed to Connection.setTransactionIsolation(int).
getConnectionMode() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the connection mode of this Web Start configuration.
getConnectionRetry() - Method in class de.espirit.or.ConnectionConfiguration: Get the number of max retries for the connection.
getConnectionRetryCycle() - Method in class de.espirit.or.ConnectionConfiguration: Get the retry cycle for the connection (in milliseconds).
getConnectionTimeout() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: Get ftp connection timeout parameter in seconds. -1 means no timeout.
getConnectionTimeout() - Method in class de.espirit.or.ConnectionConfiguration: Get the connection timeout.
getConstraint() - Method in interface de.espirit.or.query.Select: Return the constraint defined by this select.
getConstraints() - Method in class de.espirit.firstspirit.access.search.Request: Provides a set of constraints to be fulfilled for this request's matches.
getConstraints() - Method in class de.espirit.or.query.ComposedConstraint: Return an unmodifiable list of all sub contraints contained in this composed constraint.
getContent() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Returns a Content2 reference or null if reference is not a type of Content2.
getContent() - Method in interface de.espirit.firstspirit.access.store.contentstore.ContentWorkflowable
getContent() - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateChannel: Provides the formatting content for this channel.
getContent() - Method in interface de.espirit.firstspirit.agency.RenderingAgent.RenderResult: The rendered content.
getContent2() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the content2 id related to the specified content-id, or -1 if not specified.
getContent2ByName(String) - Method in interface de.espirit.firstspirit.access.store.contentstore.ContentStoreRoot: Get Content2 object by uid by calling Store.getStoreElement(String, de.espirit.firstspirit.access.store.IDProvider.UidType)
getContent2Params() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the params of this content2.
getContent2Params() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Provides the content parameter object or null if the corresponding page has a new content section.
getContentId() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the content-id, or -1 if not specified.
getContentProcessor() - Method in interface de.espirit.firstspirit.access.project.PresentationChannel: Provides the name of the content processor to be used for this channel.
getContentProducerBuilder() - Method in interface de.espirit.firstspirit.agency.PreviewUrlAgent: Returns a preview url builder for ContentProducer type StoreElements.
getContentType() - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Get the type of content handled by the editor.
getContentType() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the content type for values stored with this mapping.
getContext() - Method in exception de.espirit.common.CheckedException: Return a Map of contexts for the exception.
getContext() - Method in exception de.espirit.firstspirit.access.store.templatestore.gom.GomValidationError: Returns the context of this error containing specific error information.
getContext() - Method in interface de.espirit.firstspirit.access.template.Evaluator: Provides the current context object.
getContext() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: The context container for this gadget.
getContext(String) - Method in interface de.espirit.firstspirit.access.GenerationContext: Return a Context by given name.
getContextPath(String, String) - Method in interface de.espirit.firstspirit.module.WebServer: Returns the path to the directory of the specified web application relative to WebServer.getWebAppDir().
getContextualElement() - Method in class de.espirit.firstspirit.agency.SnippetContext: Provide a FirstSpirit element to retrieve further information for snippet building.
getContrast() - Method in class de.espirit.firstspirit.client.access.editor.Difference: An object giving contrast information.
getControllerName() - Method in interface de.espirit.firstspirit.webedit.server.gadgets.WebPluginGadgetFactory: Provides the name of the javascript controller constructor for this gadget, which should be defined as window property (e.g. window.ControllerConstructor = ...).
getControlsOfPrecedentTasks() - Method in interface de.espirit.firstspirit.scheduling.agency.ScheduleTaskControlsAgent: Provides the controls of tasks precedent to the current one.
getControlsOfSubsequentTasks() - Method in interface de.espirit.firstspirit.scheduling.agency.ScheduleTaskControlsAgent: Provides the controls of tasks subsequent to the current one.
getConversion() - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateChannel: Provides the conversion mode to be used.
getConversionTable() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Provides the conversion table to be used with this template set.
getConversionTable(String) - Method in interface de.espirit.firstspirit.access.UserService: Get the conversation table by name.
getConversionTableNames() - Method in interface de.espirit.firstspirit.access.UserService: Get the names of the conversation table.
getConvertEntities() - Method in interface de.espirit.firstspirit.access.store.DataValue: Deprecated.
since 5.2.21 - see type
getConvertEntities() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Provides the mode for entity conversions.
getCount() - Method in class de.espirit.firstspirit.event.TrackingEvent: Returns the number of occurrences for this event.
getCrc() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the crc of the file or -1 if crc isn't set
getCrc() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Retrieve the media's CRC value.
getCrc() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the CRC32 of the picture data or -1 if the picture is generated (scaled from the original resolution) on demand.
getCrc() - Method in interface de.espirit.firstspirit.io.FileHandle: Delivers the crc checksum if FileHandle.hasCrc() returns true, else returns 0
getCreatedElement() - Method in interface de.espirit.firstspirit.storage.CreateOperation: Returns the root element of this create operation.
getCreatedElements() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Provides the set of newly created elements.
getCreatedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on created elements.
getCreatedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the set of newly created elements.
getCreatedEntities() - Method in interface de.espirit.firstspirit.storage.ContentOperation: Returns an unmodifiable collection of entity infos indicating entities which were created during the belonging content commit of this content operation
getCreatedEntities() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the set of newly created entities.
getCreatedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.ExportInfo: Get the detailed information on created file handles.
getCreatedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on created file handles.
getCreatedFiles() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Deprecated.
since 5.2.1403. Use ExportOperation.Result.getCreatedFileHandles() ()} or ExportOperation.Result.getCreatedElements() ()} instead.
getCreateGenerateTag() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Should a tagged repository revision be created for this generation.
getCreateMediaFiles() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: true if media files should be created, false otherwise.
getCreateNewIds() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Indicates whether the project importwill create new ids ( true, default) or keeps the ids existing in the export file.
getCreateWorkflowPermission(Workflow) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Return workflow permission object for the given workflow.
getCreationDate() - Method in interface de.espirit.firstspirit.access.packagepool.PackageImportLogfile: Returns the creation date of this logfile.
getCreationDate() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Returns the creation date of this logfile.
getCreationDate() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion: Returns the date when this PackageVersion was created.
getCreationDate() - Method in interface de.espirit.firstspirit.access.Task: Get task creation date
getCreationDate() - Method in interface de.espirit.firstspirit.access.TaskState: The state creation date
getCreationTime() - Method in interface de.espirit.firstspirit.client.io.crc.CRCSession: The creation time of this session.
getCreationTime() - Method in interface de.espirit.firstspirit.feature.FeatureFile: The creation time of the belonging feature transport zip file.
getCreationTime() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the time of creation of this revision
getCreationTime() - Method in interface de.espirit.firstspirit.storage.Tag: Returns the time of creation of this tag.
getCreator() - Method in interface de.espirit.firstspirit.access.Task: Ger task creator
getCreator() - Method in interface de.espirit.firstspirit.access.TaskState: The user creating this state
getCropData() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the Crop information of current picture resolution if exists (bounds related to original resolution) or null if parameter cropData isn't set.
getCurrentDocument() - Method in interface de.espirit.firstspirit.client.gui.applications.browser.BrowserApplication: Returns accessor for the document in the currently loaded page.
getCurrentStage() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: A maintenance mode task consists of up to five stages, from an initial preparation period up to activating the actual maintenance mode.
getCustomAttributes() - Method in interface de.espirit.firstspirit.access.Task: Get task session attributes.
Keys, values and all referenced fields (recursively) must provide a no arg constructor to be valid for serialization.
A IllegalArgumentException is thrown if a key or value with serialisation problems is added to the map.
getCustomConnectionLogin() - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask: If this script uses a custom user Connection, the user login of the Connection is returned, null is returned if a system connection is used.
getCustomData() - Method in interface de.espirit.firstspirit.access.Task: Deprecated.
since 5.2.19, use Task.getCustomFormData().
getCustomData() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Deprecated.
since 5.0.207 use TransitionParameters.getCustomFormData()
getCustomData() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskForm.ScheduleTaskConfiguration: Provides a container on custom data stored with the task.
getCustomEventNames() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Deprecated.
since 5.0.39 - no replacement
getCustomEventScriptName(String) - Method in interface de.espirit.firstspirit.access.packagepool.Package: Deprecated.
since 5.0.39 - no replacement
getCustomEventScripts() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Deprecated.
since 5.0.39 - no replacement
getCustomFormData() - Method in interface de.espirit.firstspirit.access.Task: Get this task's custom form data.
getCustomFormData() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Returns the custom form data of this task or null if the belonging workflow has no form definition.
getCustomProperties(String) - Method in interface de.espirit.firstspirit.access.project.Project: Returns map of user defined properties.
getData() - Method in interface de.espirit.firstspirit.access.editor.value.SectionList.DataSheet: Deprecated.
since 5.2.21 - see type
getData() - Method in interface de.espirit.firstspirit.access.link.Link: Deprecated.
since 4.2.440 - use Link.getFormData() instead
getData() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Deprecated.
since 5.1.102, use Content2.getDatasets()
getData() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2ScriptContext: Returns the list of entities respecting defined filter and ordering of the underlying Content2 element.
Shortcut for getData(getProject().getMasterLanguage())).
getData() - Method in interface de.espirit.firstspirit.access.store.DataValue: Deprecated.
since 5.2.21 - see type
getData() - Method in interface de.espirit.firstspirit.access.store.pagestore.DataProvider: Deprecated.
since 4.2.440 - use DataProvider.getFormData() instead
getData() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams.ContentPageParams: Provides the records defined by this range restricted parameters definition.
getData() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the records for output.
getData() - Method in interface de.espirit.firstspirit.access.store.templatestore.Query: Provides the data corresponding to this query.
getData() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext: Deprecated.
since 5.2.19, use WorkflowScriptContext.getFormData()
getData(Language) - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Deprecated.
since 5.1.102, use Content2.getDatasets(Language).
getData(Language) - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2ScriptContext: Returns the list of entities respecting defined filter and ordering of the underlying Content2 element.
getData(String) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessSession: Gets a data object by its identifier.
getData(Collection<String>) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessSession: Bulk operation to get data objects by their identifiers.
getData(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides all records for the given language.
getData(Language, int) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides all records for the given language being rendered on the specified page number, where page counting starts with 0.
getData(String) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides all records for the given language.
getData(String, int) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides all records for the given language being rendered on the specified page number, where page counting starts with 0.
getDatabase() - Method in class de.espirit.or.ConnectionConfiguration: Get the database name.
getDatabaseLayer(String) - Method in interface de.espirit.firstspirit.access.AdminService: Returns the specified database layer or null if it doesn't exists.
getDatabaseLayers() - Method in interface de.espirit.firstspirit.access.AdminService: Returns all database layers.
getDataDir() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Returns the data directory of this environment.
Components which uses this environment should store their data files in this directory.
getDataFlavor() - Method in class de.espirit.firstspirit.ui.gadgets.aspects.transfer.TransferType: Converts the transfer type into a data flavor representation.
getDataRecords() - Method in interface de.espirit.firstspirit.feature.FeatureModel: Returns all data records contained in this feature model as an unmodifiable map.
The map represents a snapshot of the current model at time calling this method.
getDatarecordsCount() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Returns a mapping of schema uid to count of data records contained in this feature.
getDatarecordsCount() - Method in interface de.espirit.firstspirit.feature.FeatureDescriptor: Returns a mapping of schema uid to count of data records contained in this feature.
getDataRenderDepth() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings: Returns the set data render depth.
getDataset() - Method in interface de.espirit.firstspirit.access.editor.value.DatasetContainer: The stored dataset - may be null
getDataset() - Method in interface de.espirit.firstspirit.access.GenerationContext: Returns the first Dataset if this page is a content page, otherwise null.
getDataset(Entity) - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Get a dataset for the given entity.
getDataset(Entity) - Method in interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider: Get a dataset for the given entity.
getDataset(Entity, Revision) - Method in interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider: Get a dataset for the given entity in a defined revision.
getDatasets() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the list of datasets respecting defined filter and ordering.
Shortcut for getData(getProject().getMasterLanguage())).
getDatasets(Language) - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the list of datasets respecting defined filter and ordering.
Internally this list is constructed lazily, to maintain this feature one should wrap this list if e.g. only Dataset.getEntity() is needed:
getDataTimeout() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: Get ftp data transfer timeout parameter in seconds. -1 means no timeout.
getDataValue() - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Get DataValue object this editor belongs to.
getDBAttribute(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the database attribute bound to this mapping for the given language.
getDBAttribute(String, EntityType) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the database attribute bound to this mapping for the given language wrt. the named entity type.
getDBReferenceName() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the attribute name of where the reference to another persistent object is stored.
getDeactivatedUsers() - Method in interface de.espirit.firstspirit.access.admin.UserStorage: Returns an unmodifiable lazy list of all deactivated users.
getDeactivatedUsers(UserStorage.Order, boolean) - Method in interface de.espirit.firstspirit.access.admin.UserStorage: Returns an unmodifiable list of all deactivated users.
getDebugMode() - Method in interface de.espirit.firstspirit.access.GenerationContext: If debug mode is switched on java stack traces are included in the template log.
getDefaultContentNode() - Method in interface de.espirit.firstspirit.access.editor.DatasetEditorValue: Deprecated.

Returns the default table template: The first valid content node configured in the form.
getDefaultExceptionHandler() - Static method in class de.espirit.firstspirit.access.ConnectionManager: Returns current default ExceptionHandler
getDefaultExpression() - Method in interface de.espirit.firstspirit.access.template.Evaluator: Provides the defined default expression.
getDefaultExtensions() - Method in enum class de.espirit.firstspirit.access.project.InlinePreviewConstraints.DefaultAppFileExtensions: Get the default file name extensions for a engine type.
getDefaultItem() - Method in interface de.espirit.firstspirit.client.plugin.ReportPlugin: Returns the default item of this report plugin, or null if not supported.The operation, provided by the returned item, will be executed on an user-generated click-event.
getDefaultMailText() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns the default mail text used for MailTask.
getDefaultMessage(Map<String, String>) - Method in enum class de.espirit.firstspirit.store.access.mediastore.MediaConstraintsException.EXCEPTION_VARIANT: The default error message for a variant.
getDefaultParameters(String) - Method in interface de.espirit.or.Layer: Return a map of jdbc parameters to default values for this layer based on name.
getDefaultPublishGroup() - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns the default publish group.
getDefaults() - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider: Deprecated.
since 5.0.100 Use GomSourceProvider.getFormDefaults() instead.
getDefaultStyleTemplate() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate: Returns the StyleTemplate used for any table cell if not explicitly overridden using a StyleTemplateLink.
getDefaultTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement: Return the default tag for a gom element.
getDefaultTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList
getDefaultTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo: Provides the default tag.
getDefaultTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfos: Provides the default tag.
getDefaultTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.GomLabeledValueEntry: Provides the default tag name.
getDefaultTemplateSet() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: Gives the default template set to be used.
getDefaultTimeFormat() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The default time format used to parse the directory listings provided by the ftp server.
A null value means that a default date format of the locale en_US is used.
getDefaultTransactionIsolationLevel() - Method in interface de.espirit.or.Layer: Get the default isolation level of this layer.
getDefaultValue() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Provides the editor containing the default value for this form element.
getDefaultValue() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement: Get the default value for the form element.
getDefaultValue() - Method in interface de.espirit.firstspirit.client.plugin.report.Parameter: Returns the default value of this parameter.
getDefaultValue() - Method in interface de.espirit.firstspirit.webedit.plugin.report.Parameter: Deprecated.

Returns the default value of this parameter.
getDefaultValue() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterBoolean: Deprecated.

Provides the parameter's default value.
getDefaultValue() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterSelect: Deprecated.

Provides the parameter's default value.
getDefaultValue() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterText: Deprecated.

Provides the parameter's default value.
getDefaultValue() - Method in interface de.espirit.or.schema.SimpleAttribute: Return the default value of this attribute.
getDefinedParameters() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.Filterable: Returns a list of parameter definitions supported by the data stream, used to enable interactive filter configuration.
getDefinedPrincipalPermissions() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns a list of Principal's for which permissions are defined at this storeelement.
getDefinedTasks() - Method in interface de.espirit.firstspirit.scheduling.agency.ScheduleTaskDefinitionsAgent: Provides access to the defined tasks.
getDefinedVariableValue(String) - Method in interface de.espirit.firstspirit.access.template.Context: Looks up a variable having the given name.
getDefinition() - Method in interface de.espirit.firstspirit.forms.Form: Get the XML-based definition of this form.
getDeletedChildren() - Method in interface de.espirit.firstspirit.access.store.Store: Returns a list of deleted children described by the containing ElementInfo objects.
getDeletedChildren(long, int) - Method in interface de.espirit.firstspirit.access.store.Store: Returns a list of deleted children described by the containing ElementInfo objects.
getDeletedChilds() - Method in interface de.espirit.firstspirit.access.store.Store: Deprecated.
since 5.0.100 - use Store.getDeletedChildren() instead
getDeletedChilds(long, int) - Method in interface de.espirit.firstspirit.access.store.Store: Deprecated.
since 5.0.100 - use Store.getDeletedChildren(long, int) instead
getDeletedElementInfos(long, int, Filter<ElementInfo>) - Method in interface de.espirit.firstspirit.access.UserService: Get a list of information objects for deleted elements matching the given filter.
getDeletedElements() - Method in interface de.espirit.firstspirit.access.store.DeletedElementsInfo
getDeletedElements() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all successfully deleted elements since the last progress poll.
getDeletedElements() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Provides the set of deleted elements.
getDeletedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on deleted elements.
getDeletedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the set of deleted elements.
getDeletedElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of BasicInfo of successfully deleted elements.
getDeletedEntities() - Method in interface de.espirit.firstspirit.storage.ContentOperation: Returns an unmodifiable collection of entity infos indicating entities which were deleted during the belonging content commit of this content operation
getDeletedEntities(String) - Method in interface de.espirit.or.Session: Get all deleted entities from type entityTypeName.
getDeletedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.ExportInfo: Get the detailed information on deleted file handles.
getDeletedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on deleted file handles.
getDeletedFiles() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Deprecated.
since 5.2.1403. Use ExportOperation.Result.getDeletedFileHandles() or ExportOperation.Result.getDeletedElements() instead.
getDeleteDirectory() - Method in interface de.espirit.firstspirit.access.GenerationContext: Return if the target directory should be deleted before the generation
getDeleteDirectory() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: true if directory should be deleted before generation, false otherwise
getDeletedPageInfos() - Method in interface de.espirit.firstspirit.access.schedule.DeltaGeneration.ChangeSet: Information for deleted pages.
getDeletedReferences() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail: Returns the set of deleted references.
getDeletedStoreNodes() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Deprecated.
since 5.2.181006 - use FeatureInstallResult.getDeletedElements() instead
getDeleteFailedElements() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all elements which couldn't be deleted because of unexpected errors during delete.
This amount of ID's doesn't contains elements which are contained in on of (DeleteProgress.getMissingPermissionElements(), DeleteProgress.getLockFailedElements() , DeleteProgress.getReferencedElements())
getDeleteFailedElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of all elements which couldn't be deleted because of unexpected errors during delete.
This amount doesn't contain elements which are contained in (DeleteOperation.Result.getMissingPermissionElements(), DeleteOperation.Result.getLockFailedElements() , DeleteOperation.Result.getReferencedElements()).
getDeleteRootElement() - Method in interface de.espirit.firstspirit.storage.DeleteOperation: Returns the root element of the delete action.
Example:
getDeleteWorkflow() - Method in interface de.espirit.firstspirit.access.project.Project: Get delete Workflow.
getDependentBackups() - Method in interface de.espirit.firstspirit.access.export.ProjectInfo: Returns list of backup files this file depends on.
getDependentPackages() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion: Provides a set of all dependent packages of this version.
getDependentReleaseType() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation: Returns the dependent release type parameter which was set during execution of the belonging server release action.
getDeploymentErrorHandling() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the code for how to handling deployment errors.
getDeployTarget() - Method in class de.espirit.firstspirit.server.scheduler.DeployTargetDialogFactory: Gets the deploy target.
getDeployTask() - Method in class de.espirit.firstspirit.server.scheduler.DeployTargetDialogFactory: Gets the deploy task.
getDescription() - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup: Returns the description of this publish group.
getDescription() - Method in interface de.espirit.firstspirit.access.project.Project: Gets the description of the project
getDescription() - Method in interface de.espirit.firstspirit.access.project.Resolution: Get the technical description of this resolution
getDescription() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: Get the description for the schedule entry.
getDescription() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns the description of this task.
getDescription() - Method in interface de.espirit.firstspirit.access.store.LanguageInfo: Get description parameter.
getDescription() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the description of the current media.
getDescription() - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Get the description of the current media.
getDescription() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo: Provides the stored description.
getDescription() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo: Get the description.
getDescription() - Method in interface de.espirit.firstspirit.access.store.templatestore.Script: Provides a description of this script.
getDescription() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns an english component description.
getDescription() - Method in interface de.espirit.firstspirit.module.descriptor.Descriptor: Returns a module or component description.
getDescription() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskControl: Provides a description of the task.
getDescription() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskForm.ScheduleTaskConfiguration: Provides a description of the task.
getDescription() - Method in interface de.espirit.firstspirit.server.application.ApplicationPlugin: A description for the application, or null.
getDescription() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: The description of this maintenance mode.
getDescription() - Method in interface de.espirit.firstspirit.server.mediamanagement.exif.ExifTag: Get a description of the tag's value, considering enumerated values and units.
getDescription() - Method in interface de.espirit.firstspirit.server.scheduler.DeployTargetFactory: Provides the description for a task based upon this factory.
getDescription() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleTaskFactory: Provides a description of the created task's job.
getDescription() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleWizardFactory: Provides a job description for created tasks.
getDescription() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method returning the description of the form.
getDescription() - Method in interface de.espirit.firstspirit.workflow.model.WorkflowElement: Returns the description from this workflow-element.
getDescription(Resolution) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the description for the given resolution according to the currently set UI language and display mode.
getDescription(WorkflowElement) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the description for the given workflow element according to the currently set UI language and display mode.
getDescription(Locale) - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskApplication: Provides a description for this application, preferably respecting the given locale.
getDescription(Language) - Method in interface de.espirit.firstspirit.access.project.Resolution: Get the editorial description of this resolution for the given language or null if not defined for the language
getDescription(Language) - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Get the editorial description of this TemplateSet for the given language or null if not defined for the language
getDescription(Language) - Method in interface de.espirit.firstspirit.workflow.model.WorkflowElement: Returns the language dependant description from this workflow-element.
getDescription(T) - Method in interface de.espirit.firstspirit.client.plugin.report.DataRenderer: Returns an evaluated description for the given object or null if a description is not available.
getDescription(T) - Method in interface de.espirit.firstspirit.webedit.plugin.report.ReportPluginRenderer: Deprecated.

Returns an evaluated description for the given object or null if a description is not available.
getDescriptor() - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent.ModuleResult: Returns the descriptor of the currently installed/updated module.
getDescriptor() - Method in class de.espirit.firstspirit.ui.gadgets.aspects.transfer.TransferType: Provides access the descriptor of the transfer type, e.g. a MIME type.
getDetails(T) - Method in interface de.espirit.firstspirit.client.plugin.report.DataRenderer: Returns an evaluated detail html snippet for the given object or null if a detail is not available.
getDirectory1() - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration: Deprecated.
since 5.0 - no replacement
getDirectory2() - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration: Deprecated.
since 5.0 - no replacement
getDirectoryName() - Method in interface de.espirit.firstspirit.server.mediamanagement.exif.ExifTag: Get the name of the directory in which the tag exists, such as Exif, GPS or Interoperability.
getDisconnectMode() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: Indicates the handling of existing sessions once the stage MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVEbegins.
getDisconnectMode() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: Indicates the handling of existing sessions once the stage MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE begins.
getDisplayLanguage() - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the currently set language to be used for displaying UI elements.
getDisplayLanguage() - Method in interface de.espirit.firstspirit.module.GadgetContext: The display language to be used for displaying the form (labels).
getDisplayLanguage() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method to get the language to be used for displaying values.
getDisplayLanguage() - Method in interface de.espirit.firstspirit.webedit.client.api.Common: Returns the abbreviation of the current display language.
getDisplayLanguage() - Method in interface de.espirit.firstspirit.webedit.WebeditUiAgent: Provides the display language of the client UI.
getDisplayName() - Method in enum class de.espirit.firstspirit.access.schedule.FtpTarget.FtpServerType: Returns the display name of this ftp server type.
getDisplayName() - Method in interface de.espirit.firstspirit.access.store.LanguageInfo: Returns the language specific displayname for this storeelement or null if no display name is set for this language.
getDisplayName() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns the component displayname.
getDisplayName() - Method in interface de.espirit.firstspirit.module.descriptor.Descriptor: Returns the module or component displayname.
getDisplayName() - Method in interface de.espirit.firstspirit.server.scheduler.DeployTargetFactory: Provides the display name for task selection.
getDisplayName() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleTaskFactory: Provides the display name for creating tasks from this factory.
getDisplayName() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleWizardFactory: Provides a display name for task creation selection.
getDisplayName() - Method in interface de.espirit.firstspirit.workflow.WorkflowGroup: Returns the display name of this group.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.agency.UIAgent: Determines the display name for the given language according to the currently set UI language and display mode.
getDisplayName(Resolution) - Method in interface de.espirit.firstspirit.agency.UIAgent: Determines the display name for the given resolution according to the currently set UI language and display mode.
getDisplayName(TemplateSet) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the display name for the given template set according to the currently set UI language and display mode.
getDisplayName(IDProvider) - Method in interface de.espirit.firstspirit.agency.UIAgent: Determines the display name for the given id providing store element according to the currently set UI language and display mode.
getDisplayName(WorkflowElement) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the display name for the given workflow element according to the currently set UI language and display mode.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.access.Language: Gets display name of the Language for the given language.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.access.project.Resolution: Gets display name of the resolution for the given language.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Gets display name of the TemplateSet for the given language.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.access.store.IDProvider: Return the display name (label) for the specified language - if no language specific label is defined for this language the value for the master language is returned.
getDisplayName(Language) - Method in interface de.espirit.firstspirit.workflow.model.WorkflowElement: Returns the language dependant name from this workflow-element.
getDisplayName(IDProvider) - Method in interface de.espirit.firstspirit.webedit.WebeditUiAgent: Provides the display name for the given store element.
getDisplayName(Store.Type) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides the display name to be used for the given store type.
getDisplayName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Get the display name for the given language abbreviation.
getDisplayNames() - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.

Provides the display names as array.
getDisplayText() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Return a type dependent display text.
getDisplayText() - Method in interface de.espirit.or.schema.Attribute: Return the display text of this attribute.
getDisplayValues(Section) - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.

Provides the display values for the given section as array.
getDocumentGroup() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the referenced element as firstspirit document group, if applicable.
getDocumentGroup() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Returns a DocumentGroup reference or null if the referenced instance is not a DocumentGroup.
getDom() - Method in interface de.espirit.firstspirit.access.editor.value.Table: Returns the element node of this table.
getDriver() - Method in class de.espirit.or.ConnectionConfiguration: Get the driver.
getDropEditorName() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Get the name of the editor that should be used as a drop target.
getDropStatement() - Method in interface de.espirit.or.Layer: Get the specific SQL-Drop-Statement which deletes an existing table or scheme from a database
getDtoType() - Method in interface de.espirit.firstspirit.server.scheduler.DeployTargetFactory: Provides the DTO type for the task at hand.
getDtoType() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleTaskFactory: Provides the DTO type for tasks.
getDueDate() - Method in interface de.espirit.firstspirit.access.Task: Get task due date
getDueDate() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Get due date.
getDuration() - Method in interface de.espirit.firstspirit.workflow.model.State: Returns the maximum retention period for this state.
getDurationOfStage(MaintenanceModeTask.MaintenanceStage) - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: Each stage has a duration after which the next stage is started.
getDurationOfStageInMillis(MaintenanceModeTask.MaintenanceStage) - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: Each stage has a duration after which the next stage is started.
getEditor() - Method in interface de.espirit.firstspirit.access.store.DataValue: Deprecated.
since 5.2.21 - see type
getEditor() - Method in interface de.espirit.firstspirit.access.store.DeletedElementsInfo
getEditor() - Method in interface de.espirit.firstspirit.access.store.ElementInfo
getEditor() - Method in interface de.espirit.firstspirit.access.store.StoreElement
getEditor() - Method in class de.espirit.firstspirit.client.access.editor.EditorValueChangedEvent: Provides the editor of the event.
getEditor() - Method in interface de.espirit.firstspirit.client.EditorItemNode: Provides a subsequent node identifying an editor component within the item referenced by this node.
getEditor() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the editor string of this revision in the format 'EDITOR_NAME [ID=123]'
getEditor() - Method in interface de.espirit.firstspirit.storage.Tag: Returns the editor string of this revision.
getEditorChanges() - Method in interface de.espirit.firstspirit.storage.DataChangeDetail: Returns an unmodifiable map of editor changes.
Key: Editor/Variable name
Value: EditorChange
getEditorialLanguages() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the list of editorial language for this project.
getEditorialLanguages() - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provides access to the languages marked as editorial languages, i.e, those languages used to edit the element's display names.
getEditorId() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the user id of the editor of this revision or -1 if the id is missing in the editor string
getEditorLabel() - Method in exception de.espirit.firstspirit.access.editor.value.InvalidValueException: Provides the editor's label.
getEditorLanguages() - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Get the languages valid for the current editing operation, where the key is the language abbreviation and the value is the language object.
getEditorMode() - Method in interface de.espirit.firstspirit.access.Task: Get task editor mode
getEditorMode() - Method in interface de.espirit.firstspirit.workflow.model.State: Return the mode of the permission checking
getEditorName() - Method in exception de.espirit.firstspirit.access.editor.value.InvalidValueException: Provides the editor's variable name.
getEditorName() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Deprecated.
since 4.2.24 - Since 4.2 this is retained for backward compatibility, all instances which provide a different value than Link.GENERIC_LINK are considered legacy. - no replacement
getEditorNode() - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.InlineEditContext: Provides the editor node identifying the nested content in which the inline editing items have been requested, or null if this context only references a top level element.
getEditors() - Method in interface de.espirit.firstspirit.access.Task: Get task allowed editors list
getEditors() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Get task editors.
getEditorValue() - Method in exception de.espirit.firstspirit.access.editor.value.InvalidValueException: Provides the editor.
getElement() - Method in interface de.espirit.firstspirit.access.ClientScriptContext: The element this context is operating on.
getElement() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the element of the binary medium.
getElement() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable.Context: Provides the operational store element for this context.
getElement() - Method in interface de.espirit.firstspirit.access.WorkflowContext: Returns the element or null for tasks with no context element.
getElement() - Method in interface de.espirit.firstspirit.agency.ElementValidationReport: Deprecated.
since 5.0.311, use ElementValidationReport.getElement(SpecialistsBroker) instead.
getElement() - Method in interface de.espirit.firstspirit.client.access.editor.IDProviderReferenceHolder: Resolves the element referenced by this container.
getElement() - Method in interface de.espirit.firstspirit.client.gui.model.selection.SelectionModel: Returns currently selected IDProvider.
getElement() - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewContext: Provides the element the toolbar context relates to.
getElement() - Method in interface de.espirit.firstspirit.client.plugin.toolbar.ToolbarContext: Provides the element the toolbar context relates to.
getElement() - Method in interface de.espirit.firstspirit.event.DatasetChange: Get the Dataset being operated on.
getElement() - Method in interface de.espirit.firstspirit.event.IDProviderChange: Get the element the of this change operation.
getElement() - Method in interface de.espirit.firstspirit.feature.FeatureModel.FeatureReference: Returns the concrete element this feature reference references to.
getElement() - Method in interface de.espirit.firstspirit.module.GadgetContext: Delivers the store element the gadget belongs to.
getElement() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.operations.SelectStoreElementOperation.Selection: A selected element.
getElement() - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.InlineEditContext: Get the contextual element for which the item has been requested.
getElement() - Method in interface de.espirit.firstspirit.webedit.plugin.media.MediaManagementContext: Get the contextual element.
getElement() - Method in interface de.espirit.firstspirit.webedit.plugin.status.WebeditStatusNoteContext: Provides the shown element.
getElement() - Method in interface de.espirit.firstspirit.workflow.WorkflowAgent.WorkflowProcessContext: Returns the element this workflow process is related to or null if this is aworkflow without context.
getElement(BaseContext, boolean) - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the element this file is based upon with respect to the given context.
getElement(SpecialistsBroker) - Method in interface de.espirit.firstspirit.agency.ElementValidationReport: Get the element this report is generated for.
getElementById(String) - Method in interface de.espirit.firstspirit.webedit.server.gadgets.WebPluginGadgetHost: Lookup and return the element with the given id.
getElementCount() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Returns the count of elements (non data records) contained in this feature.
getElementCount() - Method in interface de.espirit.firstspirit.feature.FeatureDescriptor: Returns the count of elements (non data records) contained in this feature.
getElementCount() - Method in interface de.espirit.firstspirit.feature.FeatureProgress: The count of elements currently processed during feature transport file creation.
getElementFormData() - Method in interface de.espirit.firstspirit.ui.gadgets.swing.SwingGadgetContext: Provides remote access to the form data containing the gadget.
getElementIdTranslator() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Provides a translator between element IDs from the publisher project to the subscriber project.
getElementInfo() - Method in interface de.espirit.firstspirit.agency.UrlAgent.UrlEntry: Returns a BasicElementInfo for this url entry.
getElementInfo() - Method in interface de.espirit.firstspirit.store.access.nexport.ElementExportInfo: Retrieves the BasicElementInfo of this element.
getElementName() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the element name of the binary medium.
getElementReports() - Method in exception de.espirit.firstspirit.agency.ElementValidationReportsException: Get the reports on elements.
getElementRestrictions() - Method in class de.espirit.firstspirit.access.search.Request: Provides restrictions set on elements.
getElements() - Method in interface de.espirit.firstspirit.client.plugin.contextmenu.ContextMenuContext: Get the contextual store elements.
getElements() - Method in interface de.espirit.firstspirit.storage.DeleteOperation: Returns a collection of all elements belonging to this revision operation
getElements() - Method in interface de.espirit.firstspirit.storage.ModifyOperation: Returns a collection of all elements belonging to this revision operation
getElements() - Method in interface de.espirit.firstspirit.storage.MoveOperation: Returns a collection of all elements belonging to this revision operation
getElements() - Method in interface de.espirit.firstspirit.storage.ReleaseOperation: A collection containing element pointers for all changed or disappeared / deleted elements of this release operation.
getElements() - Method in interface de.espirit.firstspirit.storage.RevisionOperation: Returns a collection of all elements belonging to this revision operation
getElements() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation: A collection containing element pointers for all changed or disappeared / deleted elements of this release operation.
getElements() - Method in interface de.espirit.firstspirit.workflow.WorkflowGroup: Returns all elements of this group.
getElements(Revision, Revision, int, Filter<Revision>) - Method in class de.espirit.firstspirit.storage.HistoryProvider.RevisionProvider: Provides all revisions within the defined range matching the given filter, but at most max entries.
getElements(E, E, int, Filter<E>) - Method in interface de.espirit.common.util.ElementProvider: Get a list of elements in the given range including a defined maximum number of elements that pass the provided filter.
getElements(Collection<Long>) - Method in interface de.espirit.firstspirit.access.store.Store: Get a list of IDProvider identified by given ids.
Attention: List could contain null entries for ids no element could be found for (e.g. deleted).
getElementType() - Method in interface de.espirit.firstspirit.access.store.StoreElement
getElementType() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the store-element type
getElementUid() - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the UID of the element, this file is based upon.
getElementUidType() - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the UID-Type of the element, this file is based upon.
getEmail() - Method in interface de.espirit.firstspirit.access.project.Group: Gets email address of the group.
getEmail() - Method in interface de.espirit.firstspirit.access.schedule.MailTask: The email-addresses of recipients seperated by ";"
getEmail() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: The e-mail adress(es) which will be used for status mails for finished tasks.
getEMail() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the e-mail address to be notified when the project generation is done.
getEMail() - Method in interface de.espirit.firstspirit.access.User: Gets eMail adress of the user.
getEmailBody() - Method in interface de.espirit.firstspirit.workflow.model.Activity: Returns the text from the email.
getEmailBody() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns the text from the email.
getEmailGroups() - Method in interface de.espirit.firstspirit.workflow.model.Activity: Provides the groups who are selected to be notified by mail.
getEmailGroups() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Provides the groups to e-mail to.
getEmailProperty(int) - Method in interface de.espirit.firstspirit.workflow.model.Activity: Returns true if this activity has the given property
getEmailProperty(int) - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns true if this activity has the given property
getEmailSubject() - Method in interface de.espirit.firstspirit.workflow.model.Activity: Returns the title from the email.
getEmailSubject() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns the title from the email.
getEmailUser() - Method in interface de.espirit.firstspirit.workflow.model.Activity: Returns the user who are selected to be notified by mail.
getEmailUser() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Returns the user who are selected to be notiefied by mail.
getEmpty() - Method in interface de.espirit.firstspirit.client.access.editor.ValueEngineer: Create an empty (initial) value.
getEmpty(Language) - Method in interface de.espirit.firstspirit.access.editor.ReferenceEditorValue: Deprecated.

Get an empty TargetReference.
getEmptyPage() - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the empty page.
getEncoding() - Method in interface de.espirit.firstspirit.access.GenerationContext: Get file encoding.
getEncoding() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the encoding of the current file-media
getEncoding() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Returns the encoding if this media is a file and has a encoding.
getEncryption() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the encryption method to apply when using Java Web Start.
getEncryption() - Method in class de.espirit.firstspirit.access.ConnectionManager.SocketParam: Provides the encryption type used.
getEncryption(int) - Static method in class de.espirit.firstspirit.access.ConnectionManager: Get the used encryption for the specified connection mode.
getEnd() - Method in class de.espirit.firstspirit.access.search.Match: Provides the ending position of the match within the text it bases upon.
getEngineNames() - Method in interface de.espirit.firstspirit.access.admin.ScriptEngineRegistry: Returns a collection that contains the names of the script engines.
getEngineType() - Method in interface de.espirit.firstspirit.client.gui.applications.browser.BrowserApplication: Returns the type of the browser engine that is currently used by this BrowserApplication.
getEngineType() - Method in interface de.espirit.firstspirit.client.gui.applications.browser.BrowserApplicationConfiguration: Returns the type of the browser engine which should be used for the created browser application.
getEngineVersion() - Method in interface de.espirit.firstspirit.client.gui.applications.browser.BrowserApplication: Returns the version string of the browser engine that is currently used by this BrowserApplication.
getEntities() - Method in interface de.espirit.firstspirit.event.EventInfo: If this event is entity related, information on the entities in question will be provided as a list of lightweight info objects.
getEntities() - Method in interface de.espirit.firstspirit.store.access.nexport.EntityTypeExportInfo: Return a collection of BasicEntityInfos.
getEntitiesPerPage() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the number of records to put out per page.
getEntity() - Method in interface de.espirit.firstspirit.access.store.contentstore.ContentWorkflowable
getEntity() - Method in interface de.espirit.firstspirit.access.store.contentstore.Dataset: Get the entity bound to this dataset.
getEntity(Object) - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the entity found for given keyValue or null.
getEntityCount() - Method in interface de.espirit.firstspirit.feature.FeatureProgress: The count of entities (data records) currently processed during feature transport file creation.
getEntityId() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask.EntityEntry: The id of the Entity.
getEntityId() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The entity id.
getEntityId() - Method in interface de.espirit.or.EntityInfo: Provides the local id of the entity.
getEntityInfo() - Method in interface de.espirit.firstspirit.event.DatasetChange: Get info object containing metadata about the changed entity.
getEntityStartNodes() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Returns a modifyable Collection of entity start nodes.
getEntityType() - Method in interface de.espirit.firstspirit.access.database.BasicEntityInfo: Provides the type (table) this entity belongs to.
getEntityType() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the entity type this content2 belongs to.
getEntityType() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2ScriptContext: Returns the entity type this content2 script context belongs to.
getEntityType() - Method in interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider: Get the entity type supported by this dataset provider.
getEntityType() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Provides the entity type (the db table) this template bases upon.
getEntityType() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the entity type (db table) this mapping operates on.
getEntityType() - Method in interface de.espirit.firstspirit.store.access.nexport.EntityTypeExportInfo: Return the entity type of this export info as a String.
getEntityType() - Method in interface de.espirit.or.schema.Entity: Return the type of this entity.
getEntityType(String) - Method in interface de.espirit.or.schema.Schema: Return the entity type with the given name if one was defined in this schema else null
getEntityTypeName() - Method in interface de.espirit.firstspirit.event.EntityInfo: Provides the name of the entity type the entity is based on.
getEntityTypeName() - Method in interface de.espirit.firstspirit.feature.FeatureModel.FeatureDatasetReference: The name of the entity type the referenced dataset belongs to.
getEntityTypeName() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ContentReference: Get the name of the entity's type.
getEntityTypeName() - Method in interface de.espirit.or.EntityInfo: Provides the name of the containing table.
getEntityTypeName() - Method in interface de.espirit.or.query.Select: Return the name of the entity type which entities in the result set belong to.
getEntityTypeName() - Method in interface de.espirit.or.schema.Identifier: Returns the name of the entity type of the entity this identifier belongs to.
getEntityTypeName() - Method in class de.espirit.or.schema.KeyValue: Provides the entity type name.
getEntityTypes() - Method in interface de.espirit.or.schema.Schema: Return all entity types contained in this schema.
getEntries() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomEntryProvider: Get a GOM list element that provides labeled entries.
getEntries() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodes: Returns a immutable collection of all selected entries in pairs: id → selection-state.
getEntries(IDProvider, Language) - Method in interface de.espirit.firstspirit.client.plugin.timeline.TimelineEntryProvider: Returns a list of entries that should be shown in the related timeline.
getEntryErrors() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Returns the feature errors of this analyze result.
getEntryName() - Method in exception de.espirit.firstspirit.access.schedule.ScheduleEntryRunningException: Returns the name of the ScheduleEntry.
getEntryPath() - Method in class de.espirit.firstspirit.store.access.feature.FeatureError: Get the path of the entry causing the error.
getEnvironment() - Method in interface de.espirit.firstspirit.module.Configuration: Returns ComponentEnvironment
getErrorActivity() - Method in interface de.espirit.firstspirit.access.TaskErrorInfo: Get activity object
getErrorActivityId() - Method in interface de.espirit.firstspirit.access.TaskErrorInfo: Get activity id producing the error.
getErrorCode() - Method in exception de.espirit.common.CheckedException: Return the error code for the exception.
getErrorCode() - Method in exception de.espirit.firstspirit.access.store.ElementMovedException
getErrorCode() - Method in class de.espirit.firstspirit.access.Task.VerifyError: Returns the error code.
getErrorCode() - Method in class de.espirit.firstspirit.store.access.feature.FeatureError: The error code of this feature error.
getErrorCount() - Method in interface de.espirit.firstspirit.access.export.ImportProgress: The Error count of non-fatal import errors
getErrorCount() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext: Returns the number of errors that occurred while execution.
getErrorCount() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTestResult: the number of errors logged during executed test
getErrorCount() - Method in interface de.espirit.firstspirit.access.schedule.TaskResult: Returns the number of errors occured during task execution.
getErrorCount() - Method in interface de.espirit.firstspirit.agency.RenderingAgent.BasicRenderResult: The number of errors produced during rendering.
getErrorInfo() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext: Returns error info object if gotoErrorState was called during this script execution or null.
getErrorInfo() - Method in interface de.espirit.firstspirit.access.Task: Return error info object or null if the error state has not been reached.
getErrorInfo() - Method in interface de.espirit.firstspirit.access.TaskErrorInfo: Return string representation of throwable.
getErrorInfo() - Method in interface de.espirit.firstspirit.workflow.WorkflowAgent.WorkflowProcessContext: Returns the error info which has been set in WorkflowAgent.WorkflowProcessContext.gotoErrorState(String,Throwable), or null ifnot in error state.
getErrorLevel() - Method in class de.espirit.firstspirit.store.access.feature.FeatureError: The error level of this feature error.
getErrors(FeatureError.Level) - Method in exception de.espirit.firstspirit.store.access.nexport.exceptions.SyncOperationException: Returns a list of import errors.
getErrorsCount() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Returns the error count of this feature analyze result.
getErrorState() - Method in interface de.espirit.firstspirit.workflow.model.Workflow: Return the errorstate of this workflow.
getErrorThreshold() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Returns the threshold of errors until generation should be canceled
getEvaluator() - Method in interface de.espirit.firstspirit.access.GenerationContext: The current evaluator.
getEventInfo() - Method in interface de.espirit.firstspirit.event.IDProviderChange: Provides the lightweight event info object containing metadata about the element change operation, as seen in the filter.
getEventType() - Method in interface de.espirit.firstspirit.event.EventInfo: The change type which caused this event.
getException() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupProgress: Return an exception, if one occured.
getException() - Method in interface de.espirit.firstspirit.access.export.ExportProgress
getExceptionHandler() - Method in interface de.espirit.firstspirit.access.Connection: Returns current ExceptionHandler.
getExceptionType() - Method in exception de.espirit.firstspirit.store.access.mediastore.MediaConstraintsException: Get the variant type used for computing a generic fallback message.
getExcludes() - Method in class de.espirit.firstspirit.module.descriptor.WebAppDescriptor.FilterDescriptor: Returns a list of paths that should be excluded by a filter using this definition.
getExclusionNodeList() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Returns a read-only list of StoreElement's which are excluded from the list of startnodes in the belonging Package of this subscription.
getExecutable() - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask: Provides an executable defined with this script.
getExecutable(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.templatestore.Script: Provides an executable based on the requested template set.
getExecutable(String) - Method in interface de.espirit.firstspirit.access.script.ScriptEngine: Creates an executable from the given script source code.
getExecuteInFault() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns true if this task is to be executed even on previous errors, false to be skipped.
getExecuteParallel() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns true if this task is allowed to be executed parallel, false otherwise.
getExecutionCount() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryStatistic: Returns the number of executions
getExecutionId() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext: The id of the current control
getExecutionId() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskExecutionContext: The id of the current control
getExecutionSchedule() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: Returns the ExecutionSchedule of this ScheduleEntry.
getExecutor() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskApplication: Provides an executor providing the application logic.
getExportCachedPictures() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Get export cached picture resolutions state.
getExportCachedPictures() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask: Get export cached picture resolutions state.
getExportDate() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the date of the export or ExportFile.UNKNOWN_EXPORT_DATE if the date of the export is unknown.
getExportDeletedElements() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Indicates whether deleted elements should be exported or not.
getExportDeletedElements() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask: Indicates whether deleted elements will be exported.
getExportedBytes() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupProgress: Returns the number of bytes exported.
getExportedBytes() - Method in interface de.espirit.firstspirit.access.export.ExportProgress: Returns the count of exported bytes.
getExportedFiles() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupProgress: Returns the number of exported files.
getExportFile() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Returns the belonging export file.
getExportFiles() - Method in interface de.espirit.firstspirit.access.export.ExportProgress
getExportInfo() - Method in interface de.espirit.firstspirit.store.access.nexport.io.ExportInfoFileHandle: Returns the connected ExportInfo of this file handle.
getExportTableData() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Indicates whether contentstore table data will be exported during the belonging project export or not.
getExportTableData() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask: Indicates whether table data will be exported.
getExportVersion() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the version string of the FirstSpirit version which created this export file.
getExtension() - Method in interface de.espirit.firstspirit.access.project.PresentationChannel: Provides the extension to be used for this channel.
getExtension() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Gets the extension of the TemplateSet
getExtension() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the extension.
getExtension() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Get the media's file extension.
getExtension() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the extension of the current picture resolution.
getExtension() - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the extension of the file.
getExtension() - Method in interface de.espirit.firstspirit.server.mediamanagement.mime.MimeType: Get the associated filename extension.
getExtension(TemplateSet) - Method in interface de.espirit.firstspirit.access.store.ContentProducer: Get the file / url extension for this content producer, e.g.
getExtensions() - Method in interface de.espirit.firstspirit.access.store.templatestore.MasterTemplate: Deprecated.
since 5.0.101 Use MasterTemplate.getTemplateExtension(de.espirit.firstspirit.access.project.TemplateSet).
getExtensions() - Method in interface de.espirit.firstspirit.server.mediamanagement.mime.MimeType: Get the possible associated filename extensions.
getExternalGroups() - Method in interface de.espirit.firstspirit.access.User: Get the users external groups as a collection.
getExternalName() - Method in interface de.espirit.firstspirit.access.project.ExternalGroup: Get the external group name.
getExternalReferences() - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.2.301, use ProjectReferencesAgent.getExternalReferences(String,boolean).
getExternalReferences(boolean) - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.2.301, use ProjectReferencesAgent.getExternalReferences(String,boolean).
getExternalReferences(String, boolean) - Method in interface de.espirit.firstspirit.agency.ProjectReferencesAgent: Get all external references from the current or from the release stores.
getExternalReferences(String, boolean) - Method in interface de.espirit.firstspirit.access.project.Project: Deprecated.
since 5.2.301, use ProjectReferencesAgent.getExternalReferences(String,boolean).
getExternalUrl() - Method in interface de.espirit.firstspirit.base.UrlProducer: Getter and indicator for producers resulting in an external URL
getExternalUrlEditorName() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: The name of the editor which will contain the textual representation of an external "url".
getExtract() - Method in interface de.espirit.firstspirit.access.store.templatestore.Snippet: Returns extract expression of this snippet.
getExtract() - Method in interface de.espirit.firstspirit.agency.DataSnippet: Provides the extract text being used as a long representation of the given object.
getExtract(Language) - Method in interface de.espirit.firstspirit.store.snippets.SnippetProvider: Get the evaluated header snippet presentation for the given language.
getExtract(D, Language) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataSnippetProvider: Provides the extract text being used as a long representation of the given object.
getFailure() - Method in exception de.espirit.firstspirit.access.template.ParsingError: Provides the original failure message.
getFallbackLanguage() - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provide the language being used to define fallback values in form defaults.
getFallbackTimeFormat() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: 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 A null value means that a server type dependent default fallback will be used.
getFatalCount() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTestResult: the number of fatal errors logged during executed test
getFatalErrorCount() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext: Returns the number of fatal errors that occurred while execution.
getFatalErrorCount() - Method in interface de.espirit.firstspirit.access.schedule.TaskResult: Returns the number of fatal errors occured during task execution.
getFeatureDescriptors() - Method in interface de.espirit.firstspirit.feature.FeatureAgent: Returns a list of all feature descriptors available for the project this agent is related to.
getFeatureFile() - Method in interface de.espirit.firstspirit.feature.FeatureInstallOptions: Retrieve a FeatureFile object representing a feature that requires installation.
getFeatureFile() - Method in interface de.espirit.firstspirit.feature.FeatureProgress: The feature file representing the feature transport zip file created by the server side process.
getFeatureFiles() - Method in interface de.espirit.firstspirit.feature.FeatureAgent: Returns a list of all featureFiles existing on the server for the current project.
getFeatureName() - Method in interface de.espirit.firstspirit.feature.FeatureDescriptor: Returns the name of the feature this descriptor belongs to.
getFeatureName() - Method in interface de.espirit.firstspirit.feature.FeatureFile: The name of the belonging feature.
getFetchModes() - Method in interface de.espirit.or.query.Select: Returns all fetch modes defined by this select.
getFetchSize() - Method in interface de.espirit.or.query.Select: Return the fetch size which will applied to the JDBC ResultSet to retrieve data from the database.
getFieldName() - Method in exception de.espirit.firstspirit.forms.NoSuchFormFieldException: Provides the field name in question.
getFile() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the file of the binary medium.
getFile(Language) - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: Get the given media as a File object in the language provided.
getFileHandle(String) - Method in interface de.espirit.firstspirit.access.GenerationContext: Reurn a FileHandle for the given path
getFilename() - Method in interface de.espirit.firstspirit.access.store.ContentProducer: Get a file or link name for this content producer; without path information and extension, e.g.
getFilename() - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: Get the filename of the current media.
getFilename() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: Provides the file name of this group.
getFilename() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Returns a filename suggestions which may be used for creating urls.
getFilename(ContentProducer, TemplateSet, Language, PageParams) - Method in interface de.espirit.firstspirit.generate.UrlCreator: The complete file name (relative to content root) where the produced content of the provided contentProducer will be stored.
getFilename(ContentProducer, TemplateSet, Language, String) - Method in interface de.espirit.firstspirit.access.UrlCreator: Deprecated.
since 5.0.3 - use UrlCreator.getFilename(ContentProducer, TemplateSet, Language, PageParams).
getFilename(Media, Language, Resolution) - Method in interface de.espirit.firstspirit.access.UrlCreator: Deprecated.

See UrlCreator.getFilename(Media, Language, Resolution).
getFilename(Media, Language, Resolution) - Method in interface de.espirit.firstspirit.generate.UrlCreator: The complete file name (relative to content root) where the produced content of the provided medium will be stored.
getFilename(String, ContentProducer, TemplateSet, Language, PageParams) - Method in interface de.espirit.firstspirit.generate.FilenameFactory: Calculate filename for provided combination of node, template set, language, and page params.
getFilename(String, Media, Language, Resolution) - Method in interface de.espirit.firstspirit.generate.FilenameFactory: Calculate filename for provided combination of node, language, and resolution.
getFilename(String, String, String, Language) - Method in interface de.espirit.firstspirit.generate.UrlCreator: The complete path (relative to content root) where the produced content of the provided type will be stored.
getFilename(String, String, String, Language) - Method in interface de.espirit.firstspirit.access.UrlCreator: Deprecated.

See UrlCreator.getFilename(String, String, String, Language).
getFileRevision() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Return file content revision or null if no content exits.
getFiles() - Method in interface de.espirit.firstspirit.storage.RevisionMetaData: Deprecated.
since 5.2.230103 - use RevisionMetaData.getChangedStoreElements()
getFiletypeBindings() - Method in interface de.espirit.firstspirit.access.User: Get the file type bindings.
getFilterParams() - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Returns an (unmodifyable) map containing the actual filter parameters.
getFinishTime() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryControl: Returns the time this schedule entry has been finished or null when the entry has not finished.
getFinishTime() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryState: The date execution of this ScheduleEntry has been finished.
getFinishTime() - Method in interface de.espirit.firstspirit.access.schedule.TaskResult: The date execution of this task has been finished or null if the excecution has not yet finished.
getFirst() - Method in interface de.espirit.common.util.Listable: Get the first element provided by this listable.
getFirstChild() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns the first child node or null if there is no such node.
getFirstChild() - Method in interface de.espirit.firstspirit.access.editor.value.TableDomNode: Returns the first child node or null if there is no such node.
getFirstChild() - Method in interface de.espirit.firstspirit.access.editor.value.TableRowDomNode: Returns the first child node or null if there is no such node.
getFirstChild() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Provides the first child node.
getFirstCompleteRevision() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the first revision up to that the history is complete (i.e. has not been archived).
getFocus() - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData: Returns the focus area associated with this crop selection.
getFocusAreas(FocusAreaProviderContext) - Method in interface de.espirit.firstspirit.webedit.plugin.focus.FocusAreaProviderPlugin: Detects focus area presets available in the given image context.
getFolder() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the folder of the binary medium.
getFolder() - Method in interface de.espirit.firstspirit.scheduling.agency.JobAgent: Provides a handle to the job folder.
getFolderLangSpec(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRefFolder: Get the folder specification for the given language
getFolderName() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: the folder name where pages should be generated in
if folder name is null or length zero, the schedule entry id will be used on task execution
getFolderPath() - Method in interface de.espirit.firstspirit.scheduling.agency.JobAgent: Provides the absolute path to the job folder.
getFolders(Store.Type) - Method in interface de.espirit.firstspirit.agency.ProjectRestriction: Retrieves the folder restrictions for the given type.
getFont(String) - Method in interface de.espirit.firstspirit.access.admin.FontStorage: Returns the font by name.
getFont(String) - Method in interface de.espirit.firstspirit.access.GenerationContext: Return a Font for the given name
getFontData(String) - Method in interface de.espirit.firstspirit.access.admin.FontStorage: Returns data for the specified font as stream.
getFontName() - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Provides the font name to be used for styling.
getFontNames() - Method in interface de.espirit.firstspirit.access.admin.FontStorage: Returns the names of all fonts installed on the server.
getFontStorage() - Method in interface de.espirit.firstspirit.access.AdminService: Provides the access object for installed fonts.
getFontStyle() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabAppearance: The font style the tab text should displayed with.
getFontUsages(String) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns a list of projects using the font specified by the given name.
getForbidden(String) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Returns all forbidden group IDs, if the permissions are not inherited.
getForbiddenExplicit(String) - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Returns all explicitly forbidden group paths, if the permissions are not inherited.
getForbidPolyglotDataHierarchy() - Method in interface de.espirit.firstspirit.access.project.Project: Indicates, whether it is forbidden to use language dependent forms on arbitrary levels in a data hierarchy.
getForceConnect() - Static method in class de.espirit.firstspirit.access.ConnectionManager: Indicates, whether to force connections.
getForm() - Method in interface de.espirit.firstspirit.access.editor.CheckboxEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ComboboxEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ContentAreaListValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ContentListEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.DatasetEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.DateEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.DomEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.DomTableEditorValue: Deprecated.

Get the form definition.
getForm() - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Get the form definition.
getForm() - Method in interface de.espirit.firstspirit.access.editor.FileEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ImageMapEditorValue: Deprecated.

Covariant return of concrete form element.
getForm() - Method in interface de.espirit.firstspirit.access.editor.LinkEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.LinkListEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ListEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.MediumEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.NumberEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ObjectChooserEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.PageRefEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.PermissionEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.PictureEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.RadiobuttonEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ReferenceEditorValue: Deprecated.

Get the GuiXml form definition values.
getForm() - Method in interface de.espirit.firstspirit.access.editor.TabListEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.TextareaEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.TextEditorValue: Deprecated.

Covariant return of concrete form container.
getForm() - Method in interface de.espirit.firstspirit.access.editor.ToggleEditorValue: Deprecated.

Provides the typed form.
getForm() - Method in interface de.espirit.firstspirit.client.access.editor.CatalogEditorValue: Deprecated.

Get the form definition.
getForm() - Method in interface de.espirit.firstspirit.client.access.editor.IndexEditorValue: Deprecated.

Get the form definition.
getForm() - Method in interface de.espirit.firstspirit.forms.FormData: Provides the form definition.
getForm() - Method in exception de.espirit.firstspirit.forms.InappropriateValueException: Get the form element the value has been evaluated to be inappropriate for.
getForm() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method to access the form definition for this gadget.
getForm(String) - Method in interface de.espirit.firstspirit.agency.FormsAgent: Produces a form container for the given definition.
getFormatTag() - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplate: Provides this format's tag.
getFormatTemplate() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns node's FormatTemplate.
getFormatTemplate() - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Provides the owning format template.
getFormatTemplate(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplateContainer: Search a FormatTemplate by given uid.
getFormatTemplate(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.FormatTemplates: Search a FormatTemplate by given uid
getFormatTemplates() - Method in interface de.espirit.firstspirit.access.editor.FormatTemplateAccess: Get all format templates, valid and visible for the editor.
getFormatTemplates() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreRoot: Access to the sub root node for format templates.
getFormatVersion() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings: Returns the json format setting.
getFormData() - Method in interface de.espirit.firstspirit.access.editor.Associate: Provides the form data to be indexed for this associate.
getFormData() - Method in interface de.espirit.firstspirit.access.link.Link: Gets the formdata container for this link.
getFormData() - Method in interface de.espirit.firstspirit.access.store.pagestore.DataProvider: Gets the formdata container of this element.
getFormData() - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreFolder: Gets a form data container containing containig all defined sitestore variables.
getFormData() - Method in interface de.espirit.firstspirit.access.store.templatestore.WorkflowScriptContext: Provides the form data defined within the current Task.
getFormData() - Method in interface de.espirit.firstspirit.workflow.WorkflowAgent.WorkflowProcessContext: Returns the custom form data object
getFormDataType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Convenience accessor providing the transfer type for FirstSpirit's FormData based data.
getFormDefaults() - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider: Get the form data containing the form's default values.
getFormUid() - Method in interface de.espirit.firstspirit.module.GadgetContext: Provides the form identifying uid.
getFreeSpaceShutdownLimit() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Get server minimum free space shutdown limit.
getFreeSpaceWarnLimit() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Get server minimum free space warning limit.
getFromId(DataAssociationHandler.Type<? extends DataAssociationHandler<T, A>>, String) - Method in interface de.espirit.firstspirit.webedit.DataAssociationAgent: Determines the association object belonging to the specified namespace and association identifier.
getFtpServerType() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: There are some predefined types which may be returned: FtpTarget.SYST_UNIX FtpTarget.SYST_NT FtpTarget.SYST_OS400 FtpTarget.SYST_MVS FtpTarget.SYST_VMS A null value signals auto detection.
Every other value should be a fully qualified class name of a custom class implementing org.apache.commons.net.ftp.FTPFileEntryParser and org.apache.commons.net.ftp.Configurable
getFullVersionString() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the full version string of the belonging FirstSpirit version.
e.g.
getGadgetId() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Provides the basic gadget identifier related to the form element of this gadget.
getGadgets() - Method in interface de.espirit.firstspirit.agency.FormValidationReport: Provides the names of gadgets being reported containing one or more issues.
getGcaByName(String) - Method in interface de.espirit.firstspirit.access.store.globalstore.GlobalStoreRoot: Returns the gca page with the given name or null if no page exist with this name
Calls getStoreElement(name, GCAPage.UID_TYPE)
getGDataAPiCredentials() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Deprecated.
since 5.2.180904 - no replacement
getGenerateAnchor() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateExtension: Indicates whether to generate an anchor tag when rendering.
getGeneratedFiles() - Method in interface de.espirit.firstspirit.scheduling.agency.GenerationAgent: Creates an iterable delivering the path for each generated file.
getGeneratedFiles(ScheduleContext) - Static method in enum class de.espirit.firstspirit.access.schedule.DeploymentUtil: Factory method to create an iterable delivering the path for each generated file.
getGenerateFlag(Language, TemplateSet) - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Get the generate flag for a specific language/template set combination.
getGenerateFor() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: The template sets for which this document group should be generated
getGenerateForAll() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: Indicates, whether to generate for all template sets.
getGenerateList() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Get a list of language/template set combinations which should be generated.
getGenerationContext() - Method in interface de.espirit.firstspirit.access.GenerationScriptContext: Provides access to the generation context.
getGenerationSource() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask: Get the generation source state.
getGenericProperties() - Method in class de.espirit.or.ConnectionConfiguration: Get the generic properties as a map
getGid() - Method in interface de.espirit.firstspirit.access.database.BasicEntityInfo: Provides the gid (universal unique identifier) of the entity.
getGid() - Method in interface de.espirit.firstspirit.access.editor.value.DatasetContainer: The gid of the entity
getGid() - Method in interface de.espirit.firstspirit.event.EntityInfo: Returns an optional entity gid.
An entity gid is supported by temporal sessions and entities.
getGid() - Method in interface de.espirit.firstspirit.event.EventInfo: Provides the element's gid.
getGid() - Method in class de.espirit.firstspirit.event.UrlEvent: The GID of the node if one exists.
getGid() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ContentReference: Get the gid of the referenced entity.
getGid() - Method in interface de.espirit.or.schema.Entity: Returns the gid of this entity, if the session supports gids and the gid is already created, else null.
getGid(IDProvider) - Method in interface de.espirit.firstspirit.common.GidAgent: Returns the gid for the given IDProvider.
getGlobalContentArea() - Method in interface de.espirit.firstspirit.access.store.globalstore.GlobalStoreRoot: Get the global content area node.
getGlobalErrors() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Returns the list of global errors.
getGlobalErrors(FeatureError.Level) - Method in exception de.espirit.firstspirit.store.access.nexport.exceptions.SyncOperationException: Returns a list of global import errors.
getGlobalId() - Method in interface de.espirit.firstspirit.agency.GlobalWebAppId: Returns the global web-app identifier.
getGlobalWebApps() - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Returns all configurable global web-apps.
getGlobalWebApps(boolean) - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Returns all configurable global web-apps with the option to include the ones from the system.
getGlobalWebAppUrl(String) - Method in interface de.espirit.firstspirit.agency.LegacyModuleAgent: Returns the absolute url to the specified global web-app.
getGlobalWebAppUrl(String, boolean) - Method in interface de.espirit.firstspirit.agency.LegacyModuleAgent: Returns the absolute url to the specified global web-app (with or w/o a FS SSO ticket).
getGom() - Method in exception de.espirit.firstspirit.access.store.templatestore.gom.GomValidationError: Get the GOM element.
getGom() - Method in interface de.espirit.firstspirit.client.access.editor.ValueEngineerContext: Gives the form definition as GOM element.
getGom() - Method in interface de.espirit.firstspirit.module.GadgetContext: Gives the form definition as GOM element.
getGomElement() - Method in interface de.espirit.firstspirit.webedit.plugin.translation.TranslationContext: The definition of the editor the content should be translated for.
getGomElementMappings() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList: Get a list of mappings from tag name to class supported by this list.
getGomElementMappings() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfos: Provides the mapping of tag names to entry types.
getGomElementMappings() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomList: Get a list of mappings from tag name to class supported by this list.
getGomElementTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement: Provides the tag for this GOM element.
getGomElementTag() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList: Get the tag name, the instance was produced for.
getGomElementTag() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement: Get the tag name, the instance was produced for.
getGomProvider() - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
since 5.2.21 - see type
getGomProvider() - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider: Get this template's GOM provider containing the hierarchical definition of the templates GUI including structure and input elements.
getGomProvider() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Get this template's GOM provider containing the hierarchical definition of the templates GUI including structure and input elements.
getGomSource() - Method in interface de.espirit.firstspirit.access.store.templatestore.GomSourceProvider: Get the source for a GOM based interface description.
getGraphicalNavigationMedia(int) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRefFolder: Gets the media for the given graphical navigation state (on of PageRefFolder.MEDIA, PageRefFolder.MEDIA_MOUSEOVER, PageRefFolder.MEDIA_SELECTED, PageRefFolder.MEDIA_SELECTED_MOUSEOVER) or null if no media is set for the given state.
getGraphicalNavigationMediaUid(int) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRefFolder: Gets the media uid for the given graphical navigation state (on of PageRefFolder.MEDIA, PageRefFolder.MEDIA_MOUSEOVER, PageRefFolder.MEDIA_SELECTED, PageRefFolder.MEDIA_SELECTED_MOUSEOVER) or null if no media uid is set for the given state.
getGraphicsEngineFileExtensions() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Returns a comma separated list file name extensions.
getGraphicsEngineType() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Deprecated.
since 5.2.191201 - no replacement
getGroupById(String) - Method in interface de.espirit.firstspirit.service.permission.groups.GroupRoot: Returns the first occurrence of a group with the given id or null ifno group exists with the given id.
getGroupByName(String) - Method in interface de.espirit.firstspirit.agency.ProjectMembersAgent: Gets the group with the specified name.
getGroups() - Method in interface de.espirit.firstspirit.access.project.Project: Returns a list of all groups of this project.
getGroups() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: a List of type Group containing all groups allowed to execute this ScheduleEntry interactive.
getGroups() - Method in interface de.espirit.firstspirit.agency.ProjectMembersAgent: Get all groups of the current project.
getGroups(User) - Method in interface de.espirit.firstspirit.access.project.Project: Returns a list of groups of this project where the given user belongs to (at least EVERYONE),or null if the given user isn't allowed to access this project.
getGroupsArray(User) - Method in interface de.espirit.firstspirit.access.project.Project: Returns groups of this project where the user belongs to (at least EVERYONE).
getGroupsIds() - Method in interface de.espirit.firstspirit.service.permission.groups.User: Returns an array of group ids this user belongs to.
getGroupsName() - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Provides the name of groups.
getGui(Frame) - Method in interface de.espirit.firstspirit.module.Configuration: Returns the configuration gui.
Do not use the provided frame instance as parent when opening a new window or dialog, this will result in invalid parent hierarchy and unreachable windows.
getGuiHost() - Method in interface de.espirit.firstspirit.access.GuiScriptContext: Returns the currently active gui host.
getGuiLanguage() - Method in interface de.espirit.firstspirit.access.Host: Returns the language which should be used for GUI rendering (e.g. tree labels)
getGuiXml() - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.
since 4.0.17 - use EditorValue.getForm() instead
getGuiXml() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomIncludeConfiguration: Get the GuiXML to be included.
getHashCode() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo: Provide this information object's hashcode.
getHddDirectories() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns directories used for disk space check (comma separated)
getHddShutdownLimit() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Deprecated.
since 5.2.230209 - replaced by ServerConfiguration.getFreeSpaceShutdownLimit().
getHddWarnLimit() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Deprecated.
since 5.2.230209 - replaced by ServerConfiguration.getFreeSpaceWarnLimit().
getHeader() - Method in interface de.espirit.firstspirit.access.store.templatestore.Snippet: Returns header expression of this snippet.
getHeader() - Method in interface de.espirit.firstspirit.agency.DataSnippet: Provides the header text being used as a short representation of the given object.
getHeader(Language) - Method in interface de.espirit.firstspirit.store.snippets.SnippetProvider: Get the evaluated header snippet presentation for the given language.
getHeader(D, Language) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataSnippetProvider: Provides the header text being used as a short representation of the given object.
getHeadline(Store) - Method in interface de.espirit.firstspirit.agency.UIAgent: Determines a headline to be used for the given store.
getHeight() - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium: Provides the image's height.
getHeight() - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium: Provides the height of the medium.
getHeight() - Method in interface de.espirit.firstspirit.access.project.mpp.MPPViewport: Get the viewport height in pixels.
getHeight() - Method in interface de.espirit.firstspirit.access.project.Resolution: Gets the height of the resolution
getHeight() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Get the height of the media in the given resolution.
getHeight() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the height of the current picture resolution or -1 if the picture is generated (scaled from the original resolution) on demand.
getHEX() - Method in enum class de.espirit.firstspirit.webedit.WebeditColor: Returns the HEX value representing the color in the sRGB color model (e.g.
getHFill() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Indicates, whether to horizontally fill a form by this form element.
getHidden() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Indicates, whether this form element is visible in the form.
getHidden() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement: Indicates, whether the component will be hidden or shown.
getHistory() - Method in interface de.espirit.firstspirit.access.Task: Get task state history
getHistory() - Method in interface de.espirit.firstspirit.storage.HistoryProvider: Returns the revisions history of this storeelement, starting with the newest revision descending to the initial revision.
getHistory(KeyValue) - Method in interface de.espirit.or.Session: Return the history of the entity with the given keyValue.
getHistory(Date, Date, int, Filter<Revision>) - Method in interface de.espirit.firstspirit.storage.HistoryProvider: Returns a list of revisions of this store element in descending order.
All returned revisions are in the specified time range.
getHistory(Date, Date, int, boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Get the execution history of server schedule entries.
getHistory(Date, Date, int, Project) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Get the execution history of schedule entries of the given project.
getHorizontalSpace() - Method in interface de.espirit.firstspirit.access.editor.value.GraphicalMedium: Provides the horizontal spacing for the image.
getHost() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the hostname to connect to.
getHost() - Method in interface de.espirit.firstspirit.access.Connection: Get server host
getHost() - Method in class de.espirit.firstspirit.access.ConnectionManager.SocketParam: Provides the name of the host.
getHost() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The host of the ftp server
getHost() - Method in class de.espirit.or.ConnectionConfiguration: Returns the host as string.
getHTMLEncoding() - Method in interface de.espirit.firstspirit.access.Language: Gets the HTMLEncoding of this language
getHtmlTemplateProvider() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings: Get the currently set HtmlTemplateProvider.
getHtmlTextType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Convenience accessor providing the transfer type representing an html text access.
getHttpProxyHost() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The host used for http proxy.
getHttpProxyLogin() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The login used for http proxy.
getHttpProxyPassword() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The password used for http proxy login.
getHttpProxyPort() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The port used for http proxy.
getHumanReadableSize(Map<String, String>) - Static method in exception de.espirit.firstspirit.store.access.mediastore.MediaConstraintsException: Returns human readable values.
getIcon() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabAppearance: The icon of the application tab that will be shown in tab button.
getIcon() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessPlugin: Provides an icon to be shown when displaying this plug-in or information thereon.
getIcon() - Method in interface de.espirit.firstspirit.scheduling.aspects.IconProviding: Provides an icon for this application.
getIcon() - Method in interface de.espirit.firstspirit.webedit.client.api.ClientItem: Returns the action's icon to be used for visualization.
getIcon() - Method in interface de.espirit.firstspirit.webedit.plugin.status.WebeditStatusNote: Returns the icon associated with this status information.
getIcon(boolean) - Method in interface de.espirit.firstspirit.client.plugin.ReportPlugin: Returns a URL for the report's icon graphic that will be shown in the client.
getIcon(boolean) - Method in interface de.espirit.firstspirit.webedit.plugin.WebeditReportPlugin: Deprecated.

Returns a URL for the report's icon graphic that will be shown in the WebClient.
getIcon(IDProvider) - Method in interface de.espirit.firstspirit.agency.UIAgent: Provides an icon for the given id providing store element.
getIcon(ContextMenuContext) - Method in interface de.espirit.firstspirit.client.plugin.contextmenu.JavaClientContextMenuItem: Returns the icon of this item or null if this item has no icon.
The recommended dimensions for this icon is 19x19
getIcon(ContextMenuContext) - Method in enum class de.espirit.firstspirit.client.plugin.contextmenu.SeparatorContextMenuItem: Noop.
getIcon(ExternalPreviewContext) - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewItem: Returns an icon representing this report plug-in, or null if not available.
getIcon(ToolbarContext) - Method in interface de.espirit.firstspirit.client.plugin.toolbar.JavaClientToolbarItem: Returns the icon of this item or null if this item has no icon.
The recommended dimensions for this icon are: Within 25x25 px for java client toolbar button 19x19 in toolbar sub items Ensure to deliver icons of the same dimension in all methods delivering icons (icon, pressed, roll over)
getIcon(ApplicationPlugin.IconType) - Method in interface de.espirit.firstspirit.server.application.ApplicationPlugin: Returns the icon representing the application.
getIcon(C) - Method in interface de.espirit.firstspirit.client.plugin.JavaClientExecutablePluginItem: Provides the icon of this item.
getIcon(D) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataSnippetProvider: Provides a type image resource for the given object or null if no type image is available.
getIcon(FsResource.FsIcon.ICON) - Method in interface de.espirit.firstspirit.agency.FsResourceAgent: Returns the icon for the specified fs resource icon definition.
getIcon(T) - Method in interface de.espirit.firstspirit.client.plugin.report.DataRenderer: Provides the evaluated image resource for the given object or null if an type image is not available.
getIconPath(ToolbarContext) - Method in interface de.espirit.firstspirit.webedit.plugin.toolbar.ClientScriptProvidingToolbarActionsItem: Returns a URL for the button item's icon graphic that will be shown in the WebClient.
getIconPath(ToolbarContext) - Method in interface de.espirit.firstspirit.webedit.plugin.toolbar.ExecutableToolbarActionsItem: Returns a URL for an icon graphic associated with this item.
getIconPath(InlineEditContext) - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.ClientScriptProvidingInlineEditItem: Returns a URL for the button item's icon graphic that will be shown in the WebClient.
getIconPath(InlineEditContext) - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.ExecutableInlineEditItem: Returns a URL for the button item's icon graphic that will be shown in the WebClient.
getIconPath(C) - Method in interface de.espirit.firstspirit.client.plugin.WebeditExecutablePluginItem: Provides the resource path to this item's icon.
getIconPath(C) - Method in interface de.espirit.firstspirit.webedit.plugin.ClientScriptProvidingItem: Provides the resource path to this item's icon.
getIconType() - Method in interface de.espirit.firstspirit.access.project.mpp.MPPViewport: Get the viewport icon type.
getId() - Method in interface de.espirit.firstspirit.access.editor.fslist.IdProvidingFormData: Get the current form data identifier.
getId() - Method in interface de.espirit.firstspirit.access.editor.value.SectionList.DataSheet: Deprecated.
since 5.2.21 - see type
getId() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Gets the id of this package.
getId() - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup: Gets the unique ID of this PublishGroup.
getId() - Method in interface de.espirit.firstspirit.access.Principal: Returns the unique id of this principal
getId() - Method in interface de.espirit.firstspirit.access.project.PresentationChannel: Provides the element id of this channel.
getId() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the ID of this project.
getId() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Provides the ID for this template set.
getId() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Provides the id of the referenced node (store-element).
getId() - Method in enum class de.espirit.firstspirit.access.schedule.FtpTarget.FtpServerType: Returns either the system key or a fully qualified class name.
getId() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: -1 for unsaved new entries
getId() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryControl: Returns the execution id.
getId() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryState: Returns the execution id.
getId() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTemplate: Returns the id of the schedule task template.
getId() - Method in interface de.espirit.firstspirit.access.store.IDProvider: Returns the unique ID of this IDProvider
getId() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageGroup: Provides this group's id.
getId() - Method in interface de.espirit.firstspirit.access.Task: Get task id
getId() - Method in interface de.espirit.firstspirit.agency.ProjectAgent: The id of the project.
getId() - Method in interface de.espirit.firstspirit.client.access.editor.lists.Catalog.Card: Provides the unique identifier of this card.
getId() - Method in interface de.espirit.firstspirit.event.EntityInfo: Provides an optional entity native id.
This value is supported by temporal sessions and entities only.
getId() - Method in interface de.espirit.firstspirit.forms.IdentifiedFormData: Get the form data's identification.
getId() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: The automatically assigned, internal id.
getId() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns the id of this group.
getId() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns the object id.
getId() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.IdReference: Get the id of the referenced element.
getId() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the revision id of this revision.
getId() - Method in interface de.espirit.firstspirit.storage.Tag: Returns the id of this tag.
getId() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportElementInfo: Provides the id of the element.
getId() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the store-element id.
getId() - Method in interface de.espirit.or.Layer: Provides the ID of the layer.
getId(String, Object) - Method in interface de.espirit.firstspirit.webedit.DataAssociationAgent: Returns the identifier of the specified data association.
getId(A) - Method in interface de.espirit.firstspirit.webedit.DataAssociationHandler: Returns the identifier of the given association.
getId(DataAssociationHandler.Type<? extends DataAssociationHandler<T, A>>, A) - Method in interface de.espirit.firstspirit.webedit.DataAssociationAgent: Returns the identifier of the specified data association.
getID() - Method in interface de.espirit.firstspirit.workflow.model.WorkflowElement: Provides the ID of this workflow element.
getIdClass() - Method in interface de.espirit.firstspirit.service.treedata.TNodeProvider: Returns id class of this provider.
getIdentifier() - Method in interface de.espirit.firstspirit.client.access.editor.lists.Index.Record: The identifier of this record.
getIdentifier() - Method in interface de.espirit.firstspirit.client.EditorItemNode: The item's identifier.
getIdentifier() - Method in interface de.espirit.firstspirit.client.gui.applications.ApplicationTabConfiguration: Returns an identifier used to identify the application tab which will be created based on this configuration.
getIdentifier() - Method in interface de.espirit.firstspirit.client.plugin.ItemIdentifiable: Returns a unique identifier for the contextual item.
getIdentifier() - Method in interface de.espirit.firstspirit.ui.gadgets.GadgetIdentifierProvider: Returns the identifier of a targeted gadget.
getIdentifier() - Method in class de.espirit.or.query.Parameter: Returns the identifier of this parameter.
getIdentifier() - Method in interface de.espirit.or.schema.Entity: Return the identifier of this entity.
getIdentifier(D) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessSession: Provide a unique identifier for the given data object.
getIdentifier(Object) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.Identifying: Try creating an identifier for the given data object.
getIdentifiers() - Method in interface de.espirit.firstspirit.client.access.editor.lists.IndexAccessor: Provides the list of identifiers as entered in the index component.
getIdentifierValue(String) - Method in interface de.espirit.firstspirit.event.EntityInfo: Provides the value stored at the given key from the entity's identifier.
getIds() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodes: Returns a immutable collection of all selected ids.
getIgnoreContentAndMedia() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not content and media stores are to be archived.
getIgnoreTemplateStore() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not the template store is to be ignored for this cleanup task.
getImage() - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium: Provides the medium the map bases upon.
getImageFromIcon(Icon) - Method in interface de.espirit.firstspirit.agency.ImageAgent: Creates an Image container based on the given icon object.
getImageFromMedia(Media) - Method in interface de.espirit.firstspirit.agency.ImageAgent: Creates an Image container based on the given media object.
getImageFromUrl(String) - Method in interface de.espirit.firstspirit.agency.ImageAgent: Creates an Image container based on the given url pointing to some image.
getImageRotation() - Method in class de.espirit.firstspirit.access.store.mediastore.PictureCropData: Gets image orientation in degree.
getImportVersion() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the version of the package version which had been imported.
getImportVersionTag() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the tag of the package version which had been imported.
getIncludeConfiguration() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomElement: Provides access to an include configuration object.
getIncludeConfiguration() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomList: Get the configuration, if this is an included element.
getIncludeConfiguration() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomElement: Get the configuration, if this is an included element.
getIncludes() - Method in class de.espirit.firstspirit.module.descriptor.WebAppDescriptor.FilterDescriptor: Returns a list of paths that should be included by a filter using this definition.
getIncomingReferences() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns all incoming references of this StoreElement.
getIncomingReferences(Entity) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Returns current incoming references of the given entity.
getIncomingReferences(Entity, boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Returns current or release incoming references of the given entity.
getIndex() - Method in enum class de.espirit.firstspirit.access.editor.value.ListDomNode.Style: Returns the styles index.
getIndex() - Method in interface de.espirit.firstspirit.access.store.DataValue: Deprecated.
since 5.2.21 - see type
getIndex() - Method in class de.espirit.firstspirit.access.store.PageParams
getIndex() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskControl: Provides the index of the task with respect to the execution chain.
getIndex() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskDefinition: Provides the index of the task with respect to the execution chain.
getIndexTerm() - Method in interface de.espirit.firstspirit.access.editor.Associate: Provides the term to be written identifying the associate in the index.
getIndexTreatment() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomIndexTreatment: Provides the option defining how to treat following associations.
getInfo() - Method in interface de.espirit.firstspirit.parser.Printable: The descriptive text shown in template stack traces.
getInheritedPrincipalPermissions() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns a list of Principal's for which permissions are defined at this storelement including the inherited permissions on parent path.
getInlinePreviewConstraints() - Method in interface de.espirit.firstspirit.access.project.Project: Get the media constraints settings of this project.
To change the settings one have to perform the three steps: 1.) get the inline preview constraints, 2.) change the constraints, 3.) set the changed constraints
getInlinePreviewControlOption() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Returns the default respectively fixed content highlighting mode, depending on return value of InlinePreviewConstraints.isInlinePreviewControlAdjustable().
getInnerNode() - Method in class de.espirit.firstspirit.ui.gadgets.GadgetIdentifier: Get the inner node of a hierarchical identifier.
getInputStream() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Returns the file content as an InputStream.
getInputStream(Resolution) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Get the picture content of the current picture-media as an input stream.
getInRevision(Revision) - Method in interface de.espirit.firstspirit.access.store.IDProvider: Get this element in the state of the given revision.
getInstalledExportFiles(long) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Get filename list of installed exports and backups.
getInstalledVersion() - Method in interface de.espirit.firstspirit.module.ProjectEnvironment: returns the installed version string of the component
getInstalledVersion() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Returns the installed version of the component.
getInstalledVersion(String) - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Returns the version of the given module.
getInternalURL() - Method in interface de.espirit.firstspirit.module.WebServer: Returns the internal URL to this web server
getInterval() - Method in interface de.espirit.firstspirit.access.schedule.IntervalExecutionSchedule: The interval dependent ScheduleEntry should be executed (in milliseconds).
getInvalidEntities(KeyValue) - Method in interface de.espirit.or.Session: Return a list of invalid entities of the given keyValue.
getIsBackup() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get backup flag, used for backup file target directory (export or backup directory).
getIsBackup() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask2: Indicates that this is a backup operation.
getItem() - Method in interface de.espirit.firstspirit.client.access.editor.lists.Catalog.Card: Provides the item referred to with this card.
getItemNode() - Method in interface de.espirit.firstspirit.client.EditorNode: Provides a subsequent node identifying an entry of the edit component referenced by this node.
getItems() - Method in class de.espirit.firstspirit.client.plugin.dataaccess.aspects.ReportItemsProviding.Adapter: Provides an arbitrary number of report items defining actions available with a single entry.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.ReportItemsProviding: Provides an arbitrary number of report items defining actions available with a single entry.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewItemsPlugin: Provide items regarding external preview services.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.ItemsPlugin: Get all items eligible for the plug-ins contextual setting.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.JavaClientContextNewMenuItemsPlugin: Get all items eligible for context menus.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.JavaClientContextPluginsMenuItemsPlugin: Get all items eligible for the plugins menu.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.JavaClientEditorialToolbarItemsPlugin: Provide toolbar specific items wrt. the plug-ins contextual setting.
getItems() - Method in interface de.espirit.firstspirit.client.plugin.report.ParameterSelect: Returns the list of selectable items for the related listbox on client side.
getItems() - Method in interface de.espirit.firstspirit.webedit.plugin.media.MediaManagementItemsPlugin: Get all items eligible for display in the plug-in's contextual setting.
getItems() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterSelect: Deprecated.

Returns the list of selectable items for the related listbox on client side.
getItems() - Method in interface de.espirit.firstspirit.webedit.plugin.status.WebeditStatusNote: Get all items eligible for display in the status note's contextual setting.
getItems() - Method in interface de.espirit.firstspirit.webedit.plugin.WebeditInlineEditItemsPlugin: Get all items eligible for display in the plug-in's contextual setting.
getItems() - Method in interface de.espirit.firstspirit.webedit.plugin.WebeditToolbarActionsItemsPlugin: Get all items eligible for display in the plug-in's contextual setting.
getItems(ClientItemContext, JavaScriptObject) - Method in interface de.espirit.firstspirit.webedit.client.api.ClientItemsPlugin: Requests action in the specified context.
getJdbcTypeCode(Column) - Method in interface de.espirit.or.Layer: Provides the JDBC defined type code for the given column type.
getJson() - Method in interface de.espirit.firstspirit.access.GenerationContext: Retrieves the json settings for this generation context.
getJunction() - Method in class de.espirit.firstspirit.access.search.Request: Provides the junction for clauses within this request.
getKeepAspectRatio() - Method in interface de.espirit.firstspirit.access.project.Resolution: Returns true if aspect ratio of the original resolution should be kept, false otherwise (default)
getKey() - Method in class de.espirit.common.util.Pair: The key of the pair.
getKey() - Method in interface de.espirit.firstspirit.access.editor.value.DatasetContainer: The key value of the entity.
getKey() - Method in interface de.espirit.firstspirit.access.editor.value.Option: Get a textual key of this option.
getKey() - Method in interface de.espirit.firstspirit.json.JsonPair: This method returns the current key of the pair.
getKey() - Method in class de.espirit.firstspirit.ui.gadgets.GadgetIdentifier: Get the key of the specific gadget component.
getKey() - Method in exception de.espirit.firstspirit.ui.operations.OperationSetupException: Provides a generic key for identifying the exception.
getKey() - Method in interface de.espirit.or.schema.EntityType: Provides the key used for identifying data entries.
getKey(int) - Method in interface de.espirit.common.util.IdentifierList: Returns the key at the given index.
getKey(T) - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomIncludeValueProvider: Return a unique key for a specific value.
getKeyValue() - Method in interface de.espirit.or.schema.Entity: Return the business key of this entity or null if this entity is in state NEW.
getKeyValue(int) - Method in interface de.espirit.or.EntityList: Returns the KeyValue of the element at the specified position in this list.
getKeyValues() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ContentReference: Get the values of the unique key of the entity.
getKeywords() - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec: Get the keywords of the folder
getKeywords() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec: Gets the keywords of this pagereference.
getKeyWords() - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot: Get the keywords of the sitestoreroot for the project master language.
getKeyWords(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreRoot: Get the language dependant keywords of the sitestoreroot for the given language.
getKind() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.IdReference: Get the kind of id reference.
getLabel() - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec: Get the label (menu-name) of the folder
getLabel() - 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.
getLabel() - 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.
getLabel() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo: Provides the stored label.
getLabel() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo: Get the label.
getLabel() - Method in interface de.espirit.firstspirit.client.plugin.ClientPluginAction: Deprecated.
since 5.0.103 with no replacement
getLabel() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataAccessPlugin: Provides a human-readable label to be shown when displaying this plug-in or information thereon.
getLabel() - Method in interface de.espirit.firstspirit.client.plugin.report.ParameterBoolean: Returns the label for the related checkbox on client side.
getLabel() - Method in interface de.espirit.firstspirit.client.plugin.report.ParameterSelect.SelectItem: Returns the label for the related list entry on client side.
getLabel() - Method in class de.espirit.firstspirit.event.TrackingEvent: Returns human-readable label of the tracking point, if available
getLabel() - Method in interface de.espirit.firstspirit.server.application.ApplicationPlugin: The label to be displayed at the application icon.
getLabel() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.Labelable: Gets the label of this component.
getLabel() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience implementation returning the display label for this gadget.
getLabel() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterBoolean: Deprecated.

Returns the label for the related checkbox on client side.
getLabel() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterSelect.SelectItem: Deprecated.

Returns the label for the related list entry on client side.
getLabel(ContextMenuContext) - Method in interface de.espirit.firstspirit.client.plugin.contextmenu.JavaClientContextMenuItem: Provides a label for this item wrt. the given context.
getLabel(ContextMenuContext) - Method in enum class de.espirit.firstspirit.client.plugin.contextmenu.SeparatorContextMenuItem: Noop.
getLabel(ExternalPreviewContext) - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewItem: Returns a human-readable title representing this report plug-in.
getLabel(ToolbarContext) - Method in interface de.espirit.firstspirit.client.plugin.toolbar.JavaClientToolbarItem: Provide the label for this item.
getLabel(ToolbarContext) - Method in interface de.espirit.firstspirit.webedit.plugin.toolbar.ClientScriptProvidingToolbarActionsItem: Provides a label for this item wrt. the given context.
getLabel(ToolbarContext) - Method in interface de.espirit.firstspirit.webedit.plugin.toolbar.ExecutableToolbarActionsItem: Provides a label for this item.
getLabel(InlineEditContext) - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.ClientScriptProvidingInlineEditItem: Provides a label for this item.
getLabel(InlineEditContext) - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.ExecutableInlineEditItem: Provides a label for this item.
getLabel(Locale) - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns language specific label.
getLabel(C) - Method in interface de.espirit.firstspirit.client.plugin.ExecutablePluginItem: Provides a label for this item wrt. the given context.
getLabel(C) - Method in interface de.espirit.firstspirit.webedit.plugin.ClientScriptProvidingItem: Provides a label for this item wrt. the given context.
getLabel(Language) - Method in interface de.espirit.firstspirit.access.editor.value.Label: Try getting a label in the following order: the label for the specified language; the label for the fallback language; the value itself.
getLabel(String) - Method in interface de.espirit.firstspirit.access.editor.value.Label: Convenience method to get a label based on a language abbreviation.
getLang() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.DefaultGomLangInfo: Provides the language of this information.
getLang() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfo: Get the language the information is defined for.
getLangInfos() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Provides language dependent information on this form element, like a label and description for multiple languages.
getLangInfos() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomLangInfoProvider: Provides the language information.
getLangInfos() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.GomLabeledValueEntry: Provides a typed variant of the language information container.
getLangInfos() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomLangInfoProvider: Get the container of language information stored for this element.
getLanguage() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns the language of the reference.
getLanguage() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the language of the binary medium.
getLanguage() - Method in interface de.espirit.firstspirit.access.editor.value.DatasetContainer: The language for which this value is stored.
getLanguage() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the language this reference is stored for.
getLanguage() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Get the language of the selected reference.
getLanguage() - Method in interface de.espirit.firstspirit.access.GenerationContext: Returns the current Language of this generation context
getLanguage() - Method in interface de.espirit.firstspirit.access.GenerationScriptContext: The current generated language
getLanguage() - Method in interface de.espirit.firstspirit.access.schedule.DeltaGeneration.DeletedPageInfo: Language of deleted page.
getLanguage() - Method in interface de.espirit.firstspirit.access.store.LanguageInfo: Returns the Language this LanguageInfo storeelement belongs to.
getLanguage() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the language of the current File.
getLanguage() - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Get the language of the current picture-media
getLanguage() - Method in interface de.espirit.firstspirit.access.store.Monoglot: The language defining the data path in which the monoglot mode is to be used.
getLanguage() - Method in interface de.espirit.firstspirit.access.store.sitestore.FolderLangSpec: Get the language of the FolderLangSpec-object
getLanguage() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec: Get the language of the pagereference
getLanguage() - Method in interface de.espirit.firstspirit.agency.UrlAgent.UrlEntry: Returns the language for which this url entry is specified for.
getLanguage() - Method in class de.espirit.firstspirit.client.access.editor.EditorValueChangedEvent: Provides the language the event happened in.
getLanguage() - Method in interface de.espirit.firstspirit.client.access.editor.ValueEngineerContext: Get the language the engineer is targetting.
getLanguage() - Method in interface de.espirit.firstspirit.client.gui.model.EditorialLanguageModel: Returns the currently selected gui language.
getLanguage() - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.UrlGenerationContext: Returns the contextual Language when requesting the URL.
getLanguage() - Method in interface de.espirit.firstspirit.client.plugin.ExternalPreviewContext: Provides the contextual language of the current element.
getLanguage() - Method in exception de.espirit.firstspirit.forms.InappropriateValueException: Get the language the value was going to be applied for.
getLanguage() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonGenerationContext: Returns the current Language of this generation context.
getLanguage() - Method in class de.espirit.firstspirit.ui.gadgets.GadgetIdentifier: Get the language this identifier was created for.
getLanguage() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the language abbreviation, or null if not specified.
getLanguage() - Method in interface de.espirit.firstspirit.webedit.plugin.focus.FocusAreaProviderContext: Returns the data language the image has been associated with, if language-dependent.
getLanguage() - Method in interface de.espirit.firstspirit.webedit.plugin.inlineedit.InlineEditContext: Returns the language in which the inline editing items have been requested.
getLanguage() - Method in interface de.espirit.firstspirit.webedit.plugin.media.MediaManagementContext: Get the contextual language.
getLanguage() - Method in interface de.espirit.firstspirit.webedit.plugin.status.WebeditStatusNoteContext: Provides the language the element is shown in.
getLanguage(String) - Method in interface de.espirit.firstspirit.access.AdminService: Returns the given language or null.
getLanguage(String) - Method in interface de.espirit.firstspirit.access.project.Project: Get the content language with the specified abbreviation.
getLanguageAbbreviation() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The language abbreviation.
getLanguageAbbreviation() - Method in class de.espirit.firstspirit.event.UrlEvent: The abbreviation of the Language.
getLanguageChanges() - Method in interface de.espirit.firstspirit.storage.DataChangeDetail.EditorChange: Returns an unmodifiable map of language changes.
getLanguageForKey(Project, String) - Static method in class de.espirit.firstspirit.access.AccessUtil: Gets a single project language by its unique abbreviation.
getLanguageForKeyNotNull(Project, String) - Static method in class de.espirit.firstspirit.access.AccessUtil: Gets a single project language by its unique abbreviation.
getLanguageInfo(Language) - Method in interface de.espirit.firstspirit.access.store.IDProvider: Returns the LanguageInfo node for the given language
getLanguageInfo(Language) - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateBody: Returns the LanguageInfo node for the given language
getLanguages() - Method in interface de.espirit.firstspirit.access.AdminService: Get all languages.
getLanguages() - Method in interface de.espirit.firstspirit.access.project.Project: Returns a list of all project Languages.
getLanguages() - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provide access to available persistency languages.
getLanguages() - Method in interface de.espirit.firstspirit.agency.MultiFormValidationReport: Deprecated.
since 5.0.311, use MultiFormValidationReport.getLanguages(SpecialistsBroker) instead.
getLanguages(SpecialistsBroker) - Method in interface de.espirit.firstspirit.agency.MultiFormValidationReport: Provides the languages being reported containing problems, not including meta data problems.
getLanguageSpecificPage(Page) - Method in interface de.espirit.firstspirit.access.GenerationContext: Get the Page for the current language
getLast() - Method in interface de.espirit.firstspirit.client.EditorNode: Gets the last editor node of the chain starting from this node.
getLastChanged() - Method in interface de.espirit.firstspirit.access.store.StoreElement
getLastChangeDate() - Method in class de.espirit.firstspirit.access.store.PageParams: Calculate the last change date.
getLastChangeDate(long) - Method in class de.espirit.firstspirit.access.store.PageParams: Calculate the last change date after the provided timestamp.
getLastChangeDate(long) - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams.ContentPageParams: Calculate the last change date after the provided timestamp.
getLastChangeTime(Select) - Method in interface de.espirit.or.Session: Get the timestamp of the last change of the result set of the specified select.
getLastChangeTime(Select, long) - Method in interface de.espirit.or.Session: Get the timestamp of the last change of the result set of the specified select after the specified timestamp.
getLastDuration() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryStatistic: Returns the last execution time in milliseconds
getLastExecutionEndTime() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryStatistic: Returns the end time of last date this ScheduleEntry has been executed or null if the schedule entry has never been executed yet.
getLastExecutionTime() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryStatistic: Returns last date this ScheduleEntry has been executed (start time) or null if the schedule entry has never been executed yet.
getLastImport() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Returns the date of the last import.
getLastImportLogfile() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Returns the import log file of the last import of this subscription or null if no import log file exists.
getLastLogin(long) - Method in interface de.espirit.firstspirit.agency.UserStatisticsAgent: Returns the date of the last login to the FirstSpirit server performed by this user.
getLastLoginAsDate(long) - Method in interface de.espirit.firstspirit.agency.UserStatisticsAgent: Deprecated.
since 5.2.180703 - use UserStatisticsAgent.getLastLogin(long) instead
getLastModified() - Method in interface de.espirit.firstspirit.io.FileHandle: Get the last modification time of the referenced file in milliseconds.
getLastRemoteAddr() - Method in interface de.espirit.firstspirit.client.io.crc.CRCSession: The remote address the last call was coming from.
getLastUsageTime() - Method in interface de.espirit.firstspirit.client.io.crc.CRCSession: The time this session was last used.
getLayer() - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Provides the layer name for this schema.
getLayer() - Method in class de.espirit.or.ConnectionConfiguration: Get the layer as string.
getLayer(LayerMapper.MappingContext) - Method in interface de.espirit.firstspirit.transport.LayerMapper: Gets the name of the layer to be used for the given schema.
getLayer(LayerMapper.MappingContext) - Method in class de.espirit.firstspirit.transport.LayerMapper.LayerNameBasedLayerMapper: Gets the name of the layer to be used for the given schema.
getLayer(LayerMapper.MappingContext) - Method in class de.espirit.firstspirit.transport.LayerMapper.SchemaUidBasedLayerMapper: Gets the name of the layer to be used for the given schema.
getLayer(String) - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.DatabaseLayerMapper: Deprecated.
since 5.2.513 - use LayerMapper instead
getLayer(String) - Method in class de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.MapDatabaseLayerMapper: Deprecated.
since 5.2.513 - use LayerMapper instead
getLayerByClassName(String) - Method in interface de.espirit.firstspirit.access.database.Layer: Return the layer from type className.
getLayerById(String) - Method in interface de.espirit.firstspirit.access.database.Layer: Return the layer with the given id see Layer.getId().
getLayerIDMapping() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Is used in addition to getLayerMapping().
getLayerIds() - Method in interface de.espirit.firstspirit.access.database.Layer: Deprecated.
since 5.2.230101 - use Layer.getAvailableLayerIds() instead
getLayerMapper() - Method in interface de.espirit.firstspirit.feature.FeatureInstallOptions: Retrieve the LayerMapper to be used during feature installation, or null if not specified.
getLayerMapping() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Is used in addition to getLayerIDMapping().
getLayerNames() - Method in interface de.espirit.firstspirit.access.store.templatestore.SchemaContainer: A layer encapsulates a server data source, ususally a relational database.
getLayerNames() - Method in interface de.espirit.firstspirit.access.store.templatestore.SchemaFolder: A layer encapsulates a server data source, ususally a relational database.
getLayers() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the layer names defined for this project.
getLayout() - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Provides the type of the layout used for arranging the schema's entries.
getLdapContext() - Method in interface de.espirit.firstspirit.service.permission.scripting.PermissionServiceScriptContext: Returns the dir context specified in the belonging section in the service.ini of the permission service or null if no ldap.URL is specified in the service.ini.
getLDAPSection() - Method in interface de.espirit.firstspirit.access.User: Gets the LDAPSection attribute of the User object
getLDAPSections() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Provides a map of LDAP sections.
getLeftTop() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.RectArea: Provides the left top coordinate.
getLegacyClassName() - Method in interface de.espirit.firstspirit.generate.UrlCreatorSpecification: Legacy class name (for backward compatibility only).
getLength() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupFile: Returns the length of the backup file
getLength() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the length of the export file or -1 if content length is unknown (e.g. for directories)
getLength() - Method in interface de.espirit.firstspirit.feature.FeatureFile: The length of the belonging feature transport zip file.
getLevel() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns the depth level of this group.
getLevel() - Method in exception de.espirit.firstspirit.ui.gadgets.ComponentConstructionException: Get the level of this exception.
getLevelRule(int) - Method in interface de.espirit.firstspirit.access.schedule.DeltaGeneration: Get the depth of the level to re-generate when a folder at the provided level has changed.
getLicenseExpirationDate() - Method in interface de.espirit.firstspirit.license.LicenseService: Returns expiration date of license.
getLifespan() - Method in interface de.espirit.firstspirit.access.store.pagestore.Section: Get the lifespan of the current section if there is one defined.
getLifespan() - Method in interface de.espirit.firstspirit.access.store.pagestore.SectionReference: Get the lifespan of the referenced source section if there is one defined.
getLimitDuration() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not the maximum run-time of this task is to be limited.
getLine() - Method in exception de.espirit.firstspirit.access.template.ParsingError: Provides the line where the problem occurred.
getLinefeed() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Not evaluated by FirstSpirit.
getLink() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.Area: Provides the link this area is pointing to, if any.
getLink() - Method in interface de.espirit.firstspirit.access.editor.value.LinkDomNode: Returns the link object of this node.
getLinkConfigExternal() - Method in interface de.espirit.firstspirit.opt.office.TransformationRules: Get the external Link-Configuration (something like "Externer_Link.standard).
getLinkConfigInternal() - Method in interface de.espirit.firstspirit.opt.office.TransformationRules: Get the internal Link-Configuration (something like "Externer_Link.standard).
getLinkExtension() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateExtension: Get the link-extension of the TemplateExtension
getLinkLanguage() - Method in interface de.espirit.firstspirit.access.link.Link: Provides the language the link is created for.
getLinkTemplates() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreRoot: Access to the sub root node for link templates.
getList(String) - Method in interface de.espirit.or.schema.Entity: Return the value of the specified list attribute ("to N relation").
getLocalActiveMode() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The client to server communication may be performed in local active or passive mode.
getLocale() - Method in interface de.espirit.firstspirit.access.Language: Return Locale corresponding to this language
getLocale() - Method in interface de.espirit.firstspirit.access.template.Evaluator: Provides the currently defined locale.
getLocale() - Method in interface de.espirit.firstspirit.agency.ApplicationAgent: Provides the locale, the application is operating in.
getLocale() - Method in interface de.espirit.firstspirit.webedit.client.api.Common: Provides the locale with which the webedit UI is localized.
getLocale() - Method in interface de.espirit.firstspirit.webedit.WebeditUiAgent: Provides the locale with which the webedit UI is localized.
getLocaleKey() - Method in interface de.espirit.firstspirit.access.template.Evaluator: A locale key, default value is Evaluator.getLocale().getLanguage().toUpperCase()}.
getLocalizationAgent() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method to get the agent providing localization functionalities.
getLocalizedMessage() - Method in class de.espirit.firstspirit.access.Task.VerifyError: Returns a localized message describing the error.
getLocalizedMessage(ResourceBundle) - Method in exception de.espirit.common.CheckedException: Return a localized exception message.
getLockFailedElements() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all elements which couldn't be locked for delete
getLockFailedElements() - Method in interface de.espirit.firstspirit.access.store.ReleaseProgress: Deprecated.
since 5.2.180606, use ReleaseOperation instead
getLockFailedElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of all elements which couldn't be locked for deletion.
getLog() - Method in interface de.espirit.firstspirit.access.ActionProgress: Returns the current log since the last progress poll.
getLog() - Method in interface de.espirit.firstspirit.agency.RenderingAgent.RenderResult: The log produced during rendering.
getLogDir() - Method in interface de.espirit.firstspirit.module.ServerEnvironment: Returns the FileSystem as access to the log directory of this environment.
Components which uses this environment should store their log files in this directory.
getLogfile() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Get a logfile stream.
getLogfile() - Method in interface de.espirit.firstspirit.access.schedule.LogfileProvider: Get a logfile stream.
getLogfileName() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Returns the name of this logfile.
getLogfiles(Subscription) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a list of all import logfiles existing for the given subscription.
getLogFiles(PackageVersion) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a list of package version log files created during package version create of the package version specified by the given package version.
The list is sorted in descending order based on the logfile number.
Normally the returned list will only contain one entry.
getLogfileSize() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Get the size of the logfile returned in PackageLogfile.getLogfile()
getLogfileSize() - Method in interface de.espirit.firstspirit.access.schedule.LogfileProvider: Get the size of the logfile returned in getLogfile()
getLogger() - Static method in class de.espirit.common.base.Logging: Get the Logger instance.
getLogger() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonGenerationContext: Returns the JsonGenerationContext.JsonLogger of the current JsonGenerationContext.
getLogin() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The login name, used to log on the ftp server
getLogin() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The login name
getLogin() - Method in interface de.espirit.firstspirit.service.permission.groups.User: Returns the login of this user or null if not specified.
getLoginName() - Method in exception de.espirit.firstspirit.access.DuplicateUserException: Returns the login name which caused this exception.
getLoginName() - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration: Returns the login name of the user which is used for the connection to the remote project or null if the current user should be used.
getLoginName() - Method in interface de.espirit.firstspirit.access.User: Get the login name.
getLoginPassword() - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration: Returns the password hash of the user which is used for the connection to the remote project or null if the current user should be used.
getLogListenerSupport() - Static method in class de.espirit.common.base.Logging
getLogMessages() - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent.ModuleResult: Return any log message of the installation process.
getLongID() - Method in interface de.espirit.firstspirit.access.store.IDProvider
getLostAndFoundElements() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Provides the set of elements being moved to the lost and found folder instead of being deleted.
getLostAndFoundElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the set of elements being moved to the lost and found folder instead of being deleted.
getLostAndFoundStoreNodes() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Deprecated.
since 5.2.181006 - use FeatureInstallResult.getLostAndFoundElements() instead
getMaintenanceName() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: The descriptive name of the maintenance mode started by this task.
getMaintenanceProjects() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: All projects affected by the maintenance task.
getMaintenanceScope() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: Indicates the scope of this maintenance task, i.e. if only certain projects or the whole server is affected.
getMaintenanceScope() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: Indicates the scope of this maintenance task, i.e. if only certain projects or the whole server is affected.
getMajor() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the major version of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '5'.
getMajorVersion() - Method in interface de.espirit.firstspirit.access.export.ProjectInfo
getMajorVersion() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the major server version information.
getMap() - Method in interface de.espirit.firstspirit.client.common.text.CharacterReplacer: Return an unmodifiable containing all replacement rules of this character replacer.
getMappedDiagnosticContext() - Static method in class de.espirit.common.base.Logging: Get the MappedDiagnosticContext instance.
getMappedLayers() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: Mapping of layer names (key = layer name in source project; value = layer name in target project).
getMappings() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Shortcut for getMappings(false)
getMappings(boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Provides an array of TableTemplate.Mappings, whose entries are safe to change with no feedback to this template.
getMappings(TableTemplate.Mapping[], GomEditorProvider) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Convenience method for getMappings(oldMappings, gomProvider, false).
getMappings(TableTemplate.Mapping[], GomEditorProvider, boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Get the TableTemplate.Mappings for this template based on the given GOM provider.
getMasterLanguage() - Method in interface de.espirit.firstspirit.access.project.Project: Gets the master language.
getMasterLanguage() - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provides the persistency language used as master.
getMatch(String, Request, Language) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.RequestMatching: Provides a match object for the given data object with respect to the handed request and language.
getMatches(Request, T) - Method in interface de.espirit.firstspirit.client.access.editor.MatchSupporting: Calculate a list of matches for a given request-value pair.
getMatches(Language, Request) - Method in interface de.espirit.firstspirit.access.editor.EditorValue: Deprecated.

Find matches for the given request.
getMathContext() - Method in class de.espirit.firstspirit.access.template.MathematicalContext: Provides the defined mathematical context.
getMaxDuration() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns the maximum allowed run-time of this task.
getMaxEntries() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodesEditorValue: Deprecated.

Returns the maximum number of selectable entries (which is defined in GOM form).
getMaxFileSize() - Method in interface de.espirit.firstspirit.access.project.MediaConstraints: Get the project wide maximum file size for non image files in byte.
getMaxImageSize() - Method in interface de.espirit.firstspirit.access.project.MediaConstraints: Get the project wide maximum image size setting in byte.
getMaximumApplicationWidth() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the maximum allowed width of the inline preview frame or -1 if there is no restriction.
getMaximumColumnCount() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate: Returns the maximum column count.
Hint: In case of a value lower than minimum column count Integer.MAX_VALUE is returned.
getMaximumRowCount() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate: Returns the maximum row count.
Hint: In case of a value lower than minimum row count Integer.MAX_VALUE is returned.
getMaximumWarningCount() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the maximum number for acceptable warnings.
getMaxPageCount() - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the maximum number of pages to be generated.
getMaxProjects() - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns maximum number of allowed projects (possible license restriction).
getMaxResultCount() - Method in interface de.espirit.or.query.Select: The maximum number of entities this select will return.
getMaxRevision() - Method in interface de.espirit.firstspirit.access.store.Store: If the store is not based on current version: the revision on which the store is based.
getMaxRevisionAge() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Get the maximum age in milliseconds of export element revisions to include in the export.
getMaxRevisionAge() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask: Provides the maximum age in milliseconds of revisions being backed up.
getMaxRevisionCount() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Get the maximum count of revisions of an export element to include in the export.
getMaxRevisionCount() - Method in interface de.espirit.firstspirit.access.schedule.ProjectBackupTask: Provides the maximum number of revisions being backed up.
getMaxSessions() - Method in exception de.espirit.firstspirit.common.MaximumNumberOfSessionsExceededException: Get maximum licensed session count.
getMaxStringLength() - Method in class de.espirit.or.ConnectionConfiguration: Get the maximum string length.
getMDC() - Static method in class de.espirit.common.base.Logging
getMDC(String) - Method in interface de.espirit.common.base.MappedDiagnosticContext: Get the context identified by the key parameter.
getMedia() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the referenced element as firstspirit media object, if applicable.
getMedia() - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode: Returns the Media that is used as bullet icon.
getMedia() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Returns a set medium if any or null if reference is not a type of Media.
getMedia() - Method in interface de.espirit.firstspirit.webedit.plugin.focus.FocusAreaProviderContext: The contextual Media element the focus areas have been requested for.
getMediaBuilder() - Method in interface de.espirit.firstspirit.agency.PreviewUrlAgent: Returns a preview url builder for Media type StoreElements.
getMediaByUid(String) - Method in interface de.espirit.firstspirit.access.store.mediastore.MediaStoreRoot: Returns the media specified by given uid or null, if no media was found with given uid
getMediaConstraints() - Method in interface de.espirit.firstspirit.access.project.Project: Get the media constraints settings of thisproject.
To change the settings one have to perform the three steps: 1.) getting the media constraints, 2.) changing the constraints, 3.) setting the changed constraints
getMediaContent(Language) - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: Get the media-content of the current media for the given language as File or Picture object
getMediaPlayerFileExtensions() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Returns a comma separated list file name extensions.
getMediaType(Class<T>) - Method in interface de.espirit.firstspirit.agency.TransferAgent: Provides the transfer type for a given FirstSpirit media element type.
getMedium() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the medium of the binary medium.
getMembers() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageGroup: Get a copy of the sorted list of this group's members.
getMemory() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the amount of memory in megabytes available to the virtual machine.
getMemoryFileSystem() - Method in interface de.espirit.firstspirit.io.FileSystemsAgent: Provides a memory-based file system instance.
getMemoryLimit() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the maximum percentage of memory to be used.
getMemoryMax() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the maximum amount of memory that the Java virtual machine of the server will attempt to use
getMessage() - Method in exception de.espirit.firstspirit.access.editor.value.InvalidValueException: Provides the formatted error message.
getMessage() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: The message which is displayed to all users once the task has been started.
getMessage() - Method in exception de.espirit.firstspirit.access.template.ParsingError: Provides the error message.
getMessage() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: The message which is displayed to all users once the task has been started.
getMessage() - Method in class de.espirit.firstspirit.store.access.feature.FeatureError: The message describing this feature error.
getMessage() - Method in exception de.espirit.firstspirit.store.access.mediastore.MediaConstraintsException
getMessage() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Problem: The problem description.
getMessage(ResourceBundle) - Method in exception de.espirit.firstspirit.access.editor.value.InvalidValueException: Provides the formatted error message based on the given resource bundle.
getMessageCode() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.IntegrityValidating.Problem: The resource code for producing a localized problem message.
getMessageContext() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.IntegrityValidating.Problem: Get the context required for localizing the problem message.
getMessageDisplayType() - Method in interface de.espirit.firstspirit.access.schedule.MaintenanceModeTask: Indicates how the message is displayed to the users.
getMessageDisplayType() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: Indicates how the message is displayed to the users.
getMessages() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTestResult: contents of the log file or a string showing errors
getMessages(String, Language) - Method in interface de.espirit.firstspirit.agency.FormValidationReport: Get the messages produced for the given gadget.
getMeta() - Method in interface de.espirit.firstspirit.access.store.IDProvider: Deprecated.
since 4.2.450 - use IDProvider.getMetaFormData() instead
getMetaData() - Method in class de.espirit.firstspirit.agency.SnippetContext: Provide meta data to be used within a snippet definition.
getMetaData() - Method in interface de.espirit.firstspirit.storage.Revision: Returns the metadata of this revision.
getMetadataTemplate() - Method in interface de.espirit.firstspirit.access.project.Project: Get Metadata template id. -1 means no template set.
getMetaDataTemplate() - Method in interface de.espirit.firstspirit.agency.ProjectAgent: Provides the meta data template.
getMetaFormData() - Method in interface de.espirit.firstspirit.access.store.IDProvider: Returns the formdata container of this element or null if there is no meta data template defined for project.
getMetaLanguage() - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provide the language being used for meta data representation.
getMimeType() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get the mime-type.
getMimeType() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Returns the immutable MIME type.
getMimeType() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the mime-type of the current picture resolution.
getMinFsVersion() - Method in class de.espirit.firstspirit.module.descriptor.ModuleDescriptor: Returns the minimal version of FirstSpirit required to install this module.
getMinimumColumnCount() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate: Returns the minimum column count.
getMinimumRowCount() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableFormatTemplate: Returns the minimum row count.
getMinor() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the minor version of the belonging FirstSpirit version.
e.g.: If the FirstSpirit server runs with "5.0_BETA.31.51560" this method will return '0'.
getMinorVersion() - Method in interface de.espirit.firstspirit.access.export.ProjectInfo
getMinorVersion() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the minor server version information.
getMissingFeature() - Method in exception de.espirit.firstspirit.access.LicenseException: Returns the name of the missing license feature.
getMissingOutgoingReferences() - Method in interface de.espirit.firstspirit.access.store.RestoreProgress: Returns a map containing all referenced elements which could not be found, mapped from object key to store type.
getMissingOutgoingReferences() - Method in interface de.espirit.firstspirit.access.store.RevertProgress: Returns a map containing all referenced elements which could not be found, mapped from object key to store type.
getMissingPermissionElements() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all elements which couldn't be deleted cause of missing delete permissions.
getMissingPermissionElements() - Method in interface de.espirit.firstspirit.access.store.ReleaseProgress: Deprecated.
since 5.2.180606, use ReleaseOperation instead
getMissingPermissionElements() - Method in interface de.espirit.firstspirit.access.store.RestoreProgress: Returns a set of ids of all elements which couldn't be restored due to missing permissions.
getMissingPermissionElements() - Method in interface de.espirit.firstspirit.access.store.RevertProgress: Returns a set of ids of all elements which couldn't be reverted due to missing permissions.
getMissingPermissionElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of all elements which couldn't be deleted because of missing delete permissions.
getMissingReferences() - Method in interface de.espirit.firstspirit.feature.FeatureModel: Returns all missing references of this feature model existing at time calling this method.
getMode() - Method in interface de.espirit.firstspirit.access.Connection: Get the connection mode, either ConnectionManager.HTTP_MODE or ConnectionManager.SOCKET_MODE.
getMode() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns the cleanup mode.
getMode() - Method in class de.espirit.firstspirit.access.search.Request: Provides the mode for matching.
getMode() - Method in interface de.espirit.firstspirit.access.Task: Get task mode
getMode() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the mode which is currently active.
getModel() - Method in interface de.espirit.firstspirit.forms.Form: Get the object model of this form.
getModelActivity() - Method in interface de.espirit.firstspirit.access.TaskState: The activity creating this state
getModelState() - Method in interface de.espirit.firstspirit.access.TaskState: The workflow model state
getModification() - Method in class de.espirit.firstspirit.client.access.editor.Difference: Type of modification related to this difference.
getModificationRootElement() - Method in interface de.espirit.firstspirit.storage.ModifyOperation: Returns the root element of the save operation.
Example:
getModifiedPages() - Method in interface de.espirit.firstspirit.store.operations.SynchronizeTemplateBodiesOperation.Result: The pages that were altered during the synchronization.
getModifiedProjectProperties() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the EnumSet of modified project properties.
getModuleName() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns module name.
getModules() - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Return descriptors of all installed modules.
getMonoglot() - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
since 5.2.510, no replacement
getMonoglot() - Method in interface de.espirit.firstspirit.ui.gadgets.swing.SwingGadgetContext: Provides the language to be used for monoglot child forms.
getMotD(String) - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the Message of the Day of the specified language if it exists and should be visible, otherwise returns null.
getMotD(String, boolean) - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the Message of the Day of the specified language if it exists and checkActive is set to false, otherwise returns null.
getMovedElement() - Method in interface de.espirit.firstspirit.storage.MoveOperation: Returns the element which has been moved in the belonging move operation.
getMovedElementId() - Method in exception de.espirit.firstspirit.access.store.ElementMovedException: Returns the id of the element which should be moved and which causes this exception
getMovedElements() - Method in interface de.espirit.firstspirit.feature.FeatureInstallResult: Provides the set of moved elements.
getMovedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on moved elements.
getMovedElements() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provides the set of moved elements.
getMovedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.ExportInfo: Get the detailed information on moved file handles.
getMovedFileHandles() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ExportOperation.Result: Get the detailed information on moved file handles.
getMultiPageParams(Language) - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
Since 5.0.104, no replacement.
getMultiPageParams(Language) - Method in interface de.espirit.firstspirit.access.store.MultiPageParamsProvider
getMultiPageParams(Language) - Method in interface de.espirit.firstspirit.access.store.pagestore.Content2Section: Delivers a ContentMultiPageParams where ContentMultiPageParams.getData() delivers a list with one entry.
getMultiPageParams(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the multi page parameters stored for the given language.
getMultiPageParams(Language, TemplateSet) - Method in interface de.espirit.firstspirit.access.store.ContentProducer
getName() - Method in class de.espirit.firstspirit.access.Attachment: Provides the attachment's name.
getName() - Method in interface de.espirit.firstspirit.access.backup.ServerBackupFile: Returns the file name of this backup file.
getName() - Method in interface de.espirit.firstspirit.access.database.Layer: Returns the name of the database layer.
getName() - Method in interface de.espirit.firstspirit.access.editor.Activity: Provides the name of this activity.
getName() - Method in interface de.espirit.firstspirit.access.editor.value.SectionList.DataSheet: Deprecated.
since 5.2.21 - see type
getName() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the file name of this export file.
e.g. myProject.tar.gz
getName() - Method in interface de.espirit.firstspirit.access.Language: Get the name of this language
getName() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Returns the name of this package.
getName() - Method in interface de.espirit.firstspirit.access.packagepool.PublishGroup: Returns the name of this PublishGroup.
getName() - Method in interface de.espirit.firstspirit.access.Principal: Returns the name of this principal.
getName() - Method in interface de.espirit.firstspirit.access.project.ConversionTable: Provides the given name for this conversion table.
getName() - Method in interface de.espirit.firstspirit.access.project.Group: Get name of the group
getName() - Method in interface de.espirit.firstspirit.access.project.PresentationChannel: Provides the name of this channel.
getName() - Method in interface de.espirit.firstspirit.access.project.Project: Get the unique project name
getName() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: Returns the name of this ScheduleEntry.
getName() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns the name of this task.
getName() - Method in interface de.espirit.firstspirit.access.store.BasicInfo: Returns a symbolic name for this info object.
getName() - Method in interface de.espirit.firstspirit.access.store.contentstore.ContentFolder: Get the name of the ContentStore-folder
getName() - Method in interface de.espirit.firstspirit.access.store.DataValue: Deprecated.
since 5.2.21 - see type
getName() - Method in exception de.espirit.firstspirit.access.store.ElementDeletedException: Returns the uid if it exists, the name otherwise.
getName() - Method in interface de.espirit.firstspirit.access.store.globalstore.GCAFolder: Get the name of the GCA-folder
getName() - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.mediastore.MediaFolder: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Returns the name of the underlying resolution (e.g.
getName() - Method in interface de.espirit.firstspirit.access.store.pagestore.Body: Get the name of a body for a Page
getName() - Method in interface de.espirit.firstspirit.access.store.pagestore.Page: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.pagestore.PageFolder: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.pagestore.Section: Get the name of the section
getName() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageGroup: Get the name of the page-group
getName() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec: Get the name of the pagereference
getName() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Deprecated.
since 4.1.10 - use PageRef.getUid()
getName() - Method in enum class de.espirit.firstspirit.access.store.Store.Type
getName() - Method in interface de.espirit.firstspirit.access.store.StoreElement
getName() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Provide the form element name following specific rules.
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement: Get the name identifying the editor's value.
getName() - Method in exception de.espirit.firstspirit.access.store.templatestore.gom.GomValidationError: Get the GomFormElement name.
getName() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.Item: Provides the item's name.
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.Query: Deprecated.
since 4.1.10 - use IDProvider.getUid()
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.Script: Provides the name of the script.
getName() - Method in enum class de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink.Region: Provides the name of this link.
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate.Mapping: Provides the given name for this mapping.
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateBody: Returns the name of the belonging body defined in the belonging page template.
getName() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateFolder: Get the name of this folder
getName() - Method in interface de.espirit.firstspirit.access.template.Context: Provides the given name of this context.
getName() - Method in interface de.espirit.firstspirit.access.User: Get a combination of login- and realname.
getName() - Method in interface de.espirit.firstspirit.agency.ProjectAgent: The full name of the project.
getName() - Method in interface de.espirit.firstspirit.agency.ProjectRestriction: The project's symbolic name.
getName() - Method in enum class de.espirit.firstspirit.base.store.StoreType: Returns old style store name (e.g.
getName() - Method in class de.espirit.firstspirit.client.access.editor.Node: The name of the node.
getName() - Method in interface de.espirit.firstspirit.client.EditorNode: The edit component's name.
getName() - Method in interface de.espirit.firstspirit.client.plugin.report.Parameter: Returns the name of this parameter.
getName() - Method in interface de.espirit.firstspirit.forms.FormField: Returns the name of the field.
getName() - Method in interface de.espirit.firstspirit.forms.RemoteFormField: Returns the name of the field.
getName() - Method in interface de.espirit.firstspirit.generate.UrlCreatorSpecification: Name definition from the module.xml.
getName() - Method in interface de.espirit.firstspirit.io.FileHandle: The name of the file (without path), or the last part of the name its a directory
getName() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns the component name which has to be unique inside a single module.
getName() - Method in interface de.espirit.firstspirit.module.descriptor.Descriptor: Returns the module or component identifier.
getName() - Method in exception de.espirit.firstspirit.module.NoSuchComponentException: Get the name of component failed to look up.
getName() - Method in exception de.espirit.firstspirit.module.UnsupportedGadgetTypeException: Get the name of the editor/module not supporting the respective type.
getName() - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService: Get the module name, same as in module.xml
getName() - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the name of the file.
getName() - Method in exception de.espirit.firstspirit.scheduling.agency.SettingsAgent.NoSuchSettingException: Provides the name of the requested setting.
getName() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskControl: Provides the name of the task.
getName() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskDefinition: Provides the name of the task.
getName() - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskForm.ScheduleTaskConfiguration: Provides the name of the task.
getName() - Method in interface de.espirit.firstspirit.server.configuration.ServerProperty: The name of the property as defined in the server configuration file, e.g.
getName() - Method in interface de.espirit.firstspirit.server.mediamanagement.exif.ExifTag: Get the name of the tag, such as Aperture, or InteropVersion.
getName() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns the name of this group or null if not set
getName() - Method in interface de.espirit.firstspirit.storage.Tag: Get the name of the tag.
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.ElementExportInfo: Delivers the name (normally the IDProvider.getUid() of the related element.
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.EntityTypeExportInfo: Delivers a combination of the schemaname and the entitytype of the related element (example: schemaName#entityType).
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.ExportInfo: Returns the name of this export info object.
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.FsMetaExportInfo: Returns FsMetaExportInfo.FS_META_EXPORT_INFO_NAME
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportElementInfo: Provides the name of the element.
getName() - Method in interface de.espirit.firstspirit.store.access.nexport.PropertyTypeExportInfo: Returns the name of the property or PropertyTypeExportInfo.PROPERTY_FS_METADATA for FirstSpirit meta files related to properties.
getName() - Method in class de.espirit.firstspirit.ui.gadgets.GadgetIdentifier: Get the name of the gadget.
getName() - Method in interface de.espirit.firstspirit.webedit.plugin.report.Parameter: Deprecated.

Returns the name of this parameter.
getName() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterBoolean: Deprecated.

Provides the parameter's name.
getName() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterSelect: Deprecated.

Privides the parameter's name.
getName() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterText: Deprecated.

Provides this parameter's name.
getName() - Method in interface de.espirit.firstspirit.workflow.model.Workflow: Returns the name of this workflow.
getName() - Method in interface de.espirit.or.schema.Attribute: Return the name of this attribute.
getName() - Method in interface de.espirit.or.schema.EntityType: Returns the name of this entity type.
getName() - Method in interface de.espirit.or.schema.Schema: Return the name of this schema.
getName(int) - Method in interface de.espirit.or.schema.Identifier: Returns the name at the specfied index.
getName(Locale) - Method in interface de.espirit.firstspirit.scheduling.ScheduleTaskApplication: Provides a name for this application, preferably respecting the given locale.
getNameFor(IDProvider) - Static method in enum class de.espirit.firstspirit.access.editor.value.BinaryMedium.Type: Get the name of the binary medium for the specified element.
getNames() - Method in interface de.espirit.or.schema.Identifier: Returns a list of all names representing the values of this identifier.
getNamespace() - Method in class de.espirit.firstspirit.webedit.DataAssociationHandler.Type: Returns the namespace of the assocation.
getNavigationContext() - Method in interface de.espirit.firstspirit.access.GenerationContext: Returns the origin node for relative urls.
getNewNode(int) - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the added node at the specified index.
Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
getNewNodeCount() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the count of nodes which were added during belonging package import.
getNewParentId() - Method in exception de.espirit.firstspirit.access.store.ElementMovedException: Returns the id of the new parent of the moved element
getNewValue() - Method in class de.espirit.firstspirit.client.access.editor.EditorValueChangedEvent: Provides the new value after the change.
getNext(int) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.DataStream: Returns an incremental result set of data objects based on the settings provided when starting the stream.
getNext(int) - Method in interface de.espirit.firstspirit.client.plugin.report.DataProvider: Returns an incremental result set of objects, potentially using start()'s parameter input as afilter configuration to limit the result set to match certain criteria.
getNext(int) - Method in interface de.espirit.firstspirit.webedit.plugin.report.ReportPluginProvider: Deprecated.

Returns an incremental result set of objects, potentially using start()'s parameter input as afilter configuration to limit the result set to match certain criteria.
getNextExecutionTime() - Method in interface de.espirit.firstspirit.access.schedule.ExecutionSchedule: Returns the next execution time or null for expired tasks.
getNextExecutionTime() - Method in interface de.espirit.firstspirit.access.schedule.FixedExecutionSchedule: Returns the next execution time or null for expired tasks.
getNextSibling() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns the next sibling node or null if there is no such node.
getNextSibling() - Method in interface de.espirit.firstspirit.access.editor.value.TableCell: Returns the next sibling node or null if there is no such node.
getNextSibling() - Method in interface de.espirit.firstspirit.access.editor.value.TableRowDomNode: Returns the next sibling node or null if there is no such node.
getNextSibling() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Provides the next sibling store element.
getNoBreak() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Indicates, whether the next form element should follow in the same line as this one.
getNode() - Method in interface de.espirit.firstspirit.access.GenerationContext: Provides the currently processed node, e.g., a PageRef.
getNode() - Method in interface de.espirit.firstspirit.access.link.Link: Deprecated.
since 5.2.21 - use Link.getFormData() and Link.setFormData(FormData) instead.
getNode(String) - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodesEditorValue: Deprecated.

Returns the node with the given id or null.
getNodeId() - Method in exception de.espirit.firstspirit.access.DuplicateReferenceNameException: The id of the node which causes this duplicate reference name exception.
getNodeId() - Method in interface de.espirit.firstspirit.access.schedule.DeltaGeneration.DeletedPageInfo: Sitestore node id for deleted page.
getNodeId() - Method in interface de.espirit.firstspirit.access.store.BasicElementInfo: Returns the id of the belonging storeelement
getNodeId() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The node id.
getNodeId() - Method in class de.espirit.firstspirit.event.UrlEvent: The id of the node (e.g.
getNodeId() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Problem: The node id of the problematic element.
getNodes(R, Collection<I>) - Method in interface de.espirit.firstspirit.service.treedata.TNodeProvider: Returns objects for the given ids.
getNodeTag() - Method in interface de.espirit.firstspirit.access.store.BasicElementInfo: Returns the node tag of the belonging store element.
getNodeType() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns the node type.
getNoEditorGroups() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Groups marked as no editor are not preselected as editor.
getNonChangeablePackagePoolElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of all elements which couldn't be deleted because they are package pool items and belong to a non changeable subscription.
getNonChangeablePackagePoolItems() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all elements which couldn't be deleted cause they are package pool items and belong to a non changeable subscription
getNonDisplayedSectionsRendering() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings: Gets the NonDisplayedSectionsRendering-parameter NonDisplayedSectionsRendering indicates whether non displayed Section should be rendered
getNoSchemaSyncLayers() - Method in interface de.espirit.firstspirit.access.project.Project: Get the layers for which no schema sync's should be performed.
getNotificationHost() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Access the notification host responsibly for this value holder.
getNotificationHost() - Method in interface de.espirit.firstspirit.ui.gadgets.swing.SwingGadgetContext: Gets the host to be used for notifications.
getNotifier() - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Provides a notifier on changes within these permissions.
getNotLockableElements() - Method in interface de.espirit.firstspirit.access.store.RevertProgress: Returns a set of ids of all elements which couldn't be locked during revert process.
getNotTranslatedAlternativePage() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the UID of a page reference for a page to be shown if no translation was given.
getNotTranslatedMediaStrategy() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the strategy to use when generating media that is not translated
getNotTranslatedPageStrategy() - Method in interface de.espirit.firstspirit.access.project.Project: Returns one of the following values: Project.STRATEGY_IGNORE_NOT_TRANSLATED Project.STRATEGY_REPLACE_NOT_TRANSLATED_WITH_MASTER_LANGUAGE Project.STRATEGY_REPLACE_NOT_TRANSLATED_WITH_BROKEN_LINK_PAGE Project.STRATEGY_REPLACE_NOT_TRANSLATED_WITH_SPECIAL_PAGE
getNumber() - Method in interface de.espirit.firstspirit.access.packagepool.PackageImportLogfile: Returns the import count nr of this log file.
getNumber() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersionLogfile: Returns the log count nr of this log file.
getNumberOfGeneratedPages() - Method in interface de.espirit.firstspirit.scheduling.aspects.Generating: Provides the number of pages generated by the task.
getObject() - Method in interface de.espirit.firstspirit.client.plugin.report.ReportContext: Returns the current object provided by DataProvider.
getObjectId() - Method in exception de.espirit.firstspirit.access.store.LockException: Returns the id of the locked object.
getOfficeEngineFileExtensions() - Method in interface de.espirit.firstspirit.access.project.InlinePreviewConstraints: Deprecated.
since 5.2.191201 - no replacement
getOffset() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams.ContentPageParams: Provides the offset.
getOldParentId() - Method in interface de.espirit.firstspirit.event.EventInfo: Provides the old parent id, if this is a EventInfo.EventType.ELEMENT_MOVED operation.
getOldUid() - Method in exception de.espirit.firstspirit.access.DuplicateReferenceNameException: The old uid which already exist on the server.
getOldUrl() - Method in class de.espirit.firstspirit.event.UrlEvent: Contains the old URL if available.
getOldValue() - Method in class de.espirit.firstspirit.client.access.editor.EditorValueChangedEvent: Provides the old value prior to the change.
getOperation() - Method in interface de.espirit.firstspirit.storage.RevisionMetaData: Returns the revision operation.
getOperation(OperationType<P>) - Method in interface de.espirit.firstspirit.agency.OperationAgent: Get a new operation object to parameterize and execute it.
getOperationAgent() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method to get the agent providing operations.
getOperationProgress() - Method in interface de.espirit.firstspirit.access.export.ImportProgress: Returns current import operation progress value between 0 and 1.0 or -1.
getOpposedAttribute() - Method in interface de.espirit.or.schema.ComposedAttribute: Return the opposed attribute defined in the target entity type.
getOption(String) - Method in interface de.espirit.firstspirit.access.editor.value.OptionModel: Get the option corresponding to the given value.
getOptionFactory() - Method in interface de.espirit.firstspirit.access.editor.OptionsEditorValue: Deprecated.

Get a factory to produce options.
getOptionFactory() - Method in interface de.espirit.firstspirit.access.editor.value.OptionFactoryProvider: Get an option factory.
getOptionModel(Language) - Method in interface de.espirit.firstspirit.access.editor.OptionsEditorValue: Deprecated.

Get the model on options for the given language.
getOptionModel(SpecialistsBroker, Language, boolean) - Method in interface de.espirit.firstspirit.access.editor.value.OptionFactory: Return a model on options, based upon information provided by the given specialists broker.
getOptionType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Convenience accessor providing the transfer type for FirstSpirit's Option based data.
getOrders() - Method in interface de.espirit.or.query.Select: Returns an unmodifiable list of defined orders of this select.
getOrientation() - Method in interface de.espirit.firstspirit.webedit.plugin.focus.FocusArea: Provides the orientation represented as an optional 2D vector, which is to be considered as the viewing angle and field of view for calculating the total size of a resolution.
getOriginalResolution() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the resolution definition for requesting images in their original dimensions.
getOriginalResolution() - Method in interface de.espirit.firstspirit.agency.ResolutionAgent: Get the resolution defining the original.
getOrSchema() - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: The database schema.
getOSFileSystem(String) - Method in interface de.espirit.firstspirit.io.FileSystemsAgent: Provides an OS-based file system instance having the given path as root.
getOut() - Method in interface de.espirit.firstspirit.access.template.Evaluator: Provides a writer to the output.
getOutgoingReferences() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns all outgoing references of this StoreElement.
getOutgoingReferences(Entity) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Returns current outgoing references of the given entity.
getOutgoingReferences(Entity, boolean) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schema: Returns current or release outgoing references of the given entity.
getOutput() - Method in interface de.espirit.firstspirit.scheduling.agency.GenerationAgent: Provides a collection containing information on the output of generation runs prior to the invocation.
getOutputLenthLimit() - Method in interface de.espirit.firstspirit.generate.functions.json.JsonSettings: Get the length limit of the generated JSON output.
getOutputStream() - Method in interface de.espirit.firstspirit.io.FileHandle: Returns an OutputStream to store content to the file.
getOutputStream(boolean) - Method in interface de.espirit.firstspirit.io.FileHandle: Provides an OutputStream to store content to the file.
getOwner() - Method in interface de.espirit.or.schema.Attribute: Return the entity type which defines this attribute.
getPackage() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Returns the package this subscription is belonging to
getPackage() - Method in interface de.espirit.firstspirit.access.store.PackagePoolItem: Returns the Package this item belongs to or null.
getPackageByName(String) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns the Package specified by the given name or null if no package exists with the given name.
getPackageId() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Returns the id of the Package which belongs to this logfile.
getPackageName() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the name of the package which had been imported.
getPackageName() - Method in interface de.espirit.firstspirit.access.packagepool.PackageLogfile: Returns the name of the Package which belongs to this logfile.
getPackageName() - Method in interface de.espirit.firstspirit.access.store.PackagePoolItem: Returns the name of the package this item belongs to.
getPackages() - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a read-only list of all Package's existing on the server.
getPackages(int) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a read-only list of all existing Package's of the given package type.
getPackages(Project) - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a read-only list of all existing Package's for which the given project is master project
getPackageType() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Returns the type of this package.
getPackageVersion() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Gets the version number of the last imported package version or -1 if nothing has been imported yet
getPage() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Returns a set page or null if referenced element is not type of Page.
getPage() - Method in interface de.espirit.firstspirit.access.GenerationContext: Return the current Page that is used in the generation context
getPage() - Method in interface de.espirit.firstspirit.access.store.sitestore.AltPageRef: Get the page from PageStore that is alternative page for an pagereference
getPage() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Get the page from Page-Store of the current pagereference as object
getPageContext() - Method in interface de.espirit.firstspirit.access.GenerationContext: Return the page context if set.
getPageCount() - Method in class de.espirit.firstspirit.access.store.MultiPageParams
getPageCount() - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the number of pages that will be generated.
getPageCount(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the number of pages which will be created by the projection specified with this parameters for the given language.
getPageGroup() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Get the page-group of the current pagereference as object
getPageGroupPosition() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Get the position-number of the current pagereference in the pagegroup
getPageGroups() - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreFolder: Get the list of the page-groups for the current PageReference
getPageId() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Returns the id of the referenced Page.
getPageIndex() - Method in interface de.espirit.firstspirit.access.GenerationContext: Provides the actual page index in case of multi-pages.
getPageLangSpec(Language) - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Get the pagereference specification for the given language
getPageParams() - Method in interface de.espirit.firstspirit.access.GenerationContext: Get the page params of the page which is generated.
getPageParams(int) - Method in class de.espirit.firstspirit.access.store.MultiPageParams
getPageParams(int) - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the parameters stored for the given index.
getPageParams(Map<String, ?>) - Method in class de.espirit.firstspirit.access.store.MultiPageParams: If the provided map contains the parameter "index" mapped to a number (or a string wich can be converted to a number) the PageParams for the corresponding index is returned.
getPageParams(Map<String, ?>) - Method in class de.espirit.firstspirit.access.store.sitestore.ContentMultiPageParams: Provides the parameters based on the given options.
getPageref() - Method in interface de.espirit.firstspirit.webedit.client.api.FSID: Returns the pageref id related to the specified content-id, or -1 if not specified.
getPageRef() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the referenced element as page ref, if applicable.
getPageRef() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Returns a set page reference or null if referenced element is not type of PageRef.
getPageRefId() - Method in interface de.espirit.firstspirit.access.schedule.GenerateTask.EntityEntry: The node id of the referenced PageRef.
getPageRefs() - Method in interface de.espirit.firstspirit.access.store.pagestore.Page: Get the Collection of PageRefs that are using this page.
getPageSuffix() - Method in class de.espirit.firstspirit.access.store.PageParams
getPageTemplates() - Method in interface de.espirit.firstspirit.access.store.templatestore.TemplateStoreRoot: Access to the sub root node for page templates.
getParallelExecutionMode() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: the ParallelExecutionMode of this entry.
getParameter() - Method in interface de.espirit.firstspirit.client.plugin.ReportPlugin: Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.
getParameter() - Method in interface de.espirit.firstspirit.webedit.plugin.WebeditReportPlugin: Deprecated.

Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within the user interface.
getParameter() - Method in class de.espirit.or.query.Compare: Returns the parameter of this compare or null.
getParameter(String) - Method in interface de.espirit.firstspirit.client.mpp.MPPWebControl: Returns the current value of the specified preview parameter.
getParameter(String) - Method in interface de.espirit.firstspirit.client.mpp.PreviewParameter: Returns the parameter value for the specified name.
getParameter(String) - Method in interface de.espirit.or.query.Select: Return the parameter with the given identifier.
getParameter(String) - Method in interface de.espirit.firstspirit.access.database.Layer: Returns the value of a specific parameter.
getParameter(String) - Method in interface de.espirit.firstspirit.module.Configuration: Returns a specific parameter or null if it's not available.
getParameter(String) - Method in interface de.espirit.firstspirit.opt.office.ProjectProperties
getParameter(String) - Method in interface de.espirit.firstspirit.webedit.client.api.Preview: Deprecated.
since 5.2, use MPPWebControl.getParameter(String) instead
getParameterNames() - Method in interface de.espirit.firstspirit.access.database.Layer: Returns a list of the layer parameter names.
getParameterNames() - Method in interface de.espirit.firstspirit.module.Configuration: Returns all parameter names.
getParameterNames() - Method in interface de.espirit.firstspirit.opt.office.ProjectProperties
getParameters() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns optional parameters for the Java Web Start connection, defined as "PARAMETER1=VALUE1; PARAMETER2=VALUE2"
getParameters() - Method in interface de.espirit.firstspirit.access.database.Layer: Returns a map of all layer parameters.
getParameters() - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask: A set of paramaters set for this ScriptTask
getParameters() - Method in interface de.espirit.firstspirit.generate.UrlFactoryContext: Returns the settings provided in module.xml file in section <configuration>..</configuration>.
getParameters() - Method in interface de.espirit.or.query.Select: Return all parameters defined by this select.
getParameterValue(String) - Method in interface de.espirit.or.query.Select: Returns the value of the parameter specified by given identifier or null if no parameterexists with the given identifier.
getParams() - Method in interface de.espirit.firstspirit.access.project.PresentationChannel: Provides a map of parameters defined for this channel.
getParams() - Method in exception de.espirit.firstspirit.store.access.mediastore.MediaConstraintsException: Return the given parameter map.
getParams() - Method in class de.espirit.or.ConnectionConfiguration: Get the parameter for the connection.
getParent() - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns the parent node or null if this node is a root node.
getParent() - Method in interface de.espirit.firstspirit.access.store.contentstore.Dataset: Returns parent Content2 which can be null if this dataset (or its entity) is only associated with a table template.
getParent() - Method in interface de.espirit.firstspirit.access.store.IDProvider: Return parent IDProvider which is null for deleted elements or store-roots.
getParent() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Return parent StoreElement which is null for deleted elements or store-roots.
getParent() - Method in interface de.espirit.firstspirit.io.FileHandle: Get a handle on the parent file.
getParent() - Method in interface de.espirit.firstspirit.service.permission.groups.Group: Returns the parent group of this group or nullif this group is the root group
getParent() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns parent object and null for root elements without parent.
getParent() - Method in interface de.espirit.firstspirit.storage.CreateOperation: Returns the parent node under which the created element has been created.
getParent() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportElementInfo: Provides an information container on this element's parent.
getParentContext() - Method in interface de.espirit.firstspirit.access.template.Context: Provides the parent context of this one.
getParentFolder() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRef: Returns the page refs parent folder.
getParentFolder() - Method in interface de.espirit.firstspirit.access.store.sitestore.SiteStoreFolder: Get the parent folder.
getParentId() - Method in interface de.espirit.firstspirit.event.EventInfo: Depending on the operation, provides the id of the parent element.
getParentPath() - Method in interface de.espirit.firstspirit.access.store.ElementInfo: Returns a list of ID's of the original parent path of the underlying deleted element starting with the ID of the root node descending to the direct parent node.
getParsedFile() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Returns the parsed file content, if Media.getParseFile() == true, else null.
getParseFile() - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: State if the media must be parsed during the generation (only Media.FILE)
getParts() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the amount of parts of this exportfile
getPassword() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The password, used for login
getPassword() - Method in interface de.espirit.firstspirit.access.schedule.ServletTarget: The password, used for login
getPassword() - Method in interface de.espirit.firstspirit.service.permission.groups.User: Returns the password of this user or null if not specified
getPassword() - Method in class de.espirit.or.ConnectionConfiguration: Get the password string.
getPath() - Method in interface de.espirit.firstspirit.access.schedule.DeltaGeneration.DeletedPageInfo: Path of generated page, relative to content root.
getPath() - Method in interface de.espirit.firstspirit.access.schedule.DeployTarget: Get the target path.
getPath() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext: For generation this will return a path to
$CMS_SERVER_ROOT$/www/project_$PROJECT_ID$/$SCHEDULE_ENTRY_ID$/
for all other schedule entries
$CMS_SERVER_ROOT$/schedule/$SCHEDULE_ENTRY_ID$/
getPath() - Method in interface de.espirit.firstspirit.access.schedule.WebServerConfiguration: Deprecated.
since 5.0 - no replacement
getPath() - Method in interface de.espirit.firstspirit.agency.UrlAgent.UrlEntry: Returns the url path for this url entry.
getPath() - Method in interface de.espirit.firstspirit.io.FileHandle: The path of the file (including file name if FileHandle.getType() delivers FileType.FILE).
Path elements are seperated with slashes "/".
getPath() - Method in interface de.espirit.firstspirit.scheduling.agency.FileEntry: Provides the complete path sequence (including the file's name) relative to the root of the generation.
getPath() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns path to root or null for root nodes.
getPath(R, I) - Method in interface de.espirit.firstspirit.service.treedata.TNodeProvider: Returns path to root or null for root nodes.
getPathLengthToFollow() - Method in interface de.espirit.firstspirit.agency.SearchIndexAgent: Returns the currently set path length to follow on indexing relationships.
getPathLookup() - Method in interface de.espirit.firstspirit.generate.UrlFactoryContext: Returns the path lookup for user defined paths.
getPattern() - Static method in class de.espirit.firstspirit.common.text.Classname: Get the pattern for a classname.
getPattern() - Static method in class de.espirit.firstspirit.common.text.Designator: Get the pattern for a designator.
getPermission() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns the permission object for the current user even if permission checking is turned off.
getPermission(Group) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns the correct permission object even if permission checking is turned off.
getPermission(User) - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns the correct permission object even if permission checking is turned off.
getPermissions() - Method in class de.espirit.firstspirit.access.search.Request: Provides the map of defined permissions which have to be matched.
getPermissionVariable() - Method in interface de.espirit.firstspirit.access.project.Project: Get Metadata variable permissions
getPersistence(Option) - Method in interface de.espirit.firstspirit.access.editor.value.OptionFactory: Returns the persistence key for given option.
getPersistencyLanguage() - Method in interface de.espirit.firstspirit.module.GadgetContext: The persistency language of the gadget's value.
getPersistencyLanguage() - Method in class de.espirit.firstspirit.ui.gadgets.swing.AbstractValueHoldingSwingGadget: Convenience method to get the language to be used for accessing values.
getPhoneNumber() - Method in interface de.espirit.firstspirit.access.User: Gets the phone number.
getPicture() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the picture of the binary medium.
getPicture(Language) - Method in interface de.espirit.firstspirit.access.store.mediastore.Media: Get the given media as a Picture object in the language provided.
getPictureEditorName() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Provides the name of the picture editor component, used for storing a graphical description.
getPictureMetaData(Resolution) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Return media metadata for explicitly set and automatically generated picture resolutions.
getPictureResolution(Resolution) - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Get the picture-resolution child StoreElement of this picture-media for the given resolution.
getPictureRevision() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get revision for picture data.
getPlaceholder() - Method in interface de.espirit.firstspirit.client.plugin.report.ParameterText: Returns the placeholder for the related textfield on client side.
getPlaceholder() - Method in class de.espirit.firstspirit.webedit.plugin.report.ParameterText: Deprecated.

Returns the placeholder for the related textfield on client side.
getPlainTextType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Convenience accessor providing the transfer type representing an plain text access.
getPlainUrl() - Method in class de.espirit.or.ConnectionConfiguration: Get the plain url
getPluggabilityFeaturesConfiguration() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Retrieves the configuration of pluggability features for web applications.
getPoints() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.PolyArea: The chain of points defining the polygon.
getPolygonBuilder() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.ImageMapAgent: Provides a builder for polygonal areas.
getPoolCheckInterval() - Method in class de.espirit.or.ConnectionConfiguration: Get the interval in which the connection pool will be checked.
getPoolMax() - Method in class de.espirit.or.ConnectionConfiguration: Get the maximum number of pool connections.
getPoolMin() - Method in class de.espirit.or.ConnectionConfiguration: Get the minimum number of pool connections.
getPoolTimeout() - Method in class de.espirit.or.ConnectionConfiguration: Get the timeout for a pool connection.
getPort() - Method in interface de.espirit.firstspirit.access.admin.WebstartConfiguration: Returns the port number to use.
getPort() - Method in interface de.espirit.firstspirit.access.Connection: Get server port
getPort() - Method in class de.espirit.firstspirit.access.ConnectionManager.SocketParam: Provides the port of the socket.
getPort() - Method in class de.espirit.or.ConnectionConfiguration: Return the port number.
getPosition() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageRefFolder: Returns the position of this pagereffolder in menu order of the parent folder.
getPosition() - Method in interface de.espirit.firstspirit.workflow.model.Transition: Provides the position of a Transition
getPre() - Method in interface de.espirit.firstspirit.access.editor.value.ListDomNode: Returns the string that is used as bullet if style style is set to USER_DEFINED.
getPrefix() - Method in enum class de.espirit.firstspirit.access.editor.value.BinaryMedium.Type: Gets the prefix.
getPrefix() - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration: Returns the prefix defined in this remote project configuration.
getPrefixTemplate() - Method in interface de.espirit.firstspirit.access.store.sitestore.DocumentGroup: Get the template which is used to render the prefix, e.g. a table of contents
getPresentationChannel() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Gets the PresentationChannel of this TemplateSet
getPresentationChannelName() - Method in interface de.espirit.firstspirit.access.project.TemplateSet: Gets the name of the presentation channel of the template set
getPreset() - Method in class de.espirit.firstspirit.access.store.templatestore.gom.AbstractGomFormElement: Provides the mode for handling preset value for this form element.
getPreset() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomFormElement: Get the mode to be applied for fallback values.
getPressedIcon(ToolbarContext) - Method in interface de.espirit.firstspirit.client.plugin.toolbar.JavaClientToolbarItem: Returns the icon in pressed state for this item or null if this item has no pressed icon.
If this method delivers null the normal icon will be used.
getPreview() - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Deprecated.
since 5.0 - use Picture.getPreviewImage()
getPreviewElement() - Method in interface de.espirit.firstspirit.webedit.client.api.Common: Returns current visible element.
getPreviewElement() - Method in interface de.espirit.firstspirit.webedit.WebeditUiAgent: Provides the currently shown element.
getPreviewImage() - Method in interface de.espirit.firstspirit.access.store.mediastore.File: Get a small preview/thumbnail image of this picture
getPreviewImage() - Method in interface de.espirit.firstspirit.access.store.mediastore.Picture: Get a small preview/thumbnail image of this picture.
getPreviewImage() - Method in interface de.espirit.firstspirit.access.store.templatestore.PreviewImageProvider: Return preview image as byte array or null if no preview image is set.
getPreviewLanguage() - Method in interface de.espirit.firstspirit.webedit.WebeditUiAgent: Provides the language the preview element is shown in.
getPreviewPageRef() - Method in interface de.espirit.firstspirit.access.store.templatestore.MasterTemplate: Returns the pageref used to calculate previews of nodes without sitestore context (e.g.
getPreviewSuffix() - Method in class de.espirit.firstspirit.access.store.PageParams
getPreviewUrl(Language, TemplateSet, boolean, int, Map<?, ?>) - Method in interface de.espirit.firstspirit.access.store.Previewable: Deprecated.
since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrl(ContentProducer)
getPreviewUrlObject(Language, TemplateSet, boolean, int, Map<?, ?>) - Method in interface de.espirit.firstspirit.access.store.Previewable: Deprecated.
since 5.2.190105, please use PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrlObject(ContentProducer)
getPreviousSibling() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Provides the previous store element.
getPriority() - Method in interface de.espirit.firstspirit.access.editor.value.Permissions: Provides the priority setting for this permissions.
getPriority() - Method in interface de.espirit.firstspirit.access.Task: Get task priority
getPriority() - Method in interface de.espirit.firstspirit.access.TransitionParameters: Get task priority.
getProblematicElements() - Method in interface de.espirit.firstspirit.access.store.ReleaseProgress: Deprecated.
since 5.2.180606, use ReleaseOperation instead
getProblematicElements() - Method in interface de.espirit.firstspirit.access.store.RestoreProgress: Returns a map containing all elements which would cause problem during restore process.
getProblematicElements() - Method in interface de.espirit.firstspirit.access.store.RevertProgress: Returns a map containing all elements which would cause problem during revert process.
getProblematicElements() - Method in interface de.espirit.firstspirit.store.operations.ReleaseOperation.ReleaseResult: Returns all problematic elements.
getProblems() - Method in interface de.espirit.firstspirit.store.access.nexport.operations.ImportOperation.Result: Provide a list of problems which occurred during import.
getProblems(Language) - Method in interface de.espirit.firstspirit.agency.MultiFormValidationReport: Gives a report for the specified language.
getProblemsForMetaData() - Method in interface de.espirit.firstspirit.agency.MultiFormValidationReport: Gives a report for the meta data.
getProducer() - Method in interface de.espirit.firstspirit.forms.FormDataList: Provides a producer able to create form-data based on the data-source definition for this editor.
getProgress() - Method in interface de.espirit.firstspirit.access.ActionProgress: Returns current action progress value between 0 and 100 or -1.
getProgress(boolean) - Method in interface de.espirit.firstspirit.access.ServerActionHandle: Returns the current action progress of the related server action since the last progress poll.
The recommended delay between polls is 1 to 2 seconds.
getProject() - Method in interface de.espirit.firstspirit.access.admin.Quickstart: Returns the project this quickstart configuration is related to.
getProject() - Method in interface de.espirit.firstspirit.access.Host: Shortcut for Host.getUserService().getProject() and returns null if no project is selected.
getProject() - Method in interface de.espirit.firstspirit.access.project.ProjectScriptContext: Return the Project of the current script context
getProject() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleContext: Returns the project the currently running schedule entry belongs to.
getProject() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: Returns the project for project specific tasks or null if it is a non project related entry
getProject() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTaskTemplate: Returns the Project or null if the schedule task template is server scoped.
getProject() - Method in interface de.espirit.firstspirit.access.store.Store
getProject() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns the belonging project of this storeelement.
getProject() - Method in interface de.espirit.firstspirit.access.Task: Get project
getProject() - Method in interface de.espirit.firstspirit.access.UserService: Returns the project this userservice belongs to.
getProject() - Method in interface de.espirit.firstspirit.agency.ProjectWebAppId: Returns the project-id.
getProject() - Method in interface de.espirit.firstspirit.module.ProjectEnvironment: Returns project.
getProject(long) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns the project by id, regardless whether it's active or not.
getProject(String) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns the project by name, regardless whether it's active or not.
getProjectAppConfig(String, String, long) - Method in interface de.espirit.firstspirit.agency.LegacyModuleAgent: Deprecated.
since 5.1.43 use ModuleAdminAgent.getProjectAppConfig(String, String, de.espirit.firstspirit.access.project.Project)
getProjectAppConfig(String, String, Project) - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Returns an access to the project-app configuration directory; read-write-access if the user is project admin, read-only-access if the user is project user, otherwise a SecurityException will be thrown.
getProjectAppConfigProperties(String, String, String, long) - Method in interface de.espirit.firstspirit.agency.LegacyModuleAgent: Helper method to obtain properties from the project app configuration specified by given modulename, projectAppName and project id.
getProjectAppUsages(String, String) - Method in interface de.espirit.firstspirit.agency.ModuleAdminAgent: Returns ids of all projects using the specified project application.
getProjectById(long) - Method in interface de.espirit.firstspirit.access.Connection: Return a project with a specific id or null if no project exists with the given id or the project is not visible for the current user.
getProjectByName(String) - Method in interface de.espirit.firstspirit.access.Connection: Return a project with a specific name or null if no project exists with the specified name.
getProjectCategory() - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration: Returns the name of the project category (exclusive the prefix "category:") related to this configuration.
getProjectConfigFileName() - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService
getProjectDescription() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Gets the description of the new project which will be created during the project import.
getProjectId() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get project id.
getProjectId() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Returns the project id this ExportParameters belongs to.
getProjectId() - Method in interface de.espirit.firstspirit.access.export.ImportProgress: Return the project id of the currently imported project. -1 if not known.
getProjectId() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Provides the project id of the referenced element.
getProjectId() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The project id.
getProjectId() - Method in class de.espirit.firstspirit.event.UrlEvent: The id of the Project in which the changed node is stored.
getProjectId() - Method in interface de.espirit.firstspirit.module.ProjectEnvironment: Returns project id
getProjectId() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ProjectReference: Get the id of the reference's project.
getProjectID() - Method in interface de.espirit.firstspirit.access.project.Group: Provides the project ID this group is defined for.
getProjectIds() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: All projects affected by the maintenance task.
getProjectInfo() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Returns the belonging project info.
getProjectInfo(ExportFile) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Parse info out of ExportFile contents
getProjectLanguages(boolean) - Method in interface de.espirit.firstspirit.agency.LanguageAgent: Provide access to available persistency languages, mapping abbreviations to the respective language definition.
getProjectLogo() - Method in interface de.espirit.firstspirit.access.project.Project: Return the project logo
getProjectName() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get project name, used for backup filename.
getProjectName() - Method in interface de.espirit.firstspirit.access.export.ExportFile: Returns the project name of the export file.
getProjectName() - Method in class de.espirit.firstspirit.access.export.ExportParameters: Returns the name of the project this ExportParameters belongs to.
getProjectName() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Gets the name of the new project which will be created during the project import.
getProjectName() - Method in class de.espirit.firstspirit.access.project.RemoteProjectConfiguration: Returns the name of the project related to this configuration.
getProjectName() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: The name of the source project the feature transport file was created in.
getProjectProperties() - Method in interface de.espirit.firstspirit.access.store.globalstore.GlobalStoreRoot: Returns the project property page.
getProjectProperties() - Method in interface de.espirit.firstspirit.opt.office.ProjectProperties
getProjectProperties(long) - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService
getProjects() - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns all (active and inactive) projects.
getProjects() - Method in interface de.espirit.firstspirit.access.Connection: Get all active projects allowed for the current user.
Checks if the current user is server admin and is allowed to edit a project using java client or webedit.
Use ProjectStorage.getProjects(boolean) to get projects unfiltered.
getProjects(boolean) - Method in interface de.espirit.firstspirit.access.admin.ProjectStorage: Returns either all active or inactive projects.
getProjectStorage() - Method in interface de.espirit.firstspirit.access.AdminService: Returns the server's ProjectStorage.
getProjectWebAppUrl(WebEnvironment.WebScope, long, boolean) - Method in interface de.espirit.firstspirit.agency.LegacyModuleAgent: Returns the absolute url to the specified project-local web-app (with or w/o a FS SSO ticket).
getProperties() - Method in interface de.espirit.firstspirit.access.schedule.ScriptTask: Provides the defined properties.
getProperties() - Method in interface de.espirit.firstspirit.access.ScriptContext: Returns an array of property names existing in this context.
getProperty(String) - Method in interface de.espirit.firstspirit.access.project.Project: Returns project property with the given name or null if not found.
getProperty(String) - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns a user defined property; null for unknown properties.
getProperty(String) - Method in interface de.espirit.firstspirit.access.ScriptContext: Returns the property specified by the given name or null if no property exists with the given name
getProperty(String) - Method in interface de.espirit.firstspirit.storage.Tag: Returns value for a property.
getProperty(String) - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.PropertyProcessing: Get the value for the property having the given name.
getProperty(String) - Method in interface de.espirit.firstspirit.webedit.client.api.ClientItemContext: Returns the value of the given property, or null if there is no such property.
Example for the request of a contextual property:
getProperty(String) - Method in interface de.espirit.firstspirit.workflow.model.WorkflowElement: Returns an property form this workflow-element.
getProperty(String) - Method in interface de.espirit.or.Layer: Provides the property value stored with the given name.
getProperty(T, String) - Method in interface de.espirit.firstspirit.client.access.editor.PropertyProviding: Provide a value for the property having the given name.
getPropertyNames() - Method in interface de.espirit.firstspirit.service.treedata.TNode: Returns all property names.
getPropertyNames() - Method in interface de.espirit.firstspirit.storage.Tag: Returns list of all property names.
getPropertyType() - Method in interface de.espirit.firstspirit.store.access.nexport.PropertyTypeExportInfo: Retrieves the PropertiesTransportOptions.ProjectPropertyType of this element or null for fs meta files in global directory
getProvider() - Method in interface de.espirit.firstspirit.access.store.templatestore.gom.GomCheckable.Context: Gets the form defining editor provider.
getProvider() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodesEditorValue: Deprecated.

Returns internal node provider.
getProvider(String) - Method in interface de.espirit.firstspirit.service.treedata.TNodeService: Returns a provider proxy.
getProviderClass(String) - Method in interface de.espirit.firstspirit.service.treedata.TNodeService: Returns the provider class name for the specified provider
getProviderNames() - Method in interface de.espirit.firstspirit.service.treedata.TNodeService: Returns all provider names.
getProviderProperties(String) - Method in interface de.espirit.firstspirit.service.treedata.TNodeService: Returns properties of the specified provider.
getProviderRequest() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodesEditorValue: Deprecated.

Returns provider request object, necessary to perform provider calls.
getProxy() - Static method in class de.espirit.firstspirit.access.ConnectionManager: Get the proxy used for new connections.
getProxy() - Method in class de.espirit.firstspirit.access.ConnectionManager.SocketParam: Provides information on a proxy to used.
getProxyClass() - Method in interface de.espirit.firstspirit.module.Service: A service proxy is an optional, client-side service implementation.
getProxyHost() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The host for ftp proxy.
getProxyLogin() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The login used for ftp proxy.
getProxyPassword() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The password used for ftp proxy login.
getProxyPort() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The port for ftp proxy.
getProxyType() - Method in interface de.espirit.firstspirit.access.schedule.FtpTarget: The protocol used for ftp proxy.
getPublisher() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Gets the Project that is the package's owner.
getPublishGroup() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Gets the publish group of this subscription.
getPublishGroups() - Method in interface de.espirit.firstspirit.access.packagepool.PackageManager: Returns a read-only list of PublishGroup's which are defined on this server.
getPublishGroups() - Method in interface de.espirit.firstspirit.access.packagepool.PackageVersion: Returns a read-only Set of PublishGroup's this PackageVersion is published for.
getPublishUsers() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Gets an unmodifiable list of User's which have the permission 'publish' for this package.
getQuality() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the quality state of the belonging FirstSpirit version.
getQuery() - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the query used for fetching records.
getQuerySegmentType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Accessor providing he transfer type for FirstSpirit's query expressions.
getQueryString() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: Returns an optional query string to be appended to the preview url.
getQueuedEntries() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns the list schedule entries that would be executed in the future.
getQuickstart() - Method in interface de.espirit.firstspirit.access.ServerConfiguration: Returns the list of quickstart items configured.
getQuotaHDD() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the harddisk quota for this project.
getQuotaMail() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the e-mail address to inform about quota issues.
getQuotaPages() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the quota for pages allowed in this project.
getQuote() - Method in interface de.espirit.firstspirit.access.store.templatestore.Style: Indicates whether to quote the style.
getRadius() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.CircleArea: Provide the radious of the circle.
getRange() - Method in interface de.espirit.firstspirit.client.plugin.timeline.TimelineEntryProvider: Returns the time range that should be displayed in the timeline.
getRawValueToStringType() - Method in interface de.espirit.firstspirit.agency.TransferAgent: Provides the value to string transfer type for a ValueHolder (SwingGadget).
getRawValueType(Class<T>) - Method in interface de.espirit.firstspirit.agency.TransferAgent: Provides the value transfer type for a ValueHolder (SwingGadget) where <T> is the typed transfer value.
getReadOnlyLayers() - Method in interface de.espirit.firstspirit.access.project.Project: Provides the names of read only layers.
getRealname() - Method in interface de.espirit.firstspirit.access.User: The realname of the user.
getRealname() - Method in interface de.espirit.firstspirit.service.permission.groups.User: Returns the realname of this user or null if not specified
getRecipients() - Method in class de.espirit.firstspirit.access.MailHeader: A semicolon-separated list of recipients.
getRecordCountPerPage() - Method in interface de.espirit.firstspirit.access.store.sitestore.Content2Params: Provides the maximum number of records which is rendered on a each page, 0 is used when all records are rendered on one page.
getRectangleBuilder() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.ImageMapAgent: Provides a builder for rectangular areas.
getRecursive() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation: Returns true if the recursive parameter was set during execution of the belonging server release action
getRedirectTemplate() - Method in interface de.espirit.firstspirit.access.project.Project: Returns the template used to generate external orrelated project linksof page reference nodes.
If the redirect template is null a default redirect html is used:
getReference() - Method in interface de.espirit.firstspirit.access.store.pagestore.SectionReference: Return the referenced source Section.
getReference() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ExternalReference: Get the external reference.
getReference() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.ProjectReference: Get the foreign reference.
getReference() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.RemoteReference: Get the foreign reference.
getReferenceCategory() - Method in interface de.espirit.firstspirit.access.store.templatestore.LinkTemplate: Default value is "url".
getReferencedElement() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: The referenced node.
getReferencedElements() - Method in interface de.espirit.firstspirit.access.store.DeleteProgress: Deprecated.

Returns a set of ID's of all elements which couldn't be deleted cause of existing incoming references.
getReferencedElements() - Method in interface de.espirit.firstspirit.store.operations.DeleteOperation.Result: Returns a Collection of all elements which couldn't be deleted because of existing incoming references.
getReferencedObject() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns the referenced object.
getReferencedObject() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Provides the referenced node.
getReferencedStoreType() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns the store type.
getReferenceEntry() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Deprecated.
since 4.2.24 - no replacement
getReferenceEntry(UserService, boolean) - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns reference entry.
getReferenceName() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the name of the reference.
getReferenceName() - Method in interface de.espirit.firstspirit.access.store.Referenceable: Get the element's name with the appropriate prefix.
getReferenceName() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Provided the element's reference name.
getReferences() - Method in interface de.espirit.firstspirit.access.store.Data: Deprecated.
since 5.2.21 - see type
getReferences() - Method in interface de.espirit.firstspirit.access.store.StoreElement: Returns current outgoing references of this store element.
getReferences(boolean) - Method in interface de.espirit.firstspirit.access.editor.value.DomNode: Returns all references, including reference to node's FormatTemplate.
getReferenceString() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns the reference string.
getReferenceString() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Provides a textual reference representation, e.g.
getRefKey() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Provides a reference key of this template.
getRelativeFileSystem(FileHandle) - Method in interface de.espirit.firstspirit.io.FileSystemsAgent: Provides a file system instance having the given root, which must represent a directory.
getRelease() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Indicates the node coming from the release store.
getReleasedBy() - Method in interface de.espirit.firstspirit.access.store.IDProvider: The last user who released this node or null if this node has never been released.
getReleasedDeleted(String) - Method in interface de.espirit.or.Session: Get the key values of all entities of the given entity type which are deleted but still released.
getReleasedElements() - Method in interface de.espirit.firstspirit.access.store.ReleaseProgress: Deprecated.
since 5.2.180606, use ReleaseOperation instead
getReleasedElements() - Method in interface de.espirit.firstspirit.store.operations.ReleaseOperation.ReleaseResult: Returns all successfully released elements
getReleasedEntities() - Method in interface de.espirit.firstspirit.storage.ContentOperation: Returns an unmodifiable collection of entity infos indicating entities which were released during the belonging content commit of this content operation
getReleaseFailedElements() - Method in interface de.espirit.firstspirit.store.operations.ReleaseOperation.ReleaseResult: Returns all elements passed over to ReleaseOperation.perform(IDProvider...) where release failed.
getReleaseMode() - Method in interface de.espirit.firstspirit.access.packagepool.Subscription: Gets the release mode of this subscription.
Subscription.RELEASE_MODE_AUTO (default) : all nodes which were updated or created during the import of this subscription will be released automatically.
Subscription.RELEASE_MODE_WORKFLOW : after the import of this subscription the defined release workflow (Subscription.setWorkflow(byte, Workflow)) will be started.
getReleaseName() - Method in interface de.espirit.firstspirit.agency.ServerInformationAgent.VersionInfo: Returns the release name of the belonging FirstSpirit version.
e.g.
getReleaseParentPath() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation: Returns true if the release parent path parameter was set during execution of the belonging server release action.
getReleaseRevision() - Method in interface de.espirit.firstspirit.access.store.IDProvider
getReleaseRootElement() - Method in interface de.espirit.firstspirit.storage.ReleaseOperation: Returns the root element of the release operation.
Example:
getReleaseStartElement() - Method in interface de.espirit.firstspirit.storage.ServerReleaseOperation: Returns the start element of the server release action.
getReleaseState(IDProvider) - Method in interface de.espirit.firstspirit.workflow.WebeditElementStatusProviderPlugin: Returns the release state of the given element, consider depending objects like it's page or references media.
getReleaseStatus() - Method in interface de.espirit.firstspirit.access.store.IDProvider: Returns the release state of this storeelement (IDProvider.CHANGED or IDProvider.RELEASED or IDProvider.NEVER_RELEASED)
getReleaseTo() - Method in interface de.espirit.or.EntityInfo: Provides the date in millisceconds this entity is released to.
getRemote() - Method in interface de.espirit.firstspirit.access.editor.value.ElementReference: Provides the symbolic remote project name, if this is a remote reference.
getRemote() - Method in interface de.espirit.firstspirit.access.ReferenceEntry: Returns symbolic name of remote configuration.
getRemote() - Method in interface de.espirit.firstspirit.client.access.editor.IDProviderReferenceHolder: Symbolic project name, if the referenced element originates from a remote project.
getRemoteConnection(RemoteProjectConfiguration) - Method in interface de.espirit.firstspirit.access.Connection: Returns the remote connection specified by the given RemoteProjectConfiguration.
getRemoteName() - Method in interface de.espirit.firstspirit.access.editor.reference.Reference: Returns the symbolic name of the remote project configuration.
getRemoteName() - Method in interface de.espirit.firstspirit.access.editor.value.BinaryMedium: Returns the remote name.
getRemoteName() - Method in interface de.espirit.firstspirit.storage.ReferencesChangeDetail.RemoteReference: Get the configuration name of the remote project.
getRemoteName() - Method in interface de.espirit.firstspirit.webedit.plugin.media.MediaManagementContext: Get the name of the contextual remote project configuration, or null for the local project.
getRemoteProjectConfiguration() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec: Return RemoteProjectConfiguration used for related project.
getRemoteProjectConfiguration(String) - Method in interface de.espirit.firstspirit.access.project.Project: Gets the remote project configuration for the specified symbolic name or null if not configuration with this name exists for this project.
getRemoteProjectConfigurations() - Method in interface de.espirit.firstspirit.access.project.Project: Return the list of existing remote project configurations for this project.
getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration>) - Method in interface de.espirit.firstspirit.access.project.Project: Returns the list of remote project configurations for this project that pass the given filter.
getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration>) - Method in interface de.espirit.firstspirit.agency.ProjectAgent: Get the configurations of remote projects defined.
getRemoteProjectName() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.operations.SelectStoreElementOperation.Selection: The symbolic name of the remote project the element belongs to.
getRemoteSymName() - Method in interface de.espirit.firstspirit.access.editor.value.TargetReference: Return the symbolic remote project name set in the local remote project configuration.
getRemoteTaskType() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns the type of remote task - if the task is executed remote a valid cluster node is choosen according to this type.
Default is RemoteTaskType.NONE - these indicates that the task cannot be executed on a cluster node.
getRemoteUserService(String) - Method in interface de.espirit.firstspirit.access.UserService: Connects the project defined in specified RemoteProjectConfiguration and returns it's UserService.
getRemovedElements() - Method in interface de.espirit.firstspirit.storage.ChildrenChangeDetail: Returns an unmodifiable list of elements which were removed during the change of the belonging children list.
getRemoveDeletedElements() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not deleted elements are to be archived.
getRemovedNode(int) - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the removed node at the specified index.
Call ImportInfo.setUserService(de.espirit.firstspirit.access.UserService) with your local userservice before calling this method.
getRemovedNodeCount() - Method in interface de.espirit.firstspirit.access.packagepool.ImportInfo: Returns the count of nodes which were removed during belonging package import.
getRemoveInternalFiles() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not system data is to be archived.
getRemoveOldElements() - Method in interface de.espirit.firstspirit.access.schedule.ProjectCleanupTask: Returns whether or not no longer required version history is to be archived.
getRenderExternalLinks() - Method in interface de.espirit.firstspirit.access.project.Project: Indicates whether pages withexternal linksshould generate redirect html (see Project.getRedirectTemplate()).
If false (default) a redirect meta html will be rendered forpages which point to an external target.If true a page will be generated likenormal content pages.
getReorderedElements() - Method in interface de.espirit.firstspirit.storage.ChildrenChangeDetail: Returns an unmodifiable map of elements which were reordered during the change of the belonging children list.
The value of the map is a pair of (key=oldPosistionIndex, value=newPositionIndex)
getReplyTo() - Method in class de.espirit.firstspirit.access.MailHeader: A semicolon-separated list of reply addresses.
getReport(ValidationAgent.ValidationScope) - Method in interface de.espirit.firstspirit.agency.ElementValidationReport: Get the report for a given scope.
getReportIcon(boolean) - Method in interface de.espirit.firstspirit.client.plugin.dataaccess.aspects.Reporting: Returns an image to be shown as icon for the report functionality.
getResolution() - Method in interface de.espirit.firstspirit.access.editor.value.MappingMedium: Provides the medium's resolution.
getResolution() - Method in interface de.espirit.firstspirit.access.store.mediastore.PictureResolution: Get the resolution as an object of the current picture resolution.
getResolution() - Method in interface de.espirit.firstspirit.agency.UrlAgent.MediaUrlEntry: Returns the resolution for which this media url entry is specified for.
getResolution() - Method in interface de.espirit.firstspirit.ui.gadgets.aspects.operations.SelectStoreElementOperation.Selection: The resolution chosen for a picture element, if applicable.
getResolutionByName(String) - Method in interface de.espirit.firstspirit.access.project.Project: Returns the resolution with the given name or null if no resolution exists in this project with the specified name.
getResolutionByName(String) - Method in interface de.espirit.firstspirit.agency.ResolutionAgent: Get the resolution having the given symbolic name.
getResolutions() - Method in interface de.espirit.firstspirit.access.project.Project: Get all resolutions of this project.
getResolutions() - Method in interface de.espirit.firstspirit.agency.ResolutionAgent: Get an unmodifiable list of available resolutions.
getResolutionsByTag(String...) - Method in interface de.espirit.firstspirit.agency.ResolutionAgent: Get an unmodifiable list of available resolutions tagged with one of the given tags.
getResolutionUid() - Method in class de.espirit.firstspirit.event.UrlEvent: The uid of the Resolution.
getResource() - Method in interface de.espirit.firstspirit.client.access.editor.ExternalReferenceHolder: The external resource of this reference.
getResourceBundle() - Method in interface de.espirit.firstspirit.access.Host: Return the ResourceBundle for the host.
getResources() - Method in interface de.espirit.firstspirit.module.descriptor.ComponentDescriptor: Returns resources (jar-files) neccessary for this component.
getResponsibleGroups() - Method in interface de.espirit.firstspirit.workflow.model.State: Returns the groups (names) who are responsible for this state.
getResponsibleUser() - Method in interface de.espirit.firstspirit.workflow.model.State: Returns the user (login names) who are responsible for this state.
getResponsibleUsers() - Method in interface de.espirit.firstspirit.access.packagepool.Package: Gets an unmodifiable list of responsible User's of this package.
getRestoredElements() - Method in interface de.espirit.firstspirit.access.store.RestoreProgress: Returns a set of ids of all elements which were restored during restore process.
getRestoreProjectId() - Method in class de.espirit.firstspirit.access.export.ImportParameters: Restore project mode.
getResult() - Method in interface de.espirit.firstspirit.access.ServerActionHandle: Calls getResult(false)
getResult() - Method in interface de.espirit.firstspirit.agency.RenderingAgent.Renderer: Trigger the rendering of the node and delivers the rendering result.
getResult() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleTaskDialog: Returns true if ok button was clicked or false if cancel button was clicked.
getResult() - Method in interface de.espirit.firstspirit.server.scheduler.ScheduleWizard: Display wizard dialog and create one or more schedule entries.
getResult(boolean) - Method in interface de.espirit.firstspirit.access.ServerActionHandle: Blocks until the execution of the related server action has been finished.
getResult(Writer, Writer) - Method in interface de.espirit.firstspirit.agency.RenderingAgent.Renderer: Trigger the rendering of the node and delivers the rendering result.
getResultTableName() - Method in interface de.espirit.firstspirit.access.store.templatestore.Query: Provides the name of the result table.
getRevertedElements() - Method in interface de.espirit.firstspirit.access.store.RevertProgress: Returns a set of ids of all elements which were reverted during revert process.
getRevision() - Method in interface de.espirit.firstspirit.access.store.ElementInfo
getRevision() - Method in interface de.espirit.firstspirit.access.store.IDProvider
getRevision() - Method in class de.espirit.firstspirit.access.store.mediastore.MediaMetaData: Get the Revision the media is currently in.
getRevision() - Method in interface de.espirit.firstspirit.access.UserService: Get the revision of this userservice.
getRevision() - Method in interface de.espirit.firstspirit.client.plugin.timeline.TimelineEntry: Returns the associated revision of this timeline entry.
getRevision() - Method in interface de.espirit.firstspirit.event.EventInfo: Get the Revision of this event.
getRevision() - Method in interface de.espirit.firstspirit.event.RevisionEvent: Get the Revision of this event.
getRevision() - Method in interface de.espirit.firstspirit.feature.FeatureDescriptor: Returns the revision of the feature this descriptor belongs.
getRevision() - Method in interface de.espirit.firstspirit.storage.Tag: Returns the tagged revision.
getRevision(long) - Method in interface de.espirit.firstspirit.access.project.Project: Returns the revision with the specified revision id.
getRevision(Date) - Method in interface de.espirit.firstspirit.access.project.Project: Returns the latest revision with a creation timeless or equal to the time of the given revisionDate
getRevisionCommentMode(Store.Type) - Method in interface de.espirit.firstspirit.access.project.Project: Should revision comments be ented for a specific store.
getRevisionDate() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get date of the revison to backup.
getRevisionId() - Method in class de.espirit.firstspirit.access.export.BackupParameters: Get revision id to backup, -1 means latest revision.
getRevisionId() - Method in interface de.espirit.firstspirit.access.store.BasicElementInfo: Returns the revision id of the belonging store element.
getRevisionId() - Method in interface de.espirit.firstspirit.access.store.DeletedElementsInfo
getRevisionId() - Method in interface de.espirit.firstspirit.base.store.PreviewUrl: The revision id.
getRevisions(Revision, Revision, int, Filter<Revision>) - Method in interface de.espirit.firstspirit.access.project.Project: Returns a list of revisions in descending order.
getRevisionTime() - Method in interface de.espirit.firstspirit.feature.FeatureAnalyseResult: The time of the revision the feature transport file belongs to.
getRGB() - Method in enum class de.espirit.firstspirit.webedit.WebeditColor: Returns the RGB value representing the color in the sRGB color model.
getRightBottom() - Method in interface de.espirit.firstspirit.access.editor.value.imagemap.RectArea: Provides the right bottom coordinate.
getRollOverIcon(ToolbarContext) - Method in interface de.espirit.firstspirit.client.plugin.toolbar.JavaClientToolbarItem: Returns an optional roll-over-icon of this item or null if the normal icon should be used.
The recommended dimensions for this icon are: Within 25x25 px for java client toolbar button 19x19 in toolbar sub items Ensure to deliver icons of the same dimension in all methods delivering icons (icon, pressed, roll over) The hover background will be rendered from FirstSpirit.
getRoot() - Method in interface de.espirit.firstspirit.access.editor.value.DomElement: Returns root node ( <DOM> ).
getRoot() - Method in interface de.espirit.firstspirit.service.permission.scripting.PermissionServiceScriptContext: Returns the group root model representing the belonging groups.xml file specified by the param "DOCUMENT_NAME.path" in service.ini.
getRoot() - Method in interface de.espirit.firstspirit.service.treedata.editor.TNodesEditorValue: Deprecated.

Root node.
getRoot(R) - Method in interface de.espirit.firstspirit.service.treedata.TNodeProvider: Returns root object.
getRow() - Method in interface de.espirit.firstspirit.access.editor.value.TableCell: Returns the row index of this cell.
getRow() - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink: Returns the number of the row this rule should be used for.
For regions different to Region.CUSTOM -1 will be returned.
getRowHeight() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Height of displayed rows (in line numbers).
getRowRegion() - Method in interface de.espirit.firstspirit.access.store.templatestore.StyleTemplateLink: Returns the row region set for this rule.
getRows() - Method in interface de.espirit.firstspirit.access.editor.value.Table: Returns the number of existing rows in this table.
getRows(Language) - Method in interface de.espirit.firstspirit.access.editor.DomTableEditorValue: Deprecated.

Provides the number of rows for the given language.
getRowSpan() - Method in interface de.espirit.firstspirit.access.editor.value.TableCell: Returns the rowspan defined for this table cell.
getRulesetConfigFileName() - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService
getRuleSetConfiguration() - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService: Get the global ruleset configuration
getRuleSetConfiguration(long) - Method in interface de.espirit.firstspirit.opt.office.OfficeImportService: Get the project ruleset configuration
getRulesetDefinition() - Method in interface de.espirit.firstspirit.access.store.templatestore.RulesetContainer: Provide the textual definition of this container's rule set.
getRulesetDefinition() - Method in interface de.espirit.firstspirit.store.access.templatestore.RulesetContainer: Deprecated.

Provide the textual definition of this container's rule set.
getRulesetDocument() - Method in interface de.espirit.firstspirit.opt.office.TransformationRules
getRulesetXml() - Method in interface de.espirit.firstspirit.opt.office.TransformationRules
getRunLevel() - Method in interface de.espirit.firstspirit.agency.RunLevelAgent: Returns the current RunLevel of the FirstSpirit server.
getRunningEntries() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntry: Returns a list of schedule entry controls related to this schedule entry and currently running on the FirstSpirit server.
getRunningEntries() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns a list of currently running controllable schedule entries.
getScaling() - Method in interface de.espirit.firstspirit.access.project.mpp.MPPViewport: Get the percentage-based viewport scaling.
getScheduleContext() - Method in interface de.espirit.firstspirit.access.GenerationContext: Get the actual schedule context - this is only set when the generate process is initiated from the scheduler.
getScheduledPageRefs() - Method in interface de.espirit.firstspirit.access.store.sitestore.PageLangSpec: Returns a modifiable list of scheduled page-refs.
getScheduleEntries(boolean) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns a list of all (includeProjectEntries == true) or only server scoped ((includeProjectEntries == false)) schedule entries.
getScheduleEntries(Project) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns a list of schedule entries depending to given project.
getScheduleEntry() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleEntryControl: Returns the schedule entry.
getScheduleEntry() - Method in interface de.espirit.firstspirit.access.schedule.ScheduleTask: Returns the ScheduleEntry this task belongs to.
getScheduleEntry(long) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns the schedule entry specified by the given id.
getScheduleEntry(Project, String) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns the specified schedule entry or null if it couldn't be found.
getScheduleEntryControl(long) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Get the ScheduleEntryControl for a given id.
getScheduleEntryId() - Method in interface de.espirit.firstspirit.server.MaintenanceModeInfo: The id of the related schedule entry.
getScheduleStorage() - Method in interface de.espirit.firstspirit.access.AdminService: Provides the access object for schedule management.
getScheduleTaskTemplate(long) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns the schedule task template with the given id or null for an unknown id.
getScheduleTaskTemplateMapping() - Method in class de.espirit.firstspirit.access.export.ImportParameters
getScheduleTaskTemplates(Project) - Method in interface de.espirit.firstspirit.access.schedule.ScheduleStorage: Returns a list of all schedule task templates for given project.
getSchema() - Method in interface de.espirit.firstspirit.access.database.Layer: Return the database schema name defined for this layer.
getSchema() - Method in interface de.espirit.firstspirit.access.store.contentstore.Content2: Returns the schema this content2 refers to.
getSchema() - Method in interface de.espirit.firstspirit.access.store.contentstore.DatasetProvider: Get the schema the provider refers to.
getSchema() - Method in interface de.espirit.firstspirit.access.store.templatestore.Query: Provides the schema the query operates on.
getSchema() - Method in interface de.espirit.firstspirit.access.store.templatestore.TableTemplate: Gets the schema.
getSchema() - Method in interface de.espirit.firstspirit.event.DatasetChange: Get the Schema of this entity change operation.
getSchema() - Method in interface de.espirit.firstspirit.store.access.nexport.EntityTypeExportInfo: Returns the corresponding schema as a BasicElementInfo.
getSchema() - Method in interface de.espirit.firstspirit.transport.LayerMapper.MappingContext: Returns the transported schema as an instance of the target project.
getSchema() - Method in class de.espirit.or.ConnectionConfiguration: Get the schema name.
getSchema() - Method in interface de.espirit.or.Layer: Return the database schema assigned with this Multiproject-Layer layer.
getSchema() - Method in interface de.espirit.or.Session: Return the schema assigned with this session.
getSchemaByName(String) - Method in interface de.espirit.firstspirit.access.store.templatestore.Schemes: Gets the schema specified by the given name or null if no schema with this name exists.
getSchemaId() - Method in interface de.espirit.firstspirit.event.EventInfo: Provides the id of the schema causing this event, if it entity related.
getSchemaId() - Method in interface de.espirit.or.EntityInfo: Provides the id of the containing DB schema.
getSchemaUid(