Modifier and Type | Method and Description |
---|---|
T |
TypedFilter.filter(Object element)
Filter the given element and return either an object of this
classes type T or null, if the element does not match the
filter as defined by
Filter.accept(Object) . |
Modifier and Type | Method and Description |
---|---|
T |
TypedFilter.filter(Object element)
Filter the given element and return either an object of this
classes type T or null, if the element does not match the
filter as defined by
Filter.accept(Object) . |
Modifier and Type | Method and Description |
---|---|
String |
MappedDiagnosticContext.getMDC(String key)
Get the context identified by the key parameter.
|
Modifier and Type | Method and Description |
---|---|
static void |
Logging.init(Logger logger)
Initialization of the
Logger . |
Modifier and Type | Method and Description |
---|---|
static BufferedImage |
Images.fromStream(InputStream stream)
Loads an image from the specified input stream and returns a buffered image.
|
Modifier and Type | Method and Description |
---|---|
static void |
Streams.close(Closeable... closables)
|
static boolean |
Objects.equal(Object a,
Object b)
Test the given objects on equality.
|
static boolean |
Objects.equal(Object a,
Object b)
Test the given objects on equality.
|
static BufferedImage |
Images.fromStream(InputStream stream)
Loads an image from the specified input stream and returns a buffered image.
|
static boolean |
Strings.isEmpty(String string)
Checks whether or not the specified string is empty.
|
static boolean |
Strings.notEmpty(String string)
Checks whether or not the specified string is not empty.
|
static String |
Strings.notNull(String string)
Returns the specified string, or an empty string if the specified string is
null . |
static <T,D extends T> |
Objects.nvl(T value,
D defaultValue)
Returns the first parameter if it's not
null , else the second. |
Modifier and Type | Method and Description |
---|---|
T |
Filter.TypedFilter.filter(Object element)
Filter the given element and return either an object of this classes type T or null, if the element does not match the filter as defined by
Filter.accept(Object) . |
V |
Dict.get(K key)
Returns the value mapped to the given key or
null if the given key isn't mapped. |
T |
Listable.getFirst()
Get the first element provided by this listable.
|
String |
CsvReader.CsvToken.getValue()
Returns the value of the current token
|
Modifier and Type | Method and Description |
---|---|
static <K,V> Pair<K,V> |
Pair.create(K key,
V value)
Create a pair with the given
key and value . |
static <K,V> Pair<K,V> |
Pair.create(K key,
V value)
Create a pair with the given
key and value . |
Modifier and Type | Field and Description |
---|---|
String |
MailHeader.replyTo
Deprecated.
since 5.2.601 - use
MailHeader.Builder.replyTo(String) and MailHeader.getReplyTo() instead |
String |
MailHeader.sender
Deprecated.
since 5.2.601 - use
MailHeader.Builder.sender(String) and MailHeader.getSender() instead |
Modifier and Type | Method and Description |
---|---|
String |
ReferenceEntry.getCategory()
Returns the category of an external reference.
|
Color |
Workflowable.getColor()
Get the color of the current state.
|
String |
TransitionParameters.getComment()
Get task comment.
|
Connection |
Host.getConnection()
Return the
Connection |
Context |
GenerationContext.getContext(String name)
Return a
Context by given name. |
Data |
TransitionParameters.getCustomData()
Deprecated.
since 5.0.207 use
TransitionParameters.getCustomFormData() |
FormData |
Task.getCustomFormData()
Get this task's custom form data.
|
Layer |
AdminService.getDatabaseLayer(String name)
Returns the specified database layer or
null if it doesn't exists. |
Dataset |
GenerationContext.getDataset()
Returns the first
Dataset if this page is a content page, otherwise null . |
String |
Language.getDisplayName(Language language)
Gets display name of the Language for the given language.
|
Date |
TransitionParameters.getDueDate()
Get due date.
|
IDProvider |
WorkflowContext.getElement()
Returns the element or
null for tasks with no context element. |
FileHandle |
GenerationContext.getFileHandle(String path)
Reurn a
FileHandle for the given path |
IDProvider |
GenerationContext.getNavigationContext()
Returns the origin node for relative urls.
|
Context |
GenerationContext.getPageContext()
Return the page context if set.
|
Project |
Host.getProject()
Shortcut for
Host.getUserService() . |
Project |
Connection.getProjectById(long id)
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. |
Project |
Connection.getProjectByName(String name)
Return a project with a specific name or
null if no project exists with the specified name. |
Object |
ScriptContext.getProperty(String name)
Returns the property specified by the given name or
null if no
property exists with the given name |
IDProvider |
ReferenceEntry.getReferencedElement()
The referenced node.
|
Object |
ReferenceEntry.getReferencedObject()
Provides the referenced node.
|
String |
ReferenceEntry.getReferenceString()
Provides a textual reference representation, e.g.
|
String |
ReferenceEntry.getRemote()
Returns symbolic name of remote configuration.
|
UserService |
UserService.getRemoteUserService(String symbolicName)
Connects the project defined in specified
RemoteProjectConfiguration and returns it's UserService . |
String |
MailHeader.getReplyTo()
A semicolon-separated list of reply addresses.
|
R |
ServerActionHandle.getResult()
Calls
getResult(false) |
R |
ServerActionHandle.getResult(boolean removeAction)
Blocks until the execution of the related server action has been
finished.
|
Revision |
UserService.getRevision()
Get the revision of this userservice.
|
ScheduleContext |
GenerationContext.getScheduleContext()
Get the actual schedule context - this is only set when the generate process is initiated from the scheduler.
|
String |
MailHeader.getSender()
The technical sender of the e-mail.
|
String |
Connection.getServletZone()
Get servlet zone, used in HTTP mode only for constructing the connection URL.
|
StoreElement |
WorkflowContext.getStoreElement()
Deprecated.
since 5.0.207 use
WorkflowContext.getElement() instead |
Store.Type |
ReferenceEntry.getStoreType()
Returns
store-type of the referenced element or null , e.g. for external references. |
TransitionParameters |
WorkflowContext.getTargetTransition()
Returns workflow transition parameters, if already set.
|
Task |
Workflowable.getTask()
Get the possible assigned
Task or null. |
Task |
UserService.getTask(long taskId)
Returns the task specified by the given task id or
null if no task exists with the given id. |
String |
SimpleEditorValue.getTextValue(Language language)
Get the text value for the given language.
|
Transition |
TransitionParameters.getTransition()
Return selected transition.
|
<T> Class<? extends T> |
ModuleAgent.getTypeForName(String name,
Class<T> type)
Returns the exported class that matches the given interface
type and name . |
String |
UrlCreator.getUrlPrefix()
Deprecated.
|
Workflowable |
Task.getWorkflowable()
Return
Workflowable . |
Workflowable |
WorkflowContext.getWorkflowable()
Get StoreElement.
|
TransitionParameters |
WorkflowContext.selectManualTransition(Transition transition)
Select manual workflow transition parameters (show dialog).
|
Modifier and Type | Method and Description |
---|---|
WorkflowScriptContext |
WorkflowContext.createWorkflowScriptContext(Script script,
Transition transition,
Activity activity,
TaskState.Mode callMode,
Data data)
Deprecated.
|
WorkflowScriptContext |
WorkflowContext.createWorkflowScriptContext(Script script,
Transition transition,
Activity activity,
TaskState.Mode callMode,
FormData data)
Create script context for executing a script.
|
void |
UserService.exportStoreElements(OutputStream out,
StoreElement[] elements,
ExportHandler exportHandler)
Exports the given store elements.
|
static Connection |
ConnectionManager.getConnection(String host,
int port,
int mode,
String servletzone,
String module,
CallbackHandler cbHandler)
Create a connection accessor to a FirstSpirit server.
|
void |
Task.gotoErrorState(WorkflowContext context,
Activity activity,
String comment,
Throwable throwable)
Goto model error state.
|
void |
Task.gotoErrorState(WorkflowContext context,
Activity activity,
String comment,
Throwable throwable)
Goto model error state.
|
void |
Task.gotoErrorState(WorkflowContext context,
Activity activity,
String comment,
Throwable throwable)
Goto model error state.
|
boolean |
User.isProjectAdmin(Project project)
Tests if this user project admin for the provided project.
|
void |
GenerationContext.mediaReferenced(Media media,
Language language,
Resolution resolution)
Prints a referenced media to the generation target, if it was not yet printed.
|
void |
GenerationContext.mediaReferenced(Media media,
Language language,
Resolution resolution)
Prints a referenced media to the generation target, if it was not yet printed.
|
void |
Task.setCustomFormData(FormData customFormData)
Set this task's custom form data.
|
Constructor and Description |
---|
Attachment(String name,
String type,
InputStream stream)
Stream-based constructor for an attachment, additionally providing a name and a type for the file.
|
Modifier and Type | Method and Description |
---|---|
Project |
ProjectStorage.getProject(long id)
Returns the project by id, regardless whether it's active or not.
|
Project |
ProjectStorage.getProject(String name)
Returns the project by name, regardless whether it's active or not.
|
User |
UserStorage.getUserByID(long id)
Gets the user with the specified ID
|
User |
UserStorage.getUserByLogin(String login)
Gets the user with the specified login name.
|
Modifier and Type | Method and Description |
---|---|
String |
Layer.getSchema()
Return the database schema name defined for this layer.
|
Modifier and Type | Method and Description |
---|---|
T |
EditorValue.get(Language language)
Deprecated.
Get the value object in the specified language.
|
TableCell |
DomTableEditorValue.getCell(Language language,
int row,
int column)
Gets the
cell of this dom table with the given row & col index
or null if no cell exists with these indices. |
GomFormElement |
EditorValue.getForm()
Deprecated.
Get the form definition.
|
FormData |
Associate.getFormData()
Provides the form data to be indexed for this associate.
|
TableTemplate |
TableTemplateProvider.getTableTemplate()
Get the table template for this value based on the form's
definition.
|
Modifier and Type | Method and Description |
---|---|
void |
ValueIndexer.append(String name,
String value)
Appends the given textual value for indexing with respect to the defined field name.
|
void |
ValueIndexer.appendDate(String name,
Date value)
Appends the given date value for indexing with respect to the defined field name.
|
void |
ValueIndexer.appendNumber(String name,
Number value)
Appends the given number value for indexing with respect to the defined field name.
|
void |
EditorValue.validate(Language language,
T value)
Deprecated.
Checks for the given value to be valid in the specified language wrt. the editor's GOM.
|
Modifier and Type | Method and Description |
---|---|
Template |
IdProvidingFormData.getTemplate()
Returns the template for this form data instance if any.
|
Modifier and Type | Method and Description |
---|---|
Element |
DomElement.diff(Element other)
Compute a difference between this element and the given one.
|
IDProvider |
TargetReference.get()
Get the reference of the element currently set in this TargetReference.
|
TableCell |
Table.getCell(int row,
int column)
Gets the
cell of this table with the given row & col index
or null if no cell exists with these indices. |
Content2 |
TargetReference.getContent()
|
Dataset |
DatasetContainer.getDataset()
The stored dataset - may be null
|
DocumentGroup |
ElementReference.getDocumentGroup()
Provides the referenced element as firstspirit document group, if applicable.
|
DocumentGroup |
TargetReference.getDocumentGroup()
|
EditorValue<?> |
InvalidValueException.getEditorValue()
Provides the editor.
|
DomNode |
DomNode.getFirstChild()
Returns the first child node or
null if there is no such node. |
FormatTemplate |
DomNode.getFormatTemplate()
Returns node's
FormatTemplate . |
UUID |
DatasetContainer.getGid()
The gid of the entity
|
Long |
SectionList.DataSheet.getId()
Deprecated.
since 5.2.21 - see type
|
KeyValue |
DatasetContainer.getKey()
The key value of the entity.
|
Media |
ElementReference.getMedia()
Provides the referenced element as firstspirit media object, if applicable.
|
Media |
ListDomNode.getMedia()
Returns the
Media that is used as bullet icon. |
Media |
TargetReference.getMedia()
Returns a set medium if any or
null if reference is not a type of Media . |
DomNode |
DomNode.getNextSibling()
Returns the next sibling node or
null if there is no such node. |
TableCell |
TableCell.getNextSibling()
Returns the next sibling node or
null if there is no such node. |
TableRowDomNode |
TableRowDomNode.getNextSibling()
Returns the next sibling node or
null if there is no such node. |
Page |
TargetReference.getPage()
Returns a set page or null if referenced element is not type of
Page . |
PageRef |
ElementReference.getPageRef()
Provides the referenced element as page ref, if applicable.
|
PageRef |
TargetReference.getPageRef()
Returns a set page reference or
null if referenced element is not type of PageRef . |
DomNode |
DomNode.getParent()
Returns the parent node or
null if this node is a root node. |
String |
ListDomNode.getPre()
Returns the string that is used as bullet if style style is set to
USER_DEFINED . |
String |
TargetReference.getRemoteSymName()
Return the symbolic remote project name set in the local remote project configuration.
|
Section<?> |
ElementReference.getSection()
Provides the section that may be referenced together with the element.
|
Section<?> |
TargetReference.getSection()
Get the referenced section.
|
Select |
ContentFormsProducer.getSelect()
Returns the configured
select statement or null. |
TableTemplate |
ContentFormsProducer.getTableTemplate()
Returns the configured
table template . |
String |
DomNode.getTagName()
Returns element's tag name.
|
Section<?> |
TargetReference.loadSection(Page page,
String sectionName)
Load a section of the given referenced page identified by its section name.
|
TableCell |
TableCell.nextCell()
Get the next cell (of the current table row) or
null it this cell is the last cell in this row. |
DomNode |
DomNode.replaceChild(DomNode child,
String text)
Replace a child with a new one at the same position the child list.
|
Modifier and Type | Method and Description |
---|---|
static DatasetContainer |
DatasetContainer.Factory.create(Dataset dataset,
Language language)
Factory method to create a DatasetContainer for the specified entity, template and language.
|
Section |
SectionList.create(String sectionName,
Template template,
Long id)
Deprecated.
since 4.2.200 - use
SectionList.create(String, de.espirit.firstspirit.access.store.templatestore.SectionTemplate) instead |
String |
TableCell.getShortContent(SpecialistsBroker broker)
Returns a short content text of this table cell
|
String |
TableCell.getShortContent(UserService userService)
Deprecated.
since 5.2.21 - use
TableCell.getShortContent(SpecialistsBroker) instead. |
static TargetReference |
TargetReference.TargetReferences.newInstance(Language language,
IDProvider reference,
String remoteName)
Create a new TargetReference.
|
static TargetReference |
TargetReference.TargetReferences.newInstance(Language language,
IDProvider reference,
String remoteName)
Create a new TargetReference.
|
void |
TargetReference.resetTo(IDProvider reference,
String remote)
Reset the reference and the remote information and infer settings for UID and UidType.
|
void |
ElementReference.set(Referenceable reference)
Sets the referenced element.
|
void |
ListDomNode.setMedia(Media media)
Provide the
Media that should be used as bullet icon. |
void |
ListDomNode.setPre(String pre)
Provide the string that should be used as bullet if style style is set to
USER_DEFINED . |
void |
ElementReference.setRemote(String name)
Defines the symbolic remote project name, if the reference points to a remote project.
|
void |
TargetReference.setRemoteSymName(String remoteProjectSymName)
If the set element is a remote project reference, this method set the symbolic remote project name definied
in the local project configuration.
|
void |
ElementReference.setSection(Section<?> section)
Defines a section being referenced together with the element.
|
void |
TargetReference.setSection(Section<?> section)
Set the section to be referenced.
|
void |
TargetReference.setSectionName(String name)
Use this to set the section.
|
Modifier and Type | Method and Description |
---|---|
Link |
Area.getLink()
Provides the link this area is pointing to, if any.
|
<R> R |
Area.receive(Area.Visitor<R> visitor)
Receive the handed visitor.
|
R |
Area.Visitor.visit(CircleArea circleArea)
Visit a circular area.
|
R |
Area.Visitor.visit(PolyArea polyArea)
Visit a polygonal area.
|
R |
Area.Visitor.visit(RectArea rectArea)
Visit a rectangular area.
|
Modifier and Type | Method and Description |
---|---|
Date |
BackupParameters.getRevisionDate()
Get date of the revison to backup.
|
String |
BackupParameters.getTagName()
Get custom backup tag name extension.
|
Modifier and Type | Method and Description |
---|---|
void |
BackupParameters.setRevisionDate(Date revisionDate)
Set revision date to backup.
|
void |
BackupParameters.setTagName(String tagName)
Set custom backup tag extension.
|
Modifier and Type | Method and Description |
---|---|
LinkTemplate |
Link.getTemplate()
Returns the link template this link is based on.
|
Modifier and Type | Method and Description |
---|---|
String |
Package.getCustomEventScriptName(String eventName)
Deprecated.
since 5.0.39 - no replacement
|
Calendar |
Subscription.getLastImport()
Returns the date of the last import.
|
PackageImportLogfile |
Subscription.getLastImportLogfile()
Returns the import log file of the last import of this subscription or
null
if no import log file exists. |
Package |
PackageManager.getPackageByName(String packageName)
Returns the
Package specified by the givenname or null if no package exists with thegiven name. |
Project |
Package.getPublisher()
Gets the
Project that is the package's owner. |
Project |
Subscription.getSubscriber()
Returns the subscriber
Project of this subscription. |
Subscription |
PackageManager.getSubscription(Package pck,
Project project)
Returns the subscription instance for the given package and project, or
null if there is no subscription of this package in the provided project. |
TemplatePackage |
ContentPackage.getTemplatePackage()
Returns the TemplatePackage on which this ContentPackage
is dependent or
null if no dependent TemplatePackage
existing for this ContentPackage. |
Long |
IdTranslator.translateIdToPublisher(Long subscriberId)
Translate the given ID of an element used within the subcriber to the ID as defined by the publisher.
|
Long |
IdTranslator.translateIdToSubscriber(Long publisherId)
Translates the given ID of an element from the publisher to the ID to be used within the subscriber.
|
Modifier and Type | Method and Description |
---|---|
String |
Project.getActiveWebServer(String webScope)
Gets the webserver id for the specified webscope
|
String |
Project.getDescription()
Gets the description of the project
|
String |
Resolution.getDescription(Language language)
Get the editorial description of this resolution for the given language
or
null if not defined for the language |
String |
TemplateSet.getDescription(Language language)
Get the editorial description of this TemplateSet for the given language or
null
if not defined for the language |
String |
Resolution.getDisplayName(Language language)
Gets display name of the resolution for the given language.
|
String |
TemplateSet.getDisplayName(Language language)
Gets display name of the TemplateSet for the given language.
|
String |
Group.getEmail()
Gets email address of the group.
|
Language |
Project.getLanguage(String abbreviation)
Get the content language with the specified abbreviation.
|
PresentationChannel |
TemplateSet.getPresentationChannel()
Gets the
PresentationChannel of this TemplateSet |
String |
TemplateSet.getPresentationChannelName()
Gets the name of the presentation channel of the template set
|
String |
RemoteProjectConfiguration.getProjectCategory()
Returns the name of the project category (exclusive the prefix "category:") related to this configuration.
|
Object |
Project.getProperty(String name)
Returns project property with the given
name or null if not found. |
PageTemplate |
Project.getRedirectTemplate()
|
RemoteProjectConfiguration |
Project.getRemoteProjectConfiguration(String symbolicName)
Gets the remote project configuration for the specified symbolic name or
null if not configuration with this name exists for this project. |
Resolution |
Project.getResolutionByName(String name)
Returns the resolution with the given name or
null if no resolution exists in this project with the specified name. |
String |
Project.getSecureMediaFolder()
Get the uid of the secure media folder.
|
String |
Project.getSelectedWebServer(String webScope)
Deprecated.
since 5.2.180906 - no replacement
|
PageTemplate |
Project.getWebeditDefaultTemplate()
Returns the default page template that should be used in webedit, or
null if not specified. |
Workflow |
Project.getWebeditDefaultWorkflow()
Returns the default workflow that should be used in webedit, or
null if not specified. |
String |
Project.getWebeditPreviewUrl()
Returns the custom preview url of webedit or
null , if default url is used. |
TemplateSet |
Project.getWebEditTemplateSet()
the templateset for webedit
|
Modifier and Type | Method and Description |
---|---|
Tag |
Project.createTag(Revision revision,
String tag,
String comment,
Map<String,String> properties)
Create a tag for a existing revision.
|
Tag |
Project.createTag(Revision revision,
String tag,
String comment,
Map<String,String> properties)
Create a tag for a existing revision.
|
Tag |
Project.createTag(String tag,
String comment,
Map<String,String> properties)
Create a tagged revision.
|
Tag |
Project.createTag(String tag,
String comment,
Map<String,String> properties)
Create a tagged revision.
|
List<RemoteProjectConfiguration> |
Project.getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> filter)
Returns the list of remote project configurations for this project that pass the given filter.
|
List<Revision> |
Project.getRevisions(Revision from,
Revision to,
int maxCount,
Filter<Revision> filter)
Returns a list of revisions in descending order.
|
List<Tag> |
Project.getTags(Revision revision,
int maxRevisionCount)
Returns list of tags descending in revision order.
|
List<Tag> |
Project.getTags(Tag tag,
int maxTagCount)
Return list of tags descending in tag creation time (or tag id) order.
|
void |
Project.setDescription(String description)
Sets the description of the project
|
void |
Group.setEmail(String email)
Sets the email address of the group
|
void |
RemoteProjectConfiguration.setProjectCategory(String projectCategory)
Set the name of the project category, for example "myRemoteCategory" not ""category:myRemoteCategory".
|
void |
Project.setRedirectTemplate(PageTemplate template)
Sets the template which should be used to generate
external orrelated project linksof page reference nodes . |
void |
Project.setWebeditDefaultTemplate(PageTemplate template)
Sets the default page template that should be used in webedit, or
null for no default page template. |
void |
Project.setWebeditDefaultWorkflow(Workflow workflow)
Sets the default workflow that should be used in webedit, or
null for no default workflow. |
void |
Project.setWebeditPreviewUrl(String url)
Sets the preview url for webedit.
|
Modifier and Type | Method and Description |
---|---|
MPPViewport.IconType |
MPPViewport.getIconType()
Get the viewport icon type.
|
TemplateSet |
MPPViewport.getTemplateSet()
Get the
TemplateSet configured for this viewport. |
Modifier and Type | Method and Description |
---|---|
MPPViewport.Builder |
MPPViewport.Builder.iconType(MPPViewport.IconType icon)
Set the icon type for this viewport.
|
void |
MPPViewport.setIconType(MPPViewport.IconType icon)
Set the icon type for this viewport.
|
void |
MPPViewport.setTemplateSet(TemplateSet templateSet)
Set the
TemplateSet to be used for this viewport. |
MPPViewport.Builder |
MPPViewport.Builder.templateSet(TemplateSet templateSet)
Set the
TemplateSet to be used for this viewport. |
Modifier and Type | Method and Description |
---|---|
static FtpTarget.FtpServerType |
FtpTarget.FtpServerType.forId(String id)
Returns the ftp server type object matching to the given id or
null if there is no type matching. |
String |
WebServerConfiguration.getAccessFileContent()
Deprecated.
since 5.0 - no replacement
|
String |
ScriptTask.getCustomConnectionLogin()
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. |
String |
ScheduleEntry.getDescription()
Get the description for the schedule entry.
|
String |
ScheduleTask.getDescription()
Returns the description of this task.
|
String |
ScheduleEntry.getEmail()
The e-mail adress(es) which will be used for status mails for finished tasks.
|
Date |
ScheduleEntryControl.getFinishTime()
Returns the time this schedule entry has been finished or
null when the entry has not finished. |
Date |
TaskResult.getFinishTime()
The date execution of this task has been finished or
null if the excecution has not yet finished. |
String |
FtpTarget.getFtpServerType()
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. |
Date |
ScheduleEntryStatistic.getLastExecutionEndTime()
Returns the end time of last date this
ScheduleEntry has been executed or null if the
schedule entry has never been executed yet. |
Date |
ExecutionSchedule.getNextExecutionTime()
Returns the next execution time or
null for expired tasks. |
Date |
FixedExecutionSchedule.getNextExecutionTime()
Returns the next execution time or
null for expired tasks. |
String |
WebServerConfiguration.getPath()
Deprecated.
since 5.0 - no replacement
|
String |
DeltaGeneration.DeletedPageInfo.getPath()
Path of generated page, relative to content root.
|
Project |
ScheduleContext.getProject()
Returns the project the currently running schedule entry belongs to.
|
Project |
ScheduleEntry.getProject()
Returns the project for
project specific tasks or null
if it is a non project related entry |
Project |
ScheduleTaskTemplate.getProject()
Returns the
Project or null if the schedule task template is server scoped. |
ScheduleEntry |
ScheduleStorage.getScheduleEntry(Project project,
String name)
Returns the specified schedule entry or
null if it couldn't be found. |
ScheduleTaskTemplate |
ScheduleStorage.getScheduleTaskTemplate(long id)
Returns the schedule task template with the given id or
null for an unknown id. |
TimeZone |
FtpTarget.getServerTimeZone()
This property is used to interpret file dates, for the format see
TimeZone . |
IDProvider |
WebServerConfiguration.getStartNode()
Deprecated.
since 5.0 - no replacement
|
Date |
TaskResult.getStartTime()
The date execution of this task has been started or
null if the excecution has not yet started. |
ScheduleTask |
ScheduleContext.getTask()
the acutal task or
null if no task is currently executed |
ScheduleTask |
ScheduleTaskTemplate.getTask()
Returns the current task instance or
null . |
ScheduleTaskTemplate |
ScheduleTask.getTemplate()
Returns the
ScheduleTaskTemplate this task uses. |
User |
ScheduleEntryControl.getUser()
Returns the
user who initialized execution of the belonging schedule entry,
or null if user is unknown (scheduled start for example). |
WebServerConfiguration |
DeployTarget.getWebServerConfiguration()
Deprecated.
since 5.0 - no replacement
|
Modifier and Type | Method and Description |
---|---|
ScheduleEntry |
ScheduleStorage.copyScheduleEntry(ScheduleEntry scheduleEntry,
Project project)
Copies the given
scheduleEntry to another project or to server scoped,
if project is null . |
ScheduleEntry |
ScheduleStorage.createScheduleEntry(String scheduleEntryName,
Project project)
Creates a new schedule entry for the provided project.
|
List<ScheduleTaskTemplate> |
ScheduleStorage.getScheduleTaskTemplates(Project project)
Returns a list of all schedule task templates for given
project . |
void |
WebServerConfiguration.setAccessFileContent(String value)
Deprecated.
since 5.0 - no replacement
|
void |
FtpTarget.setConnectionTimeout(Long value)
Set ftp connection timeout parameter in seconds. -1 means no timeout,
null means "use default
value". |
void |
FtpTarget.setDataTimeout(Long value)
Set ftp data transfer timeout parameter in seconds. -1 means no timeout,
null means "use default
value". |
void |
ScheduleEntry.setDescription(String value)
Sets the given
String as description. |
void |
ScheduleTask.setDescription(String value)
Provide the description of this task.
|
void |
ScheduleEntry.setEmail(String value)
Sets the e-mail address(es) that should be used for status mails.
|
void |
FtpTarget.setFtpServerType(String value)
Provide the ftp server type.
|
void |
ScriptTask.setParameter(String name,
String value)
Set a parameter value having the given name to the provided value.
|
void |
WebServerConfiguration.setPath(String value)
Deprecated.
since 5.0 - no replacement
|
void |
ScheduleEntry.setProject(Project project)
Sets the project, if the schedule entry should be related to it.
|
void |
ScheduleTaskTemplate.setProject(Project project)
Set
project to make the schedule task template project scoped or null for server scoped. |
void |
WebServerConfiguration.setStartNode(IDProvider value)
Deprecated.
since 5.0 - no replacement
|
void |
ScheduleTask.setTemplate(ScheduleTaskTemplate template)
Provide the
ScheduleTaskTemplate this task should use. |
void |
GenerateTask.setVariable(String name,
String value)
Sets a value to a variable with the given name.
|
Modifier and Type | Method and Description |
---|---|
List<String> |
SearchService.getSuggestions(Long projectId,
String word,
Language language)
Suggest indexed words matching the given one.
|
List<String> |
SearchService.getSuggestions(long projectId,
String indexField,
String word,
Language language)
Suggest indexed words matching the given one.
|
Modifier and Type | Method and Description |
---|---|
StoreElement |
StoreElementFilter.filter(Object element)
Filter the given element and return either an object of this
classes type T or null, if the element does not match the
filter as defined by
Filter.accept(Object) . |
DataValue |
Data.get(String name)
Deprecated.
since 5.2.21 - see type
|
String |
LanguageInfo.getDisplayName()
Returns the language specific displayname for this storeelement or
null
if no display name is set for this language. |
User |
StoreElement.getEditor() |
StoreElement |
StoreElement.getFirstChild()
Provides the first child node.
|
IDProvider |
IDProvider.getInRevision(Revision revision)
Get this element in the state of the given revision.
|
Language |
Monoglot.getLanguage()
The language defining the data path in which the monoglot mode is to be used.
|
Data |
IDProvider.getMeta()
Deprecated.
since 4.2.450 - use
IDProvider.getMetaFormData() instead |
FormData |
IDProvider.getMetaFormData()
Returns the
formdata container of this element or null if there is no meta data template defined for project. |
Monoglot |
Data.getMonoglot()
Deprecated.
since 5.2.510, no replacement
|
MultiPageParams |
Data.getMultiPageParams(Language language)
Deprecated.
Since 5.0.104, no replacement.
|
MultiPageParams |
MultiPageParamsProvider.getMultiPageParams(Language language) |
StoreElement |
StoreElement.getNextSibling()
Provides the next sibling store element.
|
Package |
PackagePoolItem.getPackage()
Returns the
Package this item belongs to or null . |
IDProvider |
IDProvider.getParent()
|
StoreElement |
StoreElement.getParent()
|
StoreElement |
StoreElement.getPreviousSibling()
Provides the previous store element.
|
String |
StoreElement.getReferenceName()
Provided the element's reference name.
|
User |
IDProvider.getReleasedBy()
The last user who released this node or
null if this node has never been released. |
Revision |
IDProvider.getReleaseRevision() |
String |
ContentProducer.getStoredUrl(Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for this node and the provided combination of language, template set, and (optionally) entity.
|
IDProvider |
Store.getStoreElement(long id) |
IDProvider |
Store.getStoreElement(Long id)
Get a child by it's node id.
|
IDProvider |
Store.getStoreElement(String uid,
IDProvider.UidType uidType)
Get an element of this store by it's unique identifier and unique type or
null if no child exists with the given parameter. |
IDProvider |
Store.getStoreElement(String attributeName,
String attributeValue)
Get a child of this store by the value of a attribute or
null if no child exists with the given parameter |
WorkflowPermission |
StoreElement.getWorkflowPermission(Workflow workflow)
Return workflow permission object for the given workflow.
|
static ReferenceType |
ReferenceType.typeOf(IDProvider.UidType uidType)
Determine the reference type based on the given uid type.
|
static ReferenceType |
ReferenceType.typeOf(String referenceOrTypeName) |
Modifier and Type | Method and Description |
---|---|
void |
StoreElement.appendChildBefore(StoreElement child,
StoreElement nextsibling)
Deprecated.
since 4.2.204 - use
IDProvider#moveChild(child, nextsibling) |
DataValue |
Data.create(String name,
UserService userService,
Element value)
Deprecated.
since 5.2.21 - see type
|
void |
StoreElement.exportStoreElement(OutputStream out,
ExportHandler exportHandler)
Exports this storeelement as zip file to the given outputstream.
|
WorkflowPermission |
StoreElement.getCreateWorkflowPermission(Workflow workflow)
Return workflow permission object for the given workflow.
|
PreviewUrl |
Previewable.getPreviewUrlObject(Language language,
TemplateSet templateSet,
boolean release,
int mode,
Map<?,?> params)
Deprecated.
since 5.2.190105, please use
PreviewUrlAgent.ContentProducerPreviewUrlBuilder#getUrlObject(ContentProducer) |
String |
ContentProducer.getStoredUrl(Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for this node and the provided combination of language, template set, and (optionally) entity.
|
WorkflowPermission |
StoreElement.getWorkflowPermission(Workflow workflow)
Return workflow permission object for the given workflow.
|
StoreElement |
StoreElement.importStoreElement(ZipFile exportFile,
ImportHandler importHandler)
Imports the first root node from the given zip exportfile.
|
Listable<StoreElement> |
StoreElement.importStoreElements(ZipFile exportFile,
ImportHandler importHandler)
Imports all root nodes from the given zip exportfile.
|
boolean |
StoreElement.isWorkflowAllowed(Workflow workflow,
User user)
Returns
true if
workflow is not null and is explicitly allowed to be started on this element by given user or
workflow is null and any workflow is allowed to be started on this element by given user . |
StoreElement |
Store.restore(ElementInfo elementInfo,
IDProvider parent)
Restore the element defined by the given information.
|
void |
IDProvider.setDisplayName(Language language,
String displayName)
Sets the display name (label) for the specified language.
|
void |
LanguageInfo.setDisplayName(String displayName)
Sets the display name for this storeelement for the underlying language
|
void |
IDProvider.setMeta(Data data)
Deprecated.
since 4.2.450 - use
IDProvider.setMetaFormData(de.espirit.firstspirit.forms.FormData) instead |
void |
IDProvider.setMetaFormData(FormData formData)
Sets the given
formdata container of this element. |
Constructor and Description |
---|
LockException(String message,
User user,
long objectId)
Constructor for this class.
|
LockException(String message,
User user,
long objectId,
Throwable cause)
Constructor for this class.
|
LockException(String message,
User user,
long objectId,
Throwable cause)
Constructor for this class.
|
Modifier and Type | Method and Description |
---|---|
Content2 |
ContentStoreRoot.getContent2ByName(String uid)
Get Content2 object by uid by calling
Store.getStoreElement(String, de.espirit.firstspirit.access.store.IDProvider.UidType) |
Dataset |
DatasetProvider.getDataset(Entity entity,
Revision revision)
Get a dataset for the given entity in a defined revision.
|
Entity |
Content2.getEntity(Object keyValue)
Returns the entity found for given
keyValue or null . |
Content2 |
Dataset.getParent()
Returns parent
Content2 which can be null if this dataset (or it's entity) is only
associated with a table-template . |
Entity |
Content2ScriptContext.getSelectedRow() |
Workflowable |
Content2.getWorkflowable(Entity entity)
Get a workflowable instance for the provided entity.
|
Modifier and Type | Method and Description |
---|---|
Content2 |
ContentFolder.createContent(TableTemplate tableTemplate,
String uidSuggestion,
Map<Language,String> language2displayNameMapping,
boolean unifyUidOnServer)
Creates a new content node in this folder.
|
ContentFolder |
ContentFolder.createContentFolder(String uidSuggestion,
Map<Language,String> lang2DisplayName,
boolean unifyUid)
Create a new ContentFolder as child of this folder.
|
Modifier and Type | Method and Description |
---|---|
IdProvidingFormData |
MediaFormsProducer.create(Media media)
Creates a new form data based on the given media.
|
Modifier and Type | Method and Description |
---|---|
GCAPage |
GlobalStoreRoot.getGcaByName(String name)
Returns the
gca page with the given name or null if no page exist with this nameCalls getStoreElement (name, GCAPage.UID_TYPE ) |
String |
URLProperties.getStoredUrl(ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for the specified parameters set.
|
String |
URLProperties.getStoredUrl(MediaFolder folder,
Language language)
Get the stored URL for the specified parameter set.
|
String |
URLProperties.getStoredUrl(Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
String |
URLProperties.getStoredUrl(SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
Get the stored URL for the specified parameter set.
|
Modifier and Type | Method and Description |
---|---|
String |
URLProperties.getStoredUrl(ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for the specified parameters set.
|
String |
URLProperties.getStoredUrl(Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
String |
URLProperties.getStoredUrl(Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Set the stored URL for the specified parameters set.
|
void |
URLProperties.setStoredUrl(String url,
ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Set the stored URL for the specified parameters set.
|
void |
URLProperties.setStoredUrl(String url,
MediaFolder folder,
Language language)
Set the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Set the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Set the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Set the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
Set the stored URL for the specified parameter set.
|
void |
ProjectProperties.setTemplate(PageTemplate template)
Sets the template for this project properties.
|
Modifier and Type | Method and Description |
---|---|
PictureCropData |
PictureResolution.getCropData()
Get the Crop information of current picture resolution if exists (bounds related to original resolution)
or
null if parameter cropData isn't set |
String |
MediaMetaData.getEncoding()
Returns the encoding if this media is a file and has a encoding.
|
File |
Media.getFile(Language language)
Get the given media as a
File object in the language provided. |
Revision |
File.getFileRevision()
Return file content revision or
null if no content exits. |
FocusArea |
PictureCropData.getFocus()
Returns the focus area associated with this crop selection.
|
InputStream |
Picture.getInputStream(Resolution resolution)
Get the picture content of the current picture-media as an inputstream.
|
Object |
Media.getMediaContent(Language language)
|
MimeType |
File.getMimeType()
Get the mime-type.
|
MimeType |
MediaMetaData.getMimeType()
Returns the immutable MIME type.
|
MimeType |
PictureResolution.getMimeType()
Get the mime-type of the current picture resolution.
|
Picture |
Media.getPicture(Language language)
Get the given media as a
Picture object in the language provided. |
MediaMetaData |
Picture.getPictureMetaData(Resolution resolution)
Return media meta data for saved and generated picture resolutions.
|
byte[] |
Picture.getPreview()
Deprecated.
since 5.0 - use
Picture.getPreviewImage() |
byte[] |
File.getPreviewImage()
Get a small preview/thumbnail image of this picture
|
byte[] |
Picture.getPreviewImage()
Get a small preview/thumbnail image of this picture
|
String |
MediaFolder.getStoredUrl(Language language)
Get the stored URL for this node and the provided language.
|
String |
Media.getStoredUrl(Language language,
Resolution resolution)
Get the stored URL for this node and the provided combination of language and resolution.
|
Modifier and Type | Method and Description |
---|---|
File |
Media.getFile(Language language)
Get the given media as a
File object in the language provided. |
Picture |
Media.getPicture(Language language)
Get the given media as a
Picture object in the language provided. |
String |
Media.getStoredUrl(Language language,
Resolution resolution)
Get the stored URL for this node and the provided combination of language and resolution.
|
String |
Media.getStoredUrl(Language language,
Resolution resolution)
Get the stored URL for this node and the provided combination of language and resolution.
|
void |
PictureResolution.setCropData(PictureCropData cropData)
Sets the crop information related to the original resolution, or
null to remove. |
void |
PictureCropData.setFocus(FocusArea focusArea)
Configures the focus area associated with this crop selection.
|
void |
Picture.setPicture(Resolution resolution,
long length,
InputStream pictureStream,
String extension)
Uploads the picture data for the given resolution by reading from the given input stream.
|
void |
File.setPreviewImage(byte[] bytes)
Set a the image data source to create a preview-thumbnail from.
|
void |
Picture.setPreviewImage(byte[] bytes)
Set a the image data source to create a preview-thumbnail from.
|
void |
PictureCropData.setSelection(Rectangle2D selection)
Sets the selection rectangle.
|
Constructor and Description |
---|
MediaMetaData(int height,
int width,
long size,
String extension,
Revision revision,
long crc,
MimeType mimeType,
String encoding)
Construct a new media meta data instance.
|
UploadRejectedException(String message,
Throwable cause)
Create a new exception instance with the given message and cause.
|
Modifier and Type | Method and Description |
---|---|
long[] |
Section.getLifespan()
Get the lifespan of the current section if there is one defined.
|
long[] |
SectionReference.getLifespan()
Get the lifespan of the referenced source section if there is one defined.
|
Modifier and Type | Method and Description |
---|---|
StartNode |
SiteStoreFolder.findStartNode()
Finds recursive the start node in this sub tree.
|
Content2Params |
PageRef.getContent2Params()
|
Page |
AltPageRef.getPage()
Get the page from PageStore that is alternative page for an pagereference
|
Page |
PageRef.getPage()
Get the page from Page-Store of the current pagereference as object
|
PageGroup |
PageRef.getPageGroup()
Get the page-group of the current pagereference as object
|
SiteStoreFolder |
SiteStoreFolder.getParentFolder()
Get the parent folder.
|
PageTemplate |
DocumentGroup.getPrefixTemplate()
Get the template which is used to render the prefix, e.g. a table of contents
|
Query |
Content2Params.getQuery()
Provides the query used for fetching records.
|
RemoteProjectConfiguration |
PageLangSpec.getRemoteProjectConfiguration()
Return RemoteProjectConfiguration used for related project.
|
String |
PageLangSpec.getSiteMapLabel()
Get the sitemap label of this pageref.
|
Picture |
PageLangSpec.getSiteMapPicture()
Gets the sitemap picture of this pageref.
|
String |
PageLangSpec.getSiteMapPictureRef()
Provides the reference string for the site map picture, e.g.
|
String |
Content2Params.getSitemapVariableName()
Returns the name of the variable which may be used in the sitemap for the embedding
PageRef - may be
null if the default label should be used. |
StartNode |
SiteStoreFolder.getStartNode()
Returns the startnode of this folder which is a direct child of this folder or
null if no start node is
defined. |
String |
SiteStoreFolder.getStoredUrl(Language language,
TemplateSet templateSet)
Get the stored URL for this node and the provided combination of language and template set.
|
String |
SiteStoreRoot.getStoredUrl(Language language,
TemplateSet templateSet)
Get the stored URL for this node and the provided combination of language and template set.
|
PageTemplate |
DocumentGroup.getSuffixTemplate()
Get the template which is used to render the suffix, e.g. an index
|
TableTemplate |
Content2Params.getTableTemplate()
Provides the table template for rendering records.
|
Modifier and Type | Method and Description |
---|---|
void |
DocumentGroup.appendChildBefore(StoreElement child,
StoreElement before)
Appends a child element to this group, inserting it before a reference element.
|
void |
PageLangSpec.setRemoteProjectConfiguration(RemoteProjectConfiguration configuration)
Set RemoteProjectConfiguration used for releated project.
|
void |
PageLangSpec.setSiteMapPicture(Picture picture)
Sets the sitemap picture for this pagereference.
|
void |
Content2Params.setSitemapVariableName(String value)
Defines the name for the sitemap variable.
|
Constructor and Description |
---|
ContentMultiPageParams(Session session,
Select select,
int entitesPerPage,
int maxPageCount,
Date time)
Constructor based on some restrictions.
|
Modifier and Type | Method and Description |
---|---|
TemplateBody |
PageTemplate.getBody(String bodyName)
Returns the
template body specified by the given name or null if no body
exists with the given name. |
String |
Template.getComment()
Get the comment of the Template
|
Attribute<?> |
TableTemplate.Mapping.getDBAttribute(String langAbbreviation)
Provides the database attribute bound to this mapping for the given language.
|
Attribute<?> |
TableTemplate.Mapping.getDBAttribute(String langAbbreviation,
EntityType entityType)
Provides the database attribute bound to this mapping for the given language wrt. the named entity type.
|
StyleTemplate |
TableFormatTemplate.getDefaultStyleTemplate()
Returns the
StyleTemplate used for any table cell if not explicitly overridden
using a StyleTemplateLink . |
String |
LinkTemplate.getDropEditorName()
Get the name of the editor that should be used as a drop target.
|
String |
LinkTemplate.getExternalUrlEditorName()
The name of the editor which will contain the textual representation of an external "url".
|
String |
Snippet.getExtract()
Returns extract expression of this snippet.
|
FormData |
WorkflowScriptContext.getFormData()
Provides the form data defined within the current
Task . |
String |
Snippet.getHeader()
Returns header expression of this snippet.
|
String |
LinkTemplate.getPictureEditorName()
Provides the name of the picture editor component, used for storing a graphical description.
|
byte[] |
PreviewImageProvider.getPreviewImage()
Return preview image as byte array or null if no preview image is set.
|
PageRef |
MasterTemplate.getPreviewPageRef()
|
Schema |
Schemes.getSchemaByName(String name)
Gets the schema specified by the given name or
null if no
schema with this name exists. |
Select |
Query.getSelectStatement()
Returns the select object for this query or
null if there isn't one defined yet. |
StyleTemplateLink |
TableFormatTemplate.getStyleTemplate(int row,
boolean lastRow,
int column,
boolean lastColumn)
Get the first matching style template link for a specific row and column.
|
StyleTemplate |
StyleTemplateLink.getTargetTemplate()
Returns the target
template |
PageTemplate |
PageTemplates.getTemplate(String uid)
Returns page template with the given uid or
null . |
T |
TemplateContainer.getTemplate(String uid)
Returns page template with the given uid or
null . |
MasterTemplate |
TemplateStoreRoot.getTemplateById(long templateId)
Get the template by given
template id or null
if no template exists with the given template id. |
String |
LinkTemplate.getTextEditorName()
Provides the name of the text editor component, used for storing the link description (e.g., for DOM).
|
String |
Snippet.getThumbnail()
Returns expression for the thumbnail of this snippet used to request a
medium |
Transition |
WorkflowScriptContext.getTransition()
Return result transition of the script execution.
|
Object |
TableTemplate.Mapping.getValueFromEntity(Object persistentObject,
String language)
Get the value for the given object and language.
|
Workflow |
TemplateStoreRoot.getWorkflowById(long workflowId)
Returns the workflow with the given
workflow id
null if no workflow exits with the given id. |
Workflow |
TemplateStoreRoot.getWorkflowByName(String name)
Get a workflow by its
uid . |
Modifier and Type | Method and Description |
---|---|
Script |
ScriptContainer.createScript(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyUid)
Creates a new Script as child of this ScriptContainer
|
ScriptFolder |
ScriptContainer.createScriptFolder(String name,
Map<Language,String> lang2DisplayName)
Creates a
ScriptFolder with the given name and displaynames as a child of this ScriptContainer. |
StyleTemplate |
FormatTemplateContainer.createStyleTemplate(String uid,
boolean unifyNameOnServer,
Map<Language,String> lang2DisplayName)
Factory for a
StyleTemplate based on a uid. |
TableFormatTemplate |
FormatTemplateContainer.createTableFormatTemplate(String uid,
boolean unifyNameOnServer,
Map<Language,String> lang2DisplayName)
Factory for a
TableFormatTemplate based on a uid. |
LinkTemplate |
LinkTemplates.createTemplate(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
PageTemplate |
PageTemplates.createTemplate(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
SectionTemplate |
SectionTemplates.createTemplate(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
T |
TemplateContainer.createTemplate(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
TemplateFolder<LinkTemplate> |
LinkTemplates.createTemplateFolder(String name,
Map<Language,String> lang2DisplayName)
Create a new sub-folder in this folder
|
TemplateFolder<PageTemplate> |
PageTemplates.createTemplateFolder(String name,
Map<Language,String> lang2DisplayName)
Create a new sub-folder in this folder
|
TemplateFolder<SectionTemplate> |
SectionTemplates.createTemplateFolder(String name,
Map<Language,String> lang2DisplayName)
Create a new sub-folder in this folder
|
TemplateFolder<T> |
TemplateContainer.createTemplateFolder(String name,
Map<Language,String> lang2DisplayName)
Create a new sub-folder in this folder
|
WorkflowFolder |
WorkflowContainer.createWorkflowFolder(String name,
Map<Language,String> lang2DisplayName)
Creates a new
WorkflowFolder with the given name and displaynames as child of this workflow container. |
void |
WorkflowScriptContext.gotoErrorState(String comment,
Throwable throwable)
Goto the error state of the workflow.
|
void |
WorkflowScriptContext.gotoErrorState(String comment,
Throwable throwable)
Goto the error state of the workflow.
|
void |
TableFormatTemplate.setDefaultStyleTemplate(StyleTemplate template)
Provide the
StyleTemplate that should be used for any table cell which style isn't explicitly overriden
using a StyleTemplateLink definition |
void |
LinkTemplate.setDropEditorName(String value)
Set the name of the editor that should be used as a drop target.
|
void |
LinkTemplate.setExternalUrlEditorName(String value)
Defines the name of the editor component used for external urls.
|
void |
Snippet.setExtract(String extractExpression)
Set the extract expression for this snippet.
|
void |
Snippet.setHeader(String headerExpression)
Set the header expression for this snippet.
|
void |
Schema.setLayer(String layerName)
Set the database layer to use for this schema.
|
void |
LinkTemplate.setPictureEditorName(String value)
Set the variable name from the
form which is used to get an image to display from
link instances created with this template . |
void |
MasterTemplate.setPreviewPageRef(PageRef pageRef)
|
void |
LinkTemplate.setTextEditorName(String value)
Set the variable name from the
form which is used to get the display text from
link instances created with this template . |
void |
Snippet.setThumbnail(String thumbNailExpression)
Sets the expression for the thumbnail of this snippet.
|
Modifier and Type | Method and Description |
---|---|
GomFormElement |
GomEditorProvider.findEditor(String name)
Look up a GOM editor element within this provider.
|
GomElement |
GomEditorProvider.get(int index)
Getter for GomElements.
|
GomLangInfo |
GomLangInfos.get(String lang)
Get a language information entry by the language it is defined
for.
|
EditorValue<?> |
GomFormElement.getDefaultValue()
Get the default value for the form element.
|
IDProvider |
GomCheckable.Context.getElement()
Provides the operational store element for this context.
|
String |
GomEditorProvider.getUid()
Get the unique identifier of this provider.
|
GomLangInfo |
GomLangInfos.resolve(String lang)
Resolve the language-specific information for the given language.
|
Modifier and Type | Method and Description |
---|---|
List<String> |
GomEditorProvider.appendEditorNames(List<String> names)
Append the names of all local and children's editors to the given list of names and return the list.
|
void |
GomEditorProvider.setFormDefaults(FormData formData)
Set the default values for all editors based on the given form data.
|
void |
GomIndexTreatment.setIndexTreatment(Treatment treatment)
Sets the option on how to treat following associations.
|
void |
AbstractGomFormElement.setLabelAndDescription(String lang,
String label,
String description)
Sets the label and description for a specific language.
|
void |
AbstractGomFormElement.setLabelAndDescription(String lang,
String label,
String description)
Sets the label and description for a specific language.
|
void |
AbstractGomFormElement.setSearchRelevancy(Relevancy relevancy)
Sets the relevancy level for this GOM element.
|
void |
GomSearchRelevancy.setSearchRelevancy(Relevancy relevancy)
Sets the relevancy level for this GOM element.
|
Constructor and Description |
---|
GomValidationError(String message,
GomElement gom,
String detail)
Create a new exception with the given message to be thrown for the provided gom element and a regular expression used to identify the position of the gom element's detail.
|
Modifier and Type | Method and Description |
---|---|
IdProvidingFormData |
ExternalFormsProducer.get(Long id)
Returns a form data for the given external
id or null if the id couldn't be found. |
Modifier and Type | Method and Description |
---|---|
GomElement |
GomIndexSource.configuration()
Provides an optional container for configuring the source.
|
Modifier and Type | Method and Description |
---|---|
void |
Context.setVariableValue(String variableName,
Object value)
Set a variable value within this local context.
|
Modifier and Type | Method and Description |
---|---|
O |
Image.Consumer.consume(Icon icon)
Consume an icon.
|
O |
Image.Consumer.consume(Media media)
Consume a medium.
|
O |
Image.Consumer.consume(String url)
Consume a URL.
|
String |
ServerInformationAgent.VersionInfo.getBranch()
Returns the name of the branch of the belonging FirstSpirit version or
null . |
SpecialistsBroker |
BrokerAgent.getBroker(long revision)
Get hold of a broker operating on the given revision.
|
SpecialistsBroker |
BrokerAgent.getBroker(String symbolicProjectName)
Try getting hold of a broker for a remote project registered under the given symbolic name.
|
SpecialistsBroker |
BrokerAgent.getBrokerByProjectId(long projectId)
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. |
SpecialistsBroker |
BrokerAgent.getBrokerByProjectName(String projectName)
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. |
IDProvider |
SnippetContext.getContextualElement()
Provide a FirstSpirit element to retrieve further information for snippet building.
|
String |
UIAgent.getDescription(WorkflowElement workflowElement)
Provides the description for the given workflow element according to the currently set UI language and display mode.
|
String |
DataSnippet.getExtract()
Provides the extract text being used as a long representation of the given object.
|
Group |
ProjectMembersAgent.getGroupByName(String name)
Gets the group with the specified name.
|
Image<Icon> |
ImageAgent.getImageFromIcon(Icon icon)
Creates an
Image container based on the given icon object. |
Image<Media> |
ImageAgent.getImageFromMedia(Media media)
Creates an
Image container based on the given media object. |
Image<String> |
ImageAgent.getImageFromUrl(String url)
Creates an
Image container based on the given url pointing to some image. |
Language |
UrlAgent.UrlEntry.getLanguage()
Returns the
language for which this url entry is specified for. |
Date |
UserStatisticsAgent.getLastLoginAsDate(long userId)
Deprecated.
since 5.2.180703 - use
UserStatisticsAgent.getLastLogin(long) instead |
FormData |
SnippetContext.getMetaData()
Provide meta data to be used within a snippet definition.
|
String |
ProjectRestriction.getName()
The project's symbolic name.
|
<P> P |
OperationAgent.getOperation(OperationType<P> type)
Get a new operation object to parameterize and execute it.
|
FormValidationReport |
MultiFormValidationReport.getProblems(Language language)
Gives a report for the specified language.
|
FormValidationReport |
MultiFormValidationReport.getProblemsForMetaData()
Gives a report for the meta data.
|
MultiFormValidationReport |
ElementValidationReport.getReport(ValidationAgent.ValidationScope scope)
Get the report for a given scope.
|
Resolution |
UrlAgent.MediaUrlEntry.getResolution()
Returns the
resolution for which this media url entry is specified for. |
Resolution |
ResolutionAgent.getResolutionByName(String resolutionName)
Get the resolution having the given symbolic name.
|
TemplateSet |
UrlAgent.PageRefUrlEntry.getTemplateSet()
Returns the
template set for which this url entry is specified for. |
TemplateSet |
UrlAgent.PageRefFolderUrlEntry.getTemplateSet()
Returns the
template set for which this url entry is specified for. |
Image<?> |
DataSnippet.getThumbnail()
Provides a thumbnail image resource for the given object or
null if no thumbnail representation is available. |
Image<?> |
SnippetAgent.getTypeIcon(IDProvider element)
Provides a type image resource for the given element.
|
User |
ProjectMembersAgent.getUserByLogin(String login)
Gets the user with the specified login name.
|
Referenceable |
StoreElementAgent.loadReference(String reference,
boolean release)
Load a reference with the given reference descriptor.
|
IDProvider |
StoreElementAgent.loadStoreElement(String uid,
IDProvider.UidType uidType,
boolean release)
Load a store object with the given
uid and uidType . |
String |
GenerateElementOperation.perform(PageRef element,
Language language)
Executes the configured
ScheduleEntry and waits for its completion. |
<S> S |
SpecialistsBroker.requestSpecialist(SpecialistType<S> type)
Request a specialist.
|
<O> O |
Image.supply(Image.Consumer<O> consumer)
Supply the image to the given consumer.
|
Modifier and Type | Method and Description |
---|---|
RenderingAgent.Renderer |
RenderingAgent.Renderer.additionalContext(String key,
Object value)
Adds the provided value to the top-most context.
|
ClientUrlAgent.JavaClientUrlBuilder |
ClientUrlAgent.JavaClientUrlBuilder.connectionMode(ClientUrlAgent.JavaClientUrlBuilder.ConnectionMode connectionMode)
Provide the connection mode that should be used.
|
T |
ClientUrlAgent.ClientUrlBuilder.element(IDProvider element)
Provide the element that should be opened.
|
List<ReferenceEntry> |
ProjectReferencesAgent.getExternalReferences(String category,
boolean release)
Get all external references from the current or from the release stores.
|
Image<Icon> |
ImageAgent.getImageFromIcon(Icon icon)
Creates an
Image container based on the given icon object. |
Image<Media> |
ImageAgent.getImageFromMedia(Media media)
Creates an
Image container based on the given media object. |
Image<String> |
ImageAgent.getImageFromUrl(String url)
Creates an
Image container based on the given url pointing to some image. |
Map<String,RemoteProjectConfiguration> |
ProjectAgent.getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> remoteCondition)
Get the configurations of remote projects defined.
|
boolean |
PasswordAgent.isEncryptedPassword(String password)
Indicates if the given string is an encrypted password.
|
T |
ClientUrlAgent.ClientUrlBuilder.language(Language language)
Provide the data language that should be used.
|
T |
PreviewUrlAgent.PreviewUrlBuilder.language(Language language)
Provide the language for which the url should be rendered.
|
T |
ClientUrlAgent.ClientUrlBuilder.locale(Locale locale)
Provide the locale that should be used for the UI.
|
void |
RenderingAgent.MediaLinkListener.mediaLinked(Media media,
Language language,
Resolution resolution)
Callback
|
void |
RenderingAgent.MediaLinkListener.mediaLinked(Media media,
Language language,
Resolution resolution)
Callback
|
T |
ClientUrlAgent.ClientUrlBuilder.project(Project project)
Provide the project that should be opened.
|
ProcessAgent.ProcessBuilder |
ProcessAgent.ProcessBuilder.redirectOutput(String prefix)
Redirects
error and normal output to
the log. |
PreviewUrlAgent.MediaPreviewUrlBuilder |
PreviewUrlAgent.MediaPreviewUrlBuilder.resolution(Resolution resolution)
Selects an alternative resolution instead of the default
Resolution.ORIGINAL_RESOLUTION_NAME for
rendering of type Media.PICTURE . |
void |
GenerateElementOperation.setBaseUrl(String baseUrl)
Configures the base url the generated content is accessible from.
|
void |
SnippetContext.setElement(IDProvider element)
Sets the element to be used as context information source for snippet building.
|
void |
SnippetContext.setMetadata(FormData metadata)
Sets the meta data to be used for snippet building.
|
void |
GenerateElementOperation.setScheduleEntry(ScheduleEntry scheduleEntry)
Configures a
ScheduleEntry which should be used for the partial generation
of the PageRef . |
void |
TrackingAgent.track(UUID uuid,
String label,
String categoryName)
Tracking of usages.
|
void |
TrackingAgent.track(UUID uuid,
String label,
String value,
String categoryName,
String explanation)
Tracking of usages.
|
void |
TrackingAgent.track(UUID uuid,
String label,
String value,
String categoryName,
String explanation)
Tracking of usages.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
Aspectable.getAspect(AspectType<T> aspect)
Request an aspect from the aspectable.
|
Modifier and Type | Method and Description |
---|---|
String |
PreviewUrl.getQueryString()
Returns an optional query string to be appended to the preview url.
|
Modifier and Type | Method and Description |
---|---|
EditorNode |
EditorItemNode.getEditor()
Provides a subsequent node identifying an editor component within the item referenced by this node.
|
EditorItemNode |
EditorNode.getItemNode()
Provides a subsequent node identifying an entry of the edit component referenced by this node.
|
EditorNode |
EditorNode.removeTailEnd()
Remove the tail end editor node and return it.
|
Modifier and Type | Method and Description |
---|---|
Catalog |
CatalogEditorValue.get(Language language)
Get the value object in the specified language.
|
Index |
IndexEditorValue.get(Language language)
Get the value object in the specified language.
|
<T> T |
ValueEngineer.getAspect(ValueEngineerAspectType<T> aspect)
Request an aspect of the given type.
|
String |
Node.getAttribute(String name)
The value of the attribute with the specified name.
|
Object |
Difference.getContrast()
An object giving contrast information.
|
IDProvider |
IDProviderReferenceHolder.getElement()
Resolves the element referenced by this container.
|
T |
ValueEngineer.getEmpty()
Create an empty (initial) value.
|
GomCatalog |
CatalogEditorValue.getForm()
Get the form definition.
|
GomIndex |
IndexEditorValue.getForm()
Get the form definition.
|
String |
IDProviderReferenceHolder.getRemote()
Symbolic project name, if the referenced element originates from a remote project.
|
String |
Node.getText()
The text content of this node.
|
T |
InitialValueProviding.onCreation()
Callback to provide a value for creation stage use.
|
T |
ValueEngineer.read(List<Node> nodes)
Read the value.
|
Modifier and Type | Method and Description |
---|---|
List<Difference> |
Contrastable.contrastWith(Language language,
Object value)
Contrasts this instance with a given value.
|
List<Difference> |
Contrastable.contrastWith(Language language,
Object value)
Contrasts this instance with a given value.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(IDProvider element,
String remoteConfigName)
Create an element referencing container from a given id providing store element.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String uid,
IDProvider.UidType uidType,
String remoteConfigName)
Create an element referencing container on given store element information.
|
ExternalReferenceHolder |
ReferenceConstructionAgent.create(String resource,
String category)
Create an external referencing container from a given resource (e.g. an URL) and category.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String schemaUid,
String entityTypeName,
KeyValue keyValue,
String remoteConfigName)
Create a dataset referencing container on given information.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String schemaUid,
String entityTypeName,
UUID gid,
String remoteConfigName)
Create a dataset referencing container on given information.
|
Node |
Node.setAttribute(String name,
String value)
Sets the named attribute to a provided value, which might also be
null . |
Reference |
ReferenceHolder.toReference(ReferenceHolder.ChangeCallback callback)
Resolves a reference descriptor from the referenced element.
|
Constructor and Description |
---|
Difference(Object contrast,
Modification modification)
Constructor building a difference from a contrast object and the according modification flagging.
|
Modifier and Type | Method and Description |
---|---|
Catalog.Card |
Catalog.create(Template template,
FormData formData)
Factory method to create a new card based on the given template and form data.
|
Modifier and Type | Method and Description |
---|---|
ApplicationTabAppearance |
ApplicationTabConfiguration.getAppearance()
The appearance for the application tab.
|
<T,C extends ApplicationTabConfiguration<?>> |
ApplicationService.getApplication(ApplicationType<T,C> type,
Object tabIdentifier)
Returns an application specified by the given type and
tabIdentifier or null if
it doesn't exists. |
Store.Type |
ApplicationTabAppearance.getBorderType()
The type of colored border line between main and sub tabs related to the store color specified by the store type.
|
ApplicationTabAppearance.FontStyle |
ApplicationTabAppearance.getFontStyle()
The font style the tab text should displayed with.
|
Icon |
ApplicationTabAppearance.getIcon()
The icon of the application tab that will be shown in tab button.
|
String |
ApplicationTabAppearance.getTitle()
The title of the application tab that would be shown in tab button.
|
Action |
BrowserNodeActionProvider.onClick(T node)
Provides an action that should be executed on browser click event on the specified node.
|
Modifier and Type | Method and Description |
---|---|
<T,C extends ApplicationTabConfiguration<?>> |
ApplicationService.openApplication(ApplicationType<T,C> type,
C configuration)
Opens a client application of specified
type with the given configuration in a new
tab and returns the tab control interface. |
Modifier and Type | Method and Description |
---|---|
String |
BrowserApplication.convertToScript(Object object)
Converts specified java object into JavaScript code.
|
Object |
BrowserApplication.evaluateScript(String script)
Executes given JavaScript code and evaluates return value.
|
Object |
BrowserApplication.evaluateScriptMethod(String methodIdentifier,
Object... arguments)
Generates JavaScript code for the specified JavaScript method call, executes it in currently opened document and evaluates the return value of the method call.
|
String |
BrowserApplication.getEngineVersion()
Returns the version string of the browser engine that is currently used by this BrowserApplication.
|
String |
BrowserApplication.getUrl()
Returns the url of this browser application or
null if no url requested yet. |
Modifier and Type | Method and Description |
---|---|
Language |
EditorialLanguageModel.getLanguage()
Returns the currently selected gui language.
|
Modifier and Type | Method and Description |
---|---|
void |
ModelListener.modelChanged(T model)
Inform the listener about changes in a registered model.
|
Modifier and Type | Method and Description |
---|---|
IDProvider |
SelectionModel.getElement()
Returns currently selected
IDProvider . |
Modifier and Type | Method and Description |
---|---|
static PreviewParameter |
PreviewParameter.Factory.from(Object requestOrSession)
Get the current
PreviewParameter instance from the request or session; returns null if there
isn't any. |
Object |
MPPWebControl.getParameter(String name)
Returns the current value of the specified preview parameter.
|
Object |
PreviewParameter.getParameter(String name)
Returns the parameter value for the specified name.
|
Object |
MPPWebControl.getTimeParameter()
Returns the current time the user has chosen using the preview timeline.
|
Date |
PreviewParameter.getTimeParameter()
Returns the configured preview time.
|
Modifier and Type | Method and Description |
---|---|
void |
MPPWebControl.setParameter(String name,
Object value)
Sets the current value of the specified preview parameter.
|
Modifier and Type | Method and Description |
---|---|
TransferHandler<T> |
ReportPlugin.createTransferHandler()
Factory method to create a transfer handler instance for use with this report plug-in.
|
EngineType |
ExternalPreviewItem.getBrowserType()
Returns the browser type to be used for opening an application tab,
or
null if the current default browser should be used. |
ReportItem<T> |
ReportPlugin.getDefaultItem()
Returns the default item of this report plugin, or
null if not supported. |
IDProvider |
ExternalPreviewContext.getElement()
Provides the element the toolbar context relates to.
|
Image<?> |
ReportPlugin.getIcon(boolean selected)
Returns a URL for the report's icon graphic that will be shown in the client.
|
Icon |
JavaClientExecutablePluginItem.getIcon(C context)
Provides the icon of this item.
|
Icon |
ExternalPreviewItem.getIcon(ExternalPreviewContext context)
Returns an icon representing this report plug-in, or
null if not available. |
String |
WebeditExecutablePluginItem.getIconPath(C context)
Provides the resource path to this item's icon.
|
Language |
ExternalPreviewContext.getLanguage()
Provides the contextual language of the current element.
|
Store.Type |
ExternalPreviewContext.getStoreType()
Provides the store type the toolbar context relates to.
|
String |
ExternalPreviewItem.getUrl(ExternalPreviewContext context)
Provides an url for the given
IDProvider . |
Modifier and Type | Method and Description |
---|---|
Icon |
JavaClientContextMenuItem.getIcon(ContextMenuContext context)
Returns the icon of this item or
null if this item has no icon. |
Modifier and Type | Method and Description |
---|---|
<A> A |
DataAccessPlugin.getAspect(DataAccessAspectType<A> type)
Look up a specific aspect that may be supported by this plug-in.
|
<A> A |
DataAccessSession.getAspect(SessionAspectType<A> type)
Look up a specific aspect that may be supported by this plug-in.
|
<A> A |
DataAccessSessionBuilder.getAspect(SessionBuilderAspectType<A> type)
Look up a specific aspect that may be supported by this builder.
|
<A> A |
DataStreamBuilder.getAspect(StreamBuilderAspectType<A> type)
Look up a specific aspect that may be supported by this builder.
|
String |
DataSnippetProvider.getExtract(D object,
Language language)
Provides the extract text being used as a long representation of the given object.
|
Image<?> |
DataAccessPlugin.getIcon()
Provides an icon to be shown when displaying this plug-in or information thereon.
|
Image<?> |
DataSnippetProvider.getIcon(D object)
Provides a type image resource for the given object or
null if no type image is available. |
Image<?> |
DataSnippetProvider.getThumbnail(D object,
Language language)
Provides a thumbnail image resource for the given object or
null if no thumbnail representation is available. |
Modifier and Type | Method and Description |
---|---|
String |
DataSnippetProvider.getExtract(D object,
Language language)
Provides the extract text being used as a long representation of the given object.
|
String |
DataSnippetProvider.getHeader(D object,
Language language)
Provides the header text being used as a short representation of the given object.
|
Image<?> |
DataSnippetProvider.getThumbnail(D object,
Language language)
Provides a thumbnail image resource for the given object or
null if no thumbnail representation is available. |
Modifier and Type | Method and Description |
---|---|
<A> A |
DataAccessAspectMap.get(DataAccessAspectType<A> type)
Get the correctly typed aspect for a type.
|
<A> A |
SessionAspectMap.get(SessionAspectType<A> type)
Get the correctly typed aspect for a type.
|
<A> A |
SessionBuilderAspectMap.get(SessionBuilderAspectType<A> type)
Get the correctly typed aspect for a type.
|
<A> A |
StreamBuilderAspectMap.get(StreamBuilderAspectType<A> type)
Get the correctly typed aspect for a type.
|
String |
DataAccessControlling.getAcquireAccessLabel()
Provides a label being used for an action to acquire access.
|
ReportItem<D> |
ReportItemsProviding.getClickItem()
Returns the click item of this report plugin.
|
ReportItem<D> |
ReportItemsProviding.Adapter.getClickItem()
Returns the click item of this report plugin.
|
Match |
RequestMatching.getMatch(String identifier,
Request request,
Language language)
Provides a match object for the given data object with respect to the handed request and language.
|
Image<?> |
Reporting.getReportIcon(boolean active)
Returns an image to be shown as icon for the report functionality.
|
Modifier and Type | Method and Description |
---|---|
void |
ValueReferencesJournal.addBrokenReferenceToElement(String uid,
IDProvider.UidType uidType,
String remote)
Deprecated.
since 5.2.200403 - use
ValueReferencesJournal.addReferenceToElement(String, IDProvider.UidType, String) instead |
void |
DataTemplating.ParameterSet.addMedium(String name,
Media media,
Resolution resolution)
Adds a medium as parameter.
|
default void |
ValueReferencesJournal.addReferenceToElement(String uid,
IDProvider.UidType uidType,
String remote)
Adds a reference to a FirstSpirit element to this journal.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.attribute(String name,
Object value)
Configures an attribute to be available in the generation context.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.language(Language language)
Configures the contextual
Language when requesting the URL. |
List<Parameter<?>> |
Updating.updateParameters(ParameterMap filter,
List<Parameter<?>> parameters)
Aspect providing a method to update DAP parameters.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.urlCreator(UrlCreator urlCreator)
Configures the url creator to be used in the current generation context.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.urlCreatorProvider(UrlCreatorProvider urlCreatorProvider)
Configures the provider of url creators in the current generation context.
|
Modifier and Type | Method and Description |
---|---|
T |
DataProvider.deserialize(String string)
Returns the object for the given
id or null if it
couldn't be found or is no longer available. |
<T> T |
ParameterMap.get(Parameter<T> parameter)
Returns the value to which the specified key is mapped,
or
null if this map contains no mapping for the key. |
T |
Parameter.getDefaultValue()
Returns the default value of this parameter.
|
String |
DataRenderer.getDescription(T object)
Returns an evaluated description for the given object or
null if a description is not available. |
String |
DataRenderer.getDetails(T object)
Returns an evaluated detail html snippet for the given object or
null if a detail is not available. |
Image<?> |
DataRenderer.getIcon(T object)
Provides the evaluated image resource for the given object or
null if an type image is not available. |
String |
ParameterText.getPlaceholder()
Returns the placeholder for the related textfield on client side.
|
Image<?> |
DataRenderer.getThumbnail(T object)
Provides the evaluated image resource for the given object or
null if an image representation is not
available. |
String |
DataProvider.serialize(T object)
Returns a string identifier for the given
object or null if this element
has no identifier. |
Modifier and Type | Method and Description |
---|---|
static ParameterBoolean |
Parameter.Factory.createBoolean(String name,
String label,
Boolean defaultValue)
Creates a new Boolean-typed parameter, using the given attributes.
|
static ParameterBoolean |
Parameter.Factory.createBoolean(String name,
String label,
Boolean defaultValue)
Creates a new Boolean-typed parameter, using the given attributes.
|
static ParameterSelect |
Parameter.Factory.createSelect(String name,
List<ParameterSelect.SelectItem> items,
String defaultValue)
Creates a new String-typed selection parameter, using the given attributes.
|
static ParameterSelect |
Parameter.Factory.createSelect(String name,
List<ParameterSelect.SelectItem> items,
String defaultValue)
Creates a new String-typed selection parameter, using the given attributes.
|
static ParameterText |
Parameter.Factory.createText(String name,
String placeholder,
String defaultValue)
Creates a new String-typed text input parameter, using the given attributes.
|
static ParameterText |
Parameter.Factory.createText(String name,
String placeholder,
String defaultValue)
Creates a new String-typed text input parameter, using the given attributes.
|
<T> void |
ParameterMap.put(Parameter<T> parameter,
T value)
Associates the specified value with the specified
Parameter in this map. |
Modifier and Type | Method and Description |
---|---|
Revision |
TimelineEntry.getRevision()
Returns the associated revision of this timeline entry.
|
Modifier and Type | Method and Description |
---|---|
IDProvider |
ToolbarContext.getElement()
Provides the element the toolbar context relates to.
|
Icon |
JavaClientToolbarItem.getIcon(ToolbarContext context)
Returns the icon of this item or
null if this item has no icon. |
Icon |
JavaClientToolbarItem.getPressedIcon(ToolbarContext context)
Returns the icon in pressed state for this item or
null if this item has no pressed icon. |
Icon |
JavaClientToolbarItem.getRollOverIcon(ToolbarContext context)
Returns an optional roll-over-icon of this item or
null if the normal icon
should be used. |
Icon |
ToggleableToolbarItem.getSelectedIcon(ToolbarContext context)
Returns the icon of this item in selected state or
null if the
pressed icon should be used. |
Store.Type |
ToolbarContext.getStoreType()
Provides the store type the toolbar context relates to.
|
String |
ToolbarContext.getSymbolicProjectName()
Provides the
symbolic name of a
remote project , if the element is not a local one. |
Modifier and Type | Method and Description |
---|---|
String |
SegmentProvider.getSegment()
Provides the query segment.
|
Modifier and Type | Method and Description |
---|---|
Pair<UUID,UUID> |
GidAgent.GidAdaptationResult.change(Entity entity)
The changes result pairs.A pair of newUUID<->oldUUI for a given entity.
|
Entity |
GidAgent.findEntity(String gid)
Finds a
Entity by its globalId (gid). |
Modifier and Type | Method and Description |
---|---|
T |
FeatureModel.FeatureReference.getElement()
Returns the concrete element this feature reference references to.
|
Modifier and Type | Method and Description |
---|---|
ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> |
FeatureInstallAgent.installFeature(FeatureFile featureFile,
LayerMapper layerMapper)
Starts a server side feature installation process for the given feature file.
|
Modifier and Type | Method and Description |
---|---|
T |
FormField.get()
Provides the current value of the field.
|
T |
RemoteFormField.get()
Provides the current value of the field.
|
GomFormElement |
InappropriateValueException.getForm()
Get the form element the value has been evaluated to be inappropriate for.
|
Long |
IdentifiedFormData.getId()
Get the form data's identification.
|
Language |
InappropriateValueException.getLanguage()
Get the language the value was going to be applied for.
|
Object |
InappropriateValueException.getValue()
Get the value that was going to be applied.
|
Modifier and Type | Method and Description |
---|---|
FormField<?> |
FormData.get(Language language,
String fieldName)
Provides a property container describing the field with the given name.
|
RemoteFormField<?> |
RemoteFormData.get(Language language,
String fieldName)
Provides a property container describing the field with the given name.
|
void |
FormField.set(Object value)
Set the value of this field.
|
Modifier and Type | Method and Description |
---|---|
UrlFactory |
UrlCreatorSpecification.createUrlFactory()
In case the specification provides a valid
UrlFactory class name for the property "urlfactory" this
will deliver a new instance of the specified class. |
String |
UrlCreatorSpecification.getLegacyClassName()
Legacy class name (for backward compatibility only).
|
String |
UrlCreator.getUrlPrefix()
Get the url prefix for absolute urls.
|
String |
PathLookup.lookupPath(IDProvider folder,
Language language,
TemplateSet templateSet)
Get the predefined path for the requested folder node or
null , if no predefined path is set. |
Modifier and Type | Method and Description |
---|---|
String |
FilenameFactory.getFilename(String url,
Media node,
Language language,
Resolution resolution)
Calculate filename for provided combination of node, language, and resolution.
|
String |
FilenameFactory.getFilename(String url,
Media node,
Language language,
Resolution resolution)
Calculate filename for provided combination of node, language, and resolution.
|
String |
UrlCreator.getFilename(String pluginName,
String filename,
String extension,
Language language)
The complete path (relative to content root) where the produced content of the provided
type will be stored. |
String |
UrlCreator.getFilename(String pluginName,
String filename,
String extension,
Language language)
The complete path (relative to content root) where the produced content of the provided
type will be stored. |
String |
UrlFactory.getUrl(Media node,
Language language,
Resolution resolution)
Calculate path to provided combination of node, language, and resolution.
|
String |
UrlCreator.getUrl(Media media,
Language language,
Resolution resolution,
int mode)
Get the url for the specified medium (for the specified language and resolution).
|
String |
UrlCreator.getUrl(Media media,
Language language,
Resolution resolution,
int mode)
Get the url for the specified medium (for the specified language and resolution).
|
String |
UrlCreator.getUrl(String pluginName,
String filename,
String extension,
Language language,
int mode)
Get the url for the provided combination of
type , name , extension , and language . |
String |
UrlCreator.getUrl(String pluginName,
String filename,
String extension,
Language language,
int mode)
Get the url for the provided combination of
type , name , extension , and language . |
String |
PathLookup.lookupPath(IDProvider folder,
Language language,
TemplateSet templateSet)
Get the predefined path for the requested folder node or
null , if no predefined path is set. |
Modifier and Type | Method and Description |
---|---|
Language |
JsonGenerationContext.getLanguage()
Returns the current
Language of this generation context. |
Modifier and Type | Method and Description |
---|---|
<T> JsonElement<?> |
JsonGenerationContext.handle(T object)
Entry point for the transformation of an object to a
JsonElement . |
<O> void |
JsonGenerationContext.setAttribute(String name,
O value)
Sets the given value in the this
context . |
Modifier and Type | Method and Description |
---|---|
static Object |
FileHandleSupport.deserializeFrom(FileHandle handle,
ClassLoader classLoader)
Deserializes a value from the given file handle according to the special serialization algorithm used by this
supporting type.
|
FileHandle |
FileHandle.getParent()
Get a handle on the parent file.
|
Modifier and Type | Method and Description |
---|---|
T |
FileSystem.obtain(String path)
Obtain a handle to the file or directory with the given path.
|
Modifier and Type | Method and Description |
---|---|
JsonElement<?> |
JsonObject.get(String key)
Get the value with the specified key.
|
T |
JsonElement.getValue()
Gets the contained value object.
|
JsonElement<?> |
JsonObject.resolve(String path)
Get the value for the specified path.
|
Modifier and Type | Method and Description |
---|---|
static JsonElement<?> |
JsonStringValue.ofNullable(Object value)
Returns a new
json element wrapping the given value , or
JsonNullValue.NULL if the provided value is null . |
Modifier and Type | Method and Description |
---|---|
FileSystem<? extends FileHandle> |
ServerEnvironment.getDataDir()
Returns the data directory of this environment.
|
IDProvider |
GadgetContext.getElement()
Delivers the store element the gadget belongs to.
|
JComponent |
Configuration.getGui(Frame applicationFrame)
Returns the configuration gui.
|
String |
WebServer.getInternalURL()
Returns the internal URL to this web server
|
FileSystem<? extends FileHandle> |
ServerEnvironment.getLogDir()
Returns the FileSystem as access to the log directory of this environment.
|
String |
Configuration.getParameter(String name)
Returns a specific parameter or
null if it's not available. |
Project |
ProjectEnvironment.getProject()
Returns project.
|
Class<? extends ServiceProxy<T>> |
Service.getProxyClass()
A service proxy is an optional, client-side service implementation.
|
Class<? extends T> |
Service.getServiceInterface()
Returns the service server / communication interface.
|
String |
WebEnvironment.getWebXml()
gets the content of current web.xml
|
Modifier and Type | Method and Description |
---|---|
ComponentDescriptor |
ModuleDescriptor.getComponentByName(String name)
Returns a component by its name or
null if it couldn't be found. |
String |
ComponentDescriptor.getComponentClass()
Returns
component class-name. |
String |
ComponentDescriptor.getConfiguration()
Returns configuration string.
|
String |
Descriptor.getConfiguration()
Returns configuration string.
|
String |
ComponentDescriptor.getConfigurationClass()
Returns
configuration class-name. |
WebAppDescriptor.FilterDescriptor |
WebAppDescriptor.getWebDirFilter()
Returns
WebAppDescriptor.FilterDescriptor instance based on xml filter definition if specified, or null if not. |
Modifier and Type | Method and Description |
---|---|
ComponentDescriptor |
ModuleDescriptor.getComponentByName(String name)
Returns a component by its name or
null if it couldn't be found. |
Modifier and Type | Method and Description |
---|---|
D |
ScheduleTaskApplication.createData()
Create a new custom data container for storing application specific configuration information.
|
<A> A |
ScheduleTaskApplication.getAspect(ApplicationAspectType<A> type)
Look up a specific aspect that may be supported by this application.
|
<A> A |
ScheduleTaskControl.getAspect(ScheduleTaskAspectType<A> type)
Provides aspects of the underlying task.
|
D |
ScheduleTaskForm.ScheduleTaskConfiguration.getCustomData()
Provides a container on custom data stored with the task.
|
String |
ScheduleTaskControl.getDescription()
Provides a description of the task.
|
String |
ScheduleTaskForm.ScheduleTaskConfiguration.getDescription()
Provides a description of the task.
|
String |
ScheduleTaskApplication.getDescription(Locale locale)
Provides a description for this application, preferably respecting the given locale.
|
Modifier and Type | Method and Description |
---|---|
void |
ScheduleTaskExecutor.execute(ScheduleTaskControl control,
D customData,
ScheduleTaskExecutionContext executionContext)
Execute with the given task information in the provided context.
|
void |
ScheduleTaskExecutor.validate(ScheduleTaskControl control,
D customData,
ScheduleTaskExecutionContext executionContext)
Validate with the given task information in the provided context.
|
Modifier and Type | Method and Description |
---|---|
IDProvider |
FileEntry.getElement(BaseContext context,
boolean release)
Provides the element this file is based upon with respect to the given context.
|
String |
FileEntry.getElementUid()
Provides the UID of the element, this file is based upon.
|
IDProvider.UidType |
FileEntry.getElementUidType()
Provides the UID-Type of the element, this file is based upon.
|
Object |
JobAgent.getVariable(String name)
Gets the variable value stored by the given name.
|
Modifier and Type | Method and Description |
---|---|
void |
JobAgent.setVariable(String name,
Object value)
Sets the variable of the given name to the defined value.
|
void |
SettingsAgent.store(String name,
Serializable value)
Store some setting value by the given name.
|
Modifier and Type | Method and Description |
---|---|
<A> A |
ApplicationAspectMap.get(ApplicationAspectType<A> type)
Get the correctly typed aspect for a type.
|
Modifier and Type | Method and Description |
---|---|
MaintenanceModeTask.MaintenanceStage |
MaintenanceModeInfo.getCurrentStage()
A maintenance mode task consists of up to five stages, from an initial preparation
period up to activating the actual maintenance mode.
|
Modifier and Type | Method and Description |
---|---|
String |
ApplicationPlugin.getDescription()
A description for the application, or
null . |
Modifier and Type | Method and Description |
---|---|
<T> T |
ExifValue.format(ExifData exifData,
FormField<?> formField,
GomFormElement form)
Format the given
ExifData . |
C |
ExifValueFormatter.ComplexExifValueFormatter.format(int tagHex,
ExifData exifData,
FormField<?> formField,
GomFormElement form)
This method formats a complex object to produce a value of type T.
|
T |
ExifValueFormatter.format(Object value,
FormField<?> formField)
This method formats a object to produce a value of type T.
|
Modifier and Type | Method and Description |
---|---|
<T> T |
ExifValue.format(ExifData exifData,
FormField<?> formField,
GomFormElement form)
Format the given
ExifData . |
<T> T |
ExifValue.format(ExifData exifData,
FormField<?> formField,
GomFormElement form)
Format the given
ExifData . |
<T> T |
ExifValue.format(ExifData exifData,
FormField<?> formField,
GomFormElement form)
Format the given
ExifData . |
C |
ExifValueFormatter.ComplexExifValueFormatter.format(int tagHex,
ExifData exifData,
FormField<?> formField,
GomFormElement form)
This method formats a complex object to produce a value of type T.
|
C |
ExifValueFormatter.ComplexExifValueFormatter.format(int tagHex,
ExifData exifData,
FormField<?> formField,
GomFormElement form)
This method formats a complex object to produce a value of type T.
|
C |
ExifValueFormatter.ComplexExifValueFormatter.format(int tagHex,
ExifData exifData,
FormField<?> formField,
GomFormElement form)
This method formats a complex object to produce a value of type T.
|
Modifier and Type | Method and Description |
---|---|
String |
MimeType.getExtension()
Get the associated filename extension.
|
Constructor and Description |
---|
ModuleException(String message,
Throwable cause)
Creates a module exception with the given detail message and cause.
|
Modifier and Type | Method and Description |
---|---|
<E> E |
DeployTargetFactory.createEditorFactory(Class<E> type,
DeployTask deployTask,
T deployTarget)
Create a gui factory of a specified type.
|
<E> E |
ScheduleTaskFactory.createEditorFactory(Class<E> type,
T task)
Create a gui factory of a specified type.
|
Collection<ScheduleEntry> |
ScheduleWizard.getResult()
Display wizard dialog and create one or more schedule entries.
|
Modifier and Type | Method and Description |
---|---|
Group |
GroupRoot.getGroupById(String id)
Returns the first occurrence of a group with the given id or
null ifno group exists with the given id. |
String |
User.getLogin()
Returns the login of this user or
null if not specified. |
Group |
Group.getParent()
Returns the parent group of this group or
null if this group is the root group |
char[] |
User.getPassword()
Returns the password of this user or
null if not specified |
String |
User.getRealname()
Returns the realname of this user or
null if not specified |
User |
Users.getUserByLogin(String login)
Returns the user specified by the given
login or null if no user exists with thegiven login. |
Users |
GroupRoot.getUsers()
Returns the users model object if defined for this
|
Modifier and Type | Method and Description |
---|---|
DirContext |
PermissionServiceScriptContext.getLdapContext()
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. |
Users |
PermissionServiceScriptContext.getUsers()
Returns the users model representing the belonging users.xml file specified by the param "DOCUMENT_NAME.users" in service.ini or
null if no users xmlfile is specified. |
Modifier and Type | Method and Description |
---|---|
TNode<I> |
TNode.getParent()
Returns parent object and
null for root elements without parent. |
Object |
TNode.getProperty(String name)
Returns a user defined property;
null for unknown properties. |
String |
TNodeService.getProviderClass(String providerName)
Returns the provider class name for the specified provider
|
Modifier and Type | Method and Description |
---|---|
R |
TNodeProvider.createRequest(IDProvider element,
Map<String,String> properties)
Creates a request object.
|
R |
TNodeProvider.createRequest(UserService userService,
Map<String,String> properties)
Creates a request object.
|
String |
TNode.getLabel(Locale locale)
Returns language specific label.
|
Modifier and Type | Method and Description |
---|---|
TNode |
TNodesEditorValue.getNode(String id)
Returns the node with the given
id or null . |
Modifier and Type | Method and Description |
---|---|
RevisionOperation<?> |
RevisionMetaData.getOperation()
Returns the revision operation.
|
Modifier and Type | Method and Description |
---|---|
List<Revision> |
HistoryProvider.getHistory(Date before,
Date after,
int maxCount,
Filter<Revision> filter)
Returns a list of revisions of this store element in descending order.
|
Modifier and Type | Method and Description |
---|---|
PageFolder |
WebeditStoreMappingPlugin.requestMappedFolder(SiteStoreFolder folder)
Returns the pagestore folder mapped to given
folder or null if there is no mapped folder
(so the WebClient isn't responsible for the page-store structure). |
Modifier and Type | Method and Description |
---|---|
PropertiesTransportOptions.ProjectPropertyType |
PropertyTypeExportInfo.getPropertyType()
Retrieves the
PropertiesTransportOptions.ProjectPropertyType of this element or null for fs meta files in global directory |
Modifier and Type | Method and Description |
---|---|
List<FeatureError> |
SyncOperationException.getErrors(FeatureError.Level level)
Returns a list of import errors.
|
List<FeatureError> |
SyncOperationException.getGlobalErrors(FeatureError.Level level)
Returns a list of global import errors.
|
Modifier and Type | Method and Description |
---|---|
ImportElementInfo |
ImportElementInfo.getParent()
Provides an information container on this element's parent.
|
Modifier and Type | Method and Description |
---|---|
ReleaseOperation |
ReleaseOperation.dependentReleaseType(IDProvider.DependentReleaseType dependentReleaseType)
The dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see
IDProvider.DependentReleaseType for details). |
void |
SaveOperation.setComment(String comment)
Defines the comment to be used for saving.
|
ReleaseOperation |
ReleaseOperation.withComment(String comment)
The release comment, may be
null . |
Modifier and Type | Method and Description |
---|---|
Image<?> |
SnippetProvider.getThumbnail(Language language)
Get the evaluated image for the given language.
|
Modifier and Type | Method and Description |
---|---|
String |
SnippetProvider.getExtract(Language language)
Get the evaluated header snippet presentation for the given language.
|
String |
SnippetProvider.getHeader(Language language)
Get the evaluated header snippet presentation for the given language.
|
Image<?> |
SnippetProvider.getThumbnail(Language language)
Get the evaluated image for the given language.
|
Modifier and Type | Method and Description |
---|---|
String |
LayerMapper.MappingContext.getSourceLayer()
|
Modifier and Type | Method and Description |
---|---|
GadgetIdentifier |
GadgetIdentifier.getInnerNode()
Get the inner node of a hierarchical identifier.
|
Language |
GadgetIdentifier.getLanguage()
Get the language this identifier was created for.
|
Modifier and Type | Method and Description |
---|---|
String |
Labelable.getLabel()
Gets the label of this component.
|
Object |
PropertyProcessing.getProperty(String name)
Get the value for the property having the given
name . |
T |
ValueHolder.getValue()
Get the current value stored by this value holder.
|
Modifier and Type | Method and Description |
---|---|
void |
ChangeManaging.replaceValue(T value)
Proposes a change to replace the currently set value with the given one.
|
void |
ValueHolder.setValue(T value)
Set the given value to be stored by this value holder.
|
Modifier and Type | Method and Description |
---|---|
void |
SwingFocusable.Handler.focusOn(JComponent component)
Sets the swing focus to the given component.
|
Modifier and Type | Method and Description |
---|---|
boolean |
SequencesHighlightable.highlightSequences(String regExp)
Highlights all matching sequences.
|
Modifier and Type | Method and Description |
---|---|
String |
SelectStoreElementOperation.Selection.getRemoteProjectName()
The symbolic name of the remote project the element belongs to.
|
Resolution |
SelectStoreElementOperation.Selection.getResolution()
The resolution chosen for a picture element, if applicable.
|
Modifier and Type | Method and Description |
---|---|
ProjectOptions |
SelectStoreElementOperation.addProject(String remoteProjectName)
Adds the named project as selection source.
|
void |
SelectStoreElementOperation.setPreselection(String projectName,
IDProvider element,
Resolution resolution)
Sets a preselection.
|
void |
SelectStoreElementOperation.setPreselection(String projectName,
IDProvider element,
Resolution resolution)
Sets a preselection.
|
Modifier and Type | Method and Description |
---|---|
boolean |
ValidatorHost.Validator.accept(CommodityContainer commodities,
Point location)
Validate a list of commodities.
|
void |
HandlerHost.Handler.handle(CommodityContainer commodities,
Point location)
Handle the given transfers.
|
Modifier and Type | Method and Description |
---|---|
Monoglot |
SwingGadgetContext.getMonoglot()
Provides the language to be used for monoglot child forms.
|
Modifier and Type | Method and Description |
---|---|
FormData |
ShowFormDialogOperation.perform(Form form,
List<Language> languages)
Show a form based on the given structural definition and return the form's result.
|
RequestOperation.Answer |
RequestOperation.perform(String question)
Asks the given question, returning the selected answer.
|
String |
OpenMergeDialogOperation.perform(String originalText,
String modifiedText)
Opens a differential view on the original and modified texts.
|
Modifier and Type | Method and Description |
---|---|
void |
JavaClientDisplayElementConfigurator.configureFrom(EventObject event)
Configure from a event object.
|
void |
ShowFormDialogOperation.setContextElement(IDProvider element)
Store element providing the context in which the form is displayed.
|
void |
ShowFormDialogOperation.setFormData(FormData data)
Set data to be loaded initially to the form.
|
<T> void |
ShowReportOperation.setParameter(Parameter<T> parameter,
T value)
Specifies a filter parameter value of the target report plugin.
|
void |
ShowFormDialogOperation.setPreselectedLanguage(Language language)
Sets a preselected language
|
Modifier and Type | Method and Description |
---|---|
static Connection |
ConnectionExtractor.extractConnectionFromRequest(HttpServletRequest request)
Extracts the current established
Connection to the FirstSpirit server from
an HttpServletRequest . |
Modifier and Type | Method and Description |
---|---|
<T,A> Set<A> |
DataAssociationAgent.associate(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> token,
T object)
Determines the associations for the specified object and association namespace.
|
Set<String> |
DataAssociationAgent.associate(String namespace,
Object object)
Determines the associations for the specified object and association namespace.
|
Set<A> |
DataAssociationHandler.associate(T object)
Returns a set of objects the given object is associated with.
|
<T,A> Set<String> |
DataAssociationAgent.associateIds(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> type,
T object)
Determines the associations for the specified object and association namespace.
|
A |
DataAssociationHandler.getAssociation(String id)
Gets the association belonging to the specified identifier, or
null if the
identifier is invalid or unknown. |
<T,A> A |
DataAssociationAgent.getFromId(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> token,
String id)
Determines the association object belonging to the specified namespace and association identifier.
|
Modifier and Type | Method and Description |
---|---|
String |
FSID.getElementType()
Returns the store-element type
|
String |
FSID.getLanguage()
Returns the language abbreviation, or
null if not specified. |
Object |
Preview.getParameter(String name)
Deprecated.
since 5.2, use
MPPWebControl.getParameter(String) instead |
Object |
ClientItemContext.getProperty(String name)
Returns the value of the given property, or
null if there is no such property. |
JavaScriptObject |
Preview.getTimeParameter()
Deprecated.
since 5.2, use
MPPWebControl.getTimeParameter() instead |
JavaScriptObject |
Preview.getWindow()
Returns a reference to the current window object of the preview frame.
|
Modifier and Type | Method and Description |
---|---|
ClientItem |
ClientItemContext.createItem(String iconUrl,
String title,
ClientItemPerformable handler)
Creates an action using the given parameters.
|
void |
Preview.reload(Element element)
Reloads the given element.
|
void |
Preview.rescan(Element element)
Searches in the specified element for new editor identifiers.
|
void |
Preview.setParameter(String name,
Object value)
Deprecated.
since 5.2, use
MPPWebControl.setParameter(String,Object) instead |
void |
Report.show(String report,
JavaScriptObject param,
boolean restart)
Opens the given report, sets parameters and maybe refreshs it.
|
Modifier and Type | Method and Description |
---|---|
String |
WebeditReportPlugin.getIcon(boolean selected)
Deprecated.
Returns a URL for the report's icon graphic that will be shown in the WebClient.
|
String |
ClientScriptProvidingItem.getIconPath(C context)
Provides the resource path to this item's icon.
|
String |
ClientScriptProvidingItem.getScript(C context)
Returns script code, that will be executed on client-side.
|
Modifier and Type | Method and Description |
---|---|
Language |
FocusAreaProviderContext.getLanguage()
Returns the data language the image has been associated with, if language-dependent.
|
Point2D.Double |
FocusArea.getOrientation()
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.
|
String |
FocusArea.getTitle()
A short text describing this focus point as title and tooltip text.
|
Modifier and Type | Method and Description |
---|---|
FocusAreaBuilder |
FocusAreaBuilder.bounds(Rectangle bounds)
Configures the bounds of the focus area preset based on absolute pixel coordinates inside the image,
where
0x0 represents the top-left corner. |
FocusAreaBuilder |
FocusAreaBuilder.orientationFromPoint(Point point)
Configures the orientation as directional 2D ratio vector, based on the given point of interest inside the image.
|
FocusAreaBuilder |
FocusAreaBuilder.orientationFromRatio(Point2D.Double ratio)
Configures 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.
|
FocusAreaBuilder |
FocusAreaBuilder.title(String title)
Configures the title describing the focus area.
|
Modifier and Type | Method and Description |
---|---|
EditorNode |
InlineEditContext.getEditorNode()
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. |
IDProvider |
InlineEditContext.getElement()
Get the contextual element for which the item has been requested.
|
String |
ClientScriptProvidingInlineEditItem.getIconPath(InlineEditContext context)
Returns a URL for the button item's icon graphic that will be shown in the WebClient.
|
String |
ExecutableInlineEditItem.getIconPath(InlineEditContext context)
Returns a URL for the button item's icon graphic that will be shown in the WebClient.
|
String |
ClientScriptProvidingInlineEditItem.getScript(InlineEditContext context)
Returns client script code that will be executed within the WebClient interface.
|
String |
InlineEditContext.getTag()
Returns the tag name of the targeted editor, or
null if no tag is available. |
Modifier and Type | Method and Description |
---|---|
IDProvider |
MediaManagementContext.getElement()
Get the contextual element.
|
String |
MediaManagementContext.getRemoteName()
Get the name of the contextual remote project configuration, or
null for the local project. |
String |
ClientScriptProvidingMediaManagementItem.getScript(MediaManagementContext context)
Returns script code, that will be executed on client-side.
|
Modifier and Type | Method and Description |
---|---|
T |
Parameter.cast(Object object)
Deprecated.
Cast the given object to the underlying type of this token.
|
<T> T |
ParameterMap.get(Parameter<T> parameter)
Deprecated.
Returns the value to which the specified key is mapped,
or
null if this map contains no mapping for the key. |
T |
Parameter.getDefaultValue()
Deprecated.
Returns the default value of this parameter.
|
String |
ReportPluginRenderer.getDescription(T object)
Deprecated.
Returns an evaluated description for the given object or
null if a description is not available. |
String |
ParameterText.getPlaceholder()
Deprecated.
Returns the placeholder for the related textfield on client side.
|
String |
ReportPluginRenderer.getThumbnail(T object)
Deprecated.
Provides the evaluated thumbnail URL for the given object or
null if an image representation is not
available. |
String |
ReportPluginRenderer.getTransferData(T object)
Deprecated.
Returns evaluated transfer data for the given object or
null if not available. |
Modifier and Type | Method and Description |
---|---|
T |
Parameter.cast(Object object)
Deprecated.
Cast the given object to the underlying type of this token.
|
<T> void |
ParameterMap.put(Parameter<T> parameter,
T value)
Deprecated.
Associates the specified value with the specified
Parameter in this map. |
Constructor and Description |
---|
ParameterBoolean(String name,
String label,
Boolean defaultValue)
Deprecated.
Creates a new Boolean-typed parameter, using the given attributes.
|
ParameterSelect(String name,
List<ParameterSelect.SelectItem> items,
String defaultValue)
Deprecated.
Creates a new String-typed selection parameter, using the given attributes.
|
ParameterText(String name,
String placeholder,
String defaultValue)
Deprecated.
Creates a new String-typed text input parameter, using the given attributes.
|
ParameterText(String name,
String placeholder,
String defaultValue)
Deprecated.
Creates a new String-typed text input parameter, using the given attributes.
|
Modifier and Type | Method and Description |
---|---|
WebeditColor |
WebeditStatusNote.getColor()
Returns the color associated with this status information.
|
Image<?> |
WebeditStatusNote.getIcon()
Returns the icon associated with this status information.
|
Language |
WebeditStatusNoteContext.getLanguage()
Provides the language the element is shown in.
|
String |
WebeditStatusNote.getText()
Returns the text of this status information.
|
Modifier and Type | Method and Description |
---|---|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.color(WebeditColor color)
Sets the color associated with the status note to create.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.icon(Image<?> icon)
Sets the icon associated with the status note to create.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.text(String text)
Sets the text of the status note to create.
|
Modifier and Type | Method and Description |
---|---|
String |
ExecutableToolbarActionsItem.getIconPath(ToolbarContext context)
Returns a URL for an icon graphic associated with this item.
|
Modifier and Type | Method and Description |
---|---|
T |
TranslationHost.Translator.translate(TranslationContext context,
T object)
Translates the given content object in the specified context.
|
Modifier and Type | Method and Description |
---|---|
String |
SelectOptionOperation.perform()
Performs this operation based on the previously configured settings,
and returns the value of the user selection if there is any.
|
Serializable |
ClientScriptOperation.perform(String script,
boolean asynchronous)
Executes JavaScript code on the client-side, while waiting for its completion.
|
Modifier and Type | Method and Description |
---|---|
ComparisonDialogOperation |
ComparisonDialogOperation.baseRevision(Revision revision)
Configures the base revision for the comparison dialog, displayed on the right side of the dialog.
|
ComparisonDialogOperation |
ComparisonDialogOperation.compareToRevision(Revision revision)
Configures the revision to compare the base revision to, displayed on the left side of the dialog.
|
ComparisonDialogOperation |
ComparisonDialogOperation.languages(List<Language> languages)
Configures the persistency languages to be shown in the comparison dialog.
|
NewSectionOperation |
NewSectionOperation.section(Section<?> section)
Contextual section after which the new section should be inserted.
|
Modifier and Type | Method and Description |
---|---|
S |
SerializingValueHolder.getSerializedValue()
Provide a serialized form of the currently stored value.
|
T |
SerializingValueHolder.getValue()
Get the current value stored by this value holder.
|
Modifier and Type | Method and Description |
---|---|
void |
SerializingValueHolder.setSerializedValue(S serialization)
Receive a serialized form as value to store.
|
void |
SerializingValueHolder.setValue(T value)
Set the given value to be stored by this value holder.
|
Modifier and Type | Method and Description |
---|---|
IDProvider |
WorkflowAgent.WorkflowProcessContext.getElement()
Returns the element this workflow process is related to or
null if this is aworkflow without context . |
Transition |
WorkflowAgent.WorkflowProcessContext.showActionDialog()
Shows an action gui dialog and returns the transition selected by the user.
|
Modifier and Type | Method and Description |
---|---|
void |
WorkflowAgent.WorkflowProcessContext.doTransition(Transition transition)
Process the next transition (one of
WorkflowAgent.WorkflowProcessContext.getTransitions() and completes this workflow processactivity. |
void |
WorkflowAgent.WorkflowProcessContext.gotoErrorState(String comment,
Throwable throwable)
Switch this task to the error state if it is defined.
|
void |
WorkflowAgent.WorkflowProcessContext.gotoErrorState(String comment,
Throwable throwable)
Switch this task to the error state if it is defined.
|
WorkflowAgent.WorkflowProcessContext |
WorkflowAgent.startWorkflow(Workflow workflow,
IDProvider element)
Starts a new workflow process which context is based on the given element (mode is
Task.Mode#ENTITY , if given element is a Dataset , otherwise Task.Mode#STORE_ELEMENT ). |
Modifier and Type | Method and Description |
---|---|
String |
WorkflowElement.getDescription()
Returns the description from this workflow-element.
|
String |
WorkflowElement.getDescription(Language language)
Returns the language dependant description from this workflow-element.
|
String |
WorkflowElement.getDisplayName(Language language)
Returns the language dependant name from this workflow-element.
|
WorkflowElement |
Transition.getSource()
Returns the workflow-element this transitions points FROM.
|
WorkflowElement |
Transition.getTarget()
Returns the workflow-element this transitions points TO.
|
Modifier and Type | Method and Description |
---|---|
Entity |
Session.find(EntityType type,
String uuid)
Returns the entity specififed by given EntityType and uuid string Important: Only supported if the schema is
temporal . |
Entity |
Session.find(EntityType type,
UUID uuid)
Returns the entity specififed by given EntityType and uuid.
|
Entity |
Session.find(KeyValue keyValue)
Return the entity with the given
keyValue . |
Entity |
Session.find(String entityTypeName,
Object... key)
Return the entity of type
entityTypeName with the id key . |
String |
Layer.testLayerParameters(ConnectionConfiguration config,
ClassLoader classLoader)
Tests the given configuration for this layer.
|
Modifier and Type | Method and Description |
---|---|
Constraint |
Select.getConstraint()
Return the constraint defined by this select.
|
Parameter |
Compare.getParameter()
Returns the parameter of this compare or
null . |
Modifier and Type | Method and Description |
---|---|
Attribute<?> |
EntityType.getAttribute(String name)
Return the attribute with the given
name . |
<T> Attribute<T> |
EntityType.getAttribute(String name,
Class<T> type)
Provides the attribute with the given name if it is of the requested type.
|
EntityType |
Schema.getEntityType(String name)
Return the entity type with the given name if one was defined in this schema else
null |
UUID |
Entity.getGid()
Returns the gid of this entity, if the session supports gids and the gid is already created, else
null . |
KeyValue |
Entity.getKeyValue()
Return the business key of this entity or
null if this entity is in state
NEW . |
ComposedAttribute<?> |
ComposedAttribute.getOpposedAttribute()
Return the opposed attribute defined in the target entity type.
|
EntityValidator |
EntityType.getValidator()
Provides a validator that enables to check an entity wrt. defined constraints.
|
<T> T |
Entity.getValue(Attribute<T> attribute)
Return the value of the given attribute or
null . |
Object |
Entity.getValue(String name)
Return the value of the
attribute specified by the given name . |
Modifier and Type | Method and Description |
---|---|
ComposedAttribute |
EntityType.createComposedAttribute(String name,
EntityType targetType,
ComposedAttribute.Relation type,
String opposedName)
Create a composed attribute with the given
name . |
boolean |
Attribute.isValid(T value)
Check if
value can be assigned to this attribute by using the
assigned validator Attribute.setValidator(de.espirit.or.schema.Validator<T>) . |
<T> void |
Entity.setValue(Attribute<T> attribute,
T value)
Set the value of the attribute
attribute to value . |
<T> void |
Entity.setValue(String name,
T value)
Set the value of the attribute with
name to the given value . |
Copyright © 2021 e-Spirit AG. All Rights Reserved. Build 5.2.210210