Modifier and Type | Method and Description |
---|---|
void |
ValueChangeNotifier.addChangeListener(de.espirit.common.event.ValueChangeListener listener)
Register a change listener.
|
void |
ValueChangeNotifier.removeChangeListener(de.espirit.common.event.ValueChangeListener listener)
Unregister a change listener.
|
Modifier and Type | Method and Description |
---|---|
V |
Dict.get(K key)
Returns the value mapped to the given key or
null if the given key isn't mapped. |
boolean |
Dict.isSet(K key)
Indicates whether the given key is set or not.
|
Modifier and Type | Method and Description |
---|---|
void |
Workflowable.delete()
Deletes this Workflowable.
|
Color |
Workflowable.getColor()
Get the color of the current state.
|
Context |
GenerationContext.getContext(String name)
Return a
Context by given name. |
Dataset |
GenerationContext.getDataset()
Returns the first
Dataset if this page is a content page, otherwise null . |
boolean |
GenerationContext.getDebugMode()
If debug mode is switched on java stack traces are included in the template log.
|
String |
GenerationContext.getEncoding()
Get file encoding.
|
JsonSettings |
GenerationContext.getJson()
Retrieves the json settings for this generation context.
|
Context |
GenerationContext.getPageContext()
Return the page context if set.
|
int |
GenerationContext.getPageIndex()
Provides the actual page index in case of multi-pages.
|
PageParams |
GenerationContext.getPageParams()
Get the page params of the page which is generated.
|
ScheduleContext |
GenerationContext.getScheduleContext()
Get the actual schedule context - this is only set when the generate process is initiated from the scheduler.
|
Date |
GenerationContext.getStartTime()
Start time of generate process.
|
Task |
Workflowable.getTask()
Get the possible assigned
Task or null. |
boolean |
Workflowable.hasTask()
Does this elements has a
Task assigned? |
boolean |
GenerationContext.isForceEditorIds()
Returns whether or not the editor identifier should be generated regardless of the current environment.
|
boolean |
GenerationContext.isHtmlMode()
Returns whether or not the context is currently generating html code (default is
true ). |
boolean |
GenerationContext.isPreviewRulesEvaluation()
Returns whether or not rules should be evaluated for the editor identifiers.
|
void |
Workflowable.removeTask()
Removes a already set Task.
|
void |
Workflowable.setColor(Color color)
Set a new color.
|
void |
GenerationContext.setDebugMode(boolean value)
If debug mode is switched on java stack traces are included in the template log.
|
void |
GenerationContext.setForceEditorIds(boolean value)
Tells the generation context whether or not the editor identifier should be generated regardless
of the current environment.
|
void |
GenerationContext.setHtmlMode(boolean value)
Tells the generation context whether or not html code will be generated currently.
|
void |
GenerationContext.setPreviewRulesEvaluation(boolean value)
Tells the generation context whether or not rules should be evaluated for the editor identifiers.
|
void |
Workflowable.setTask(Task task)
Set the given
Task . |
Modifier and Type | Method and Description |
---|---|
Long |
IdProvidingFormData.getId()
Get the current form data identifier.
|
Template |
IdProvidingFormData.getTemplate()
Returns the template for this form data instance if any.
|
Modifier and Type | Method and Description |
---|---|
void |
Permissions.addChangeListener(de.espirit.common.event.ValueChangeListener listener)
Adds a listener being informed on changes within these permissions.
|
void |
Table.addColumn(int index)
Adds a new column at the specified index.
|
void |
Table.addRow(int index)
Adds a new row at the specified index.
|
void |
DomElement.adopt(DomElement element)
Adopts all values from the given element.
|
void |
Table.deleteColumn(int column)
Deletes the column with the specified index
|
void |
Table.deleteRow(int row)
Deletes the row with the specified index
|
Element |
DomElement.diff(Element other)
Compute a difference between this element and the given one.
|
Element |
Table.diff(Element other)
Compute a difference between this element and the given one.
|
Element |
DomElement.get()
Returns root element.
|
Element |
Permissions.get()
Provides the permissions definition element.
|
IDProvider |
TargetReference.get()
Get the reference of the element currently set in this TargetReference.
|
List<String> |
Permissions.getActivityNames()
Provides a list of names for defined activities.
|
Set<String> |
Permissions.getAllowed(String operation)
Returns all allowed group IDs, if the permissions are not inherited.
|
Set<String> |
Permissions.getAllowedExplicit(String operation)
Returns all explicitly allowed group paths, if the permissions are not inherited.
|
String |
BinaryMedium.getAltText()
Returns the alt text.
|
List<Area> |
MappingMedium.getAreas()
Provides the areas defined for mapping to links.
|
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. |
int |
Table.getColumns()
Returns the numer of existing columns in this table
|
String |
BinaryMedium.getComment()
Gets a comment.
|
Content2 |
TargetReference.getContent()
|
Dataset |
DatasetContainer.getDataset()
The stored dataset - may be null
|
DocumentGroup |
TargetReference.getDocumentGroup()
|
Element |
Table.getDom()
Returns the element node of this table.
|
Referenceable |
BinaryMedium.getElement()
Returns the element of the binary medium.
|
String |
BinaryMedium.getElementName()
Returns the element name of the binary medium.
|
File |
BinaryMedium.getFile()
Returns the file of the binary medium.
|
MediaFolder |
BinaryMedium.getFolder()
Returns the folder of the binary medium.
|
Set<String> |
Permissions.getForbidden(String operation)
Returns all forbidden group IDs, if the permissions are not inherited.
|
Set<String> |
Permissions.getForbiddenExplicit(String operation)
Returns all explicitly forbidden group paths, if the permissions are not inherited.
|
UUID |
DatasetContainer.getGid()
The gid of the entity
|
String |
Permissions.getGroupsName()
Provides the name of groups.
|
int |
MappingMedium.getHeight()
Provides the height of the medium.
|
Media |
MappingMedium.getImage()
Provides the medium the map bases upon.
|
KeyValue |
DatasetContainer.getKey()
The key value of the entity.
|
String |
Option.getKey()
Get a textual key of this option.
|
String |
Label.getLabel(Language language)
Try getting a label in the following order:
the label for the specified language;
the label for the
fallback language ;
the value itself. |
String |
Label.getLabel(String lang)
Convenience method to get a label based on a language abbreviation.
|
Language |
BinaryMedium.getLanguage()
Returns the language of the binary medium.
|
Language |
DatasetContainer.getLanguage()
The language for which this value is stored.
|
Language |
TargetReference.getLanguage()
Get the language of the selected reference.
|
Media |
TargetReference.getMedia()
Returns a set medium if any or
null if reference is not a type of Media . |
Media |
BinaryMedium.getMedium()
Returns the medium of the binary medium.
|
de.espirit.common.event.SimpleValueChangeNotifier |
Permissions.getNotifier()
Provides a notifier on changes within these permissions.
|
Page |
TargetReference.getPage()
Returns a set page or null if referenced element is not type of
Page . |
PageRef |
TargetReference.getPageRef()
Returns a set page reference or
null if referenced element is not type of PageRef . |
Picture |
BinaryMedium.getPicture()
Returns the picture of the binary medium.
|
Priority |
Permissions.getPriority()
Provides the priority setting for this permissions.
|
String |
BinaryMedium.getRemoteName()
Returns the remote name.
|
String |
TargetReference.getRemoteSymName()
Return the symbolic remote project name set in the local remote project configuration.
|
Resolution |
MappingMedium.getResolution()
Provides the medium's resolution.
|
DefaultDomNode |
DomElement.getRoot()
Returns root node (
<DOM> ). |
int |
Table.getRows()
Returns the number of existing rows in this table.
|
Section<?> |
TargetReference.getSection()
Get the referenced section.
|
String |
TargetReference.getSectionName()
Return the name of the
Section if the referenced element is of type Section. |
Store.Type |
TargetReference.getStoreType()
Get the kind of
Store.Type for the selected item. |
String |
DatasetContainer.getTemplateUid()
The
uid of the template. |
BinaryMedium.Type |
BinaryMedium.getType()
Returns the type of this binary medium.
|
String |
TargetReference.getUid()
Retrieve the referenced element's unique id.
|
IDProvider.UidType |
TargetReference.getUidType()
Get the
IDProvider.UidType of the given element. |
Object |
Option.getValue()
Get the value of this option.
|
int |
MappingMedium.getWidth()
Provides the width of the medium.
|
boolean |
Option.ignore(Language language)
Indicates whether this
Option should be ignored and therefore hidden in the gui
for the provided language. |
boolean |
BinaryMedium.isEmpty()
Checks if this binary medium is empty.
|
boolean |
DatasetContainer.isEmpty()
Shortcut for
DatasetContainer.getDataset() == null. |
boolean |
DomElement.isEmpty()
Returns
true if this element has no content. |
boolean |
Permissions.isEmpty()
Indicates that no permissions are defined.
|
boolean |
Table.isEmpty()
Indicates whether this table is empty or not.
|
boolean |
TargetReference.isEmpty()
Tests if this
TargetReference currently has no element set. |
boolean |
Permissions.isInherited()
Indicates that permissions of this container are inherited.
|
Section<?> |
TargetReference.loadSection(Page page,
String sectionName)
Load a section of the given referenced page identified by its section name.
|
void |
DomElement.parseHtml(String html)
Sets the given
html . |
void |
Label.putLabel(Language language,
String label)
Set the label for the specified language.
|
void |
Label.putLabel(String lang,
String label)
Convenience method to put a label based on a language abbreviation.
|
void |
Permissions.removeChangeListener(de.espirit.common.event.ValueChangeListener listener)
Removes a listener.
|
void |
Table.replace(Table from)
Replaces this table with the given table.
|
void |
TargetReference.resetTo(IDProvider reference,
String remote)
Reset the reference and the remote information and infer settings for UID and UidType.
|
void |
DomElement.set(Element element)
Sets root element.
|
void |
Permissions.set(Element element)
Set the permission definition element.
|
void |
TargetReference.set(IDProvider reference)
Set a new element reference of type
IDProvider and infer settings for UID and UidType. |
void |
DomElement.set(String xml)
Sets the given xml.
|
void |
Permissions.setAllowed(String operation,
Collection<String> groups)
Sets the allowed groups for the given operation.
|
void |
BinaryMedium.setAltText(String altText)
Sets an alt text for the medium.
|
void |
MappingMedium.setAreas(List<? extends Area> areas)
Allows to define the areas mapping to links.
|
void |
BinaryMedium.setComment(String comment)
Sets a comment.
|
void |
Permissions.setConnection(Connection connection)
Sets the connection to be used for permissions.
|
void |
BinaryMedium.setElementName(String name)
Set the element name.
|
void |
BinaryMedium.setFolder(MediaFolder folder)
Sets the folder of the binary medium.
|
void |
Permissions.setForbidden(String operation,
Collection<String> groups)
Sets the forbidden groups for the given operation.
|
void |
Permissions.setInherited(boolean inherited)
Defines the permissions to be inherited.
|
void |
BinaryMedium.setMedium(Media medium)
Sets the medium of the binary medium.
|
void |
Permissions.setPriority(Priority priority)
Set the priorities for this permissions.
|
void |
BinaryMedium.setRemoteName(String remoteName)
Sets a remote name for the medium
|
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 |
MappingMedium.setResolution(Resolution resolution)
Define the resolution to be used for the medium
|
void |
TargetReference.setSection(Section<?> section)
Set the section to be referenced.
|
void |
TargetReference.setSectionName(String name)
Use this to set the section.
|
void |
TargetReference.setUid(String uid)
Set the Uid of the referenced element.
|
void |
TargetReference.setUidType(IDProvider.UidType type)
Set the
IDProvider.UidType of the referenced element. |
String |
DomElement.toText(boolean asHtml)
Returns html (
asHtml==true ) or plain text (asHtml==false ). |
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.
|
Modifier and Type | Method and Description |
---|---|
FormData |
Link.getFormData()
Gets the
formdata container for this link. |
Language |
Link.getLinkLanguage()
Provides the language the link is created for.
|
LinkTemplate |
Link.getTemplate()
Returns the link template this link is based on.
|
String |
Link.getText()
The display text.
|
void |
Link.setFormData(FormData formData)
Sets the given
formdata container for this link. |
void |
Link.setTemplate(LinkTemplate linkTemplate)
Switch the template - use with caution.
|
void |
Link.setText(String text)
Sets the text for this link.
|
Modifier and Type | Method and Description |
---|---|
void |
PackagePoolItem.addToPackage(Package pck)
Adds this node, all children and
referenced nodes which arePackagePoolItem s to the specified package. |
Set<de.espirit.firstspirit.storage.Contrast> |
IDProvider.contrastWith(IDProvider reference)
Contrast the element with another one.
|
void |
StoreElement.delete()
Deletes this storeelement.
|
void |
StoreElement.exportStoreElement(OutputStream out,
ExportHandler exportHandler)
Exports this storeelement as zip file to the given outputstream.
|
int |
PackagePoolItem.getChangeState()
Returns the change state of this PackagePoolItem either
PackagePoolItem.UNMODIFIED , PackagePoolItem.MODIFIED or PackagePoolItem.BLOCKED . -1 will be returned for items which aren't subscribed item's or if the state could not be established |
int |
StoreElement.getChildCount() |
int |
StoreElement.getChildIndex(StoreElement child) |
Listable<StoreElement> |
StoreElement.getChildren()
Get the element's direct children.
|
<T extends StoreElement> |
StoreElement.getChildren(Class<T> type)
Get the element's direct children that are instances of the given type.
|
<T extends StoreElement> |
StoreElement.getChildren(Class<T> type,
boolean recurse)
Get the element's children that are instances of the given type.
|
<T extends StoreElement> |
StoreElement.getChildren(Filter.TypedFilter<T> filter,
boolean recurse)
Get the element's children passing the given typed filter.
|
WorkflowPermission |
StoreElement.getCreateWorkflowPermission(Workflow workflow)
Return workflow permission object for the given workflow.
|
List<Principal> |
StoreElement.getDefinedPrincipalPermissions()
Returns a list of
Principal's for which
permissions are defined at this storeelement. |
String |
IDProvider.getDisplayName(Language language)
Return the display name (label) for the specified language - if no language specific label is defined for this
language the value for the master language is returned.
|
User |
StoreElement.getEditor() |
String |
StoreElement.getElementType() |
StoreElement |
StoreElement.getFirstChild()
Provides the first child node.
|
long |
IDProvider.getId()
Returns the unique ID of this IDProvider
|
ReferenceEntry[] |
StoreElement.getIncomingReferences()
Returns all incoming references of this
StoreElement . |
List<Principal> |
StoreElement.getInheritedPrincipalPermissions()
Returns a list of
Principal's for which
permissions are defined at this storelement including the inherited permissions on parent path. |
IDProvider |
IDProvider.getInRevision(Revision revision)
Get this element in the state of the given revision.
|
LanguageInfo |
IDProvider.getLanguageInfo(Language language)
Returns the
LanguageInfo node for the given language |
long |
StoreElement.getLastChanged() |
Long |
IDProvider.getLongID() |
FormData |
IDProvider.getMetaFormData()
Returns the
formdata container of this element or null if there is no meta data template defined for project. |
String |
StoreElement.getName() |
StoreElement |
StoreElement.getNextSibling()
Provides the next sibling store element.
|
ReferenceEntry[] |
StoreElement.getOutgoingReferences()
Returns all outgoing references of this
StoreElement . |
Package |
PackagePoolItem.getPackage()
Returns the
Package this item belongs to or null . |
String |
PackagePoolItem.getPackageName()
Returns the name of the package this item belongs to.
|
IDProvider |
IDProvider.getParent()
|
StoreElement |
StoreElement.getParent()
|
Permission |
StoreElement.getPermission()
Returns the permission object for the
current user
even if permission checking is turned off. |
Permission |
StoreElement.getPermission(Group group)
Returns the correct permission object even if permission checking is turned off.
|
Permission |
StoreElement.getPermission(User user)
Returns the correct permission object even if permission checking is turned off.
|
StoreElement |
StoreElement.getPreviousSibling()
Provides the previous store element.
|
Project |
StoreElement.getProject()
Returns the belonging project of this storeelement.
|
String |
StoreElement.getReferenceName()
Provided the element's reference name.
|
Set<ReferenceEntry> |
StoreElement.getReferences()
Returns current outgoing references of this store element.
|
User |
IDProvider.getReleasedBy()
The last user who released this node or
null if this node has never been released. |
Revision |
IDProvider.getReleaseRevision() |
int |
IDProvider.getReleaseStatus()
Returns the release state of this storeelement (
IDProvider.CHANGED or IDProvider.RELEASED or IDProvider.NEVER_RELEASED ) |
Revision |
IDProvider.getRevision() |
Store |
StoreElement.getStore()
Provides the store related to the element.
|
de.espirit.firstspirit.store.access.PermissionMap |
StoreElement.getTreePermission()
Return permissions combined from defined and inherited permissions for current user.
|
String |
IDProvider.getUid()
Returns the unique identifier of this
IDProvider if it has a unique identifier
otherwise throws an UnsupportedOperationException ! |
IDProvider.UidType |
IDProvider.getUidType()
Returns the unique identifier type of this
IDProvider if it has a unique identifier
otherwise throws an UnsupportedOperationException ! |
WorkflowPermission |
StoreElement.getWorkflowPermission(Workflow workflow)
Return workflow permission object for the given workflow.
|
WorkflowPermission[] |
StoreElement.getWorkflowPermissions()
Return all existing workflow permissions.
|
boolean |
StoreElement.getWriteLock()
A write lock is a flag to prevent changes e.g. while a workflow is active for this element.
|
boolean |
StoreElement.hasIncomingReferences()
Returns
true if this StoreElement has incoming references. |
boolean |
IDProvider.hasMeta()
Indicates that any meta data is set for this element.
|
boolean |
StoreElement.hasPermissions()
Indicates whether for this element permissions are defined or not.
|
boolean |
IDProvider.hasUid()
Returns
true if this IDProvider has a unique identifier like e.g. |
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.inheritWorkflowPermission()
Returns a
boolean state, whether the workflow permissions should be inherited for this StoreElement or not. |
boolean |
PackagePoolItem.isAddable(Package pck) |
boolean |
PackagePoolItem.isChangeable()
Checks if this PackagePoolItem is changeable.
|
boolean |
StoreElement.isDeleted()
Returns the state of deletion. true if element is deleted and false if its not
|
boolean |
StoreElement.isExportSupported()
Checks if the element supports export.
|
boolean |
StoreElement.isFolder()
Checks if the element is a folder.
|
boolean |
StoreElement.isImportSupported()
Checks if the element supports import.
|
boolean |
IDProvider.isInReleaseStore()
Checks if this storeelement exists in the release representation of the belonging
store . |
boolean |
StoreElement.isLocked()
Checks if this node is locked by this session.
|
boolean |
StoreElement.isLockedOnServer(boolean allSessions)
Checks if this storeelement is locked on the server.
|
boolean |
StoreElement.isLockSupported()
Check this before using any lock method.
|
boolean |
PackagePoolItem.isPackageItem() |
boolean |
StoreElement.isPermissionSupported()
Indicates whether this element supports permissions or not.
|
boolean |
IDProvider.isReleased()
Returns
true if this element is currently released (not changed). |
boolean |
IDProvider.isReleaseSupported()
Indicates wether this element supports
IDProvider.release(boolean) or not. |
boolean |
PackagePoolItem.isSubscribedItem() |
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 . |
boolean |
StoreElement.isWorkflowSupported()
Checks if a workflow might be executed at the element.
|
void |
IDProvider.moveChild(IDProvider child)
Insert child at last position.
|
void |
IDProvider.moveChild(IDProvider child,
int nextSiblingIndex)
Insert child at index position.
|
void |
StoreElement.refresh()
Refreshes this element if there is a newer version on the server.
|
void |
IDProvider.release()
Release this node and all childs.
|
void |
IDProvider.release(boolean releaseChilds)
Release this node and optionally all childs
|
void |
StoreElement.removeAllWorkflowPermissions() |
void |
StoreElement.removeChild(StoreElement child)
Removes the given child from this element.
|
void |
PackagePoolItem.removeFromPackage(Package pck)
Removes this node, all children and
nodes referencing this nodes which are PackagePoolItems's from the specified package. |
void |
StoreElement.removePermission(Group group)
Removes the permission object for a given group.
|
void |
StoreElement.removePermission(User user)
Removes the permission object for the given user.
|
void |
StoreElement.removePermission(User[] users)
Removes the permission object for several given users.
|
void |
StoreElement.removeWorkflowPermission(Workflow workflow) |
void |
StoreElement.replaceChild(StoreElement oldChild,
StoreElement newChild)
Replaces an element's child by another child.
|
void |
IDProvider.revert(Revision revision,
boolean recursive,
EnumSet<IDProvider.RevertType> ignoreRevertTypes)
Reverts this store element to the given FSRevision.
|
void |
StoreElement.save()
Saves the node and all childs, shortcut for
save(null, true) . |
void |
StoreElement.save(String comment)
Saves the node and all childs.
|
void |
StoreElement.save(String comment,
boolean saveChilds)
Saves this node.
|
void |
PackagePoolItem.setChangeState(int changeState)
Sets the change state for this PackagePoolItem.
|
void |
IDProvider.setDisplayName(Language language,
String displayName)
Sets the display name (label) for the specified language.
|
void |
StoreElement.setInheritWorkflowPermission(boolean inherit)
Sets a
boolean flag to enable or disable the inheritance of workflow permissions for this StoreElement . |
void |
StoreElement.setLock(boolean lock)
Lock or unlock this element and all children.
|
void |
StoreElement.setLock(boolean lock,
boolean recursive)
Lock or unlock this element, if
recursive == true all children are also (un)locked. |
void |
IDProvider.setMetaFormData(FormData formData)
Sets the given
formdata container of this element. |
void |
StoreElement.setPermission(Group group,
Permission permission)
Set the defined permission for the given group.
|
void |
StoreElement.setPermission(User[] users,
Permission permission)
Set the defined permission for several users.
|
void |
StoreElement.setPermission(User user,
Permission permission)
Set the defined permission for the given user.
|
void |
IDProvider.setUid(String uid)
Sets the unique identifier.
|
void |
StoreElement.setWorkflowPermission(WorkflowPermission permission) |
void |
StoreElement.setWorkflowPermissions(WorkflowPermission[] permissions) |
void |
StoreElement.setWriteLock(boolean lock)
A write lock is a flag to prevent changes e.g. while a workflow is active for this element.
|
String |
StoreElement.toXml()
Creates the xml representation of the node with all children but without indentation and line breaks.
|
String |
StoreElement.toXml(boolean includeChilds)
Creates the xml representation with or without all children depending on the given parameter.
|
String |
StoreElement.toXml(boolean includeChildren,
boolean prettyPrinting)
Creates the xml representation with or without children, line breaks and indentation depending on the given parameters.
|
Modifier and Type | Method and Description |
---|---|
void |
DataProvider.clearCachedData()
Clear any cache holding the data object.
|
void |
Section.excludeFromOutput(Language language)
Excludes this section from the output for the given language.
|
FormData |
DataProvider.getFormData()
Gets the
formdata container of this element. |
long[] |
Section.getLifespan()
Get the lifespan of the current section if there is one defined.
|
String |
Section.getName()
Get the name of the section
|
T |
Section.getTemplate()
Returns the template of this element.
|
void |
Section.includeInOutput(Language language)
Includes this section in the output for the given language.
|
boolean |
Section.isInLifespan()
Indicates whether the
actual time is included in the lifespan of this section. |
boolean |
Section.isInLifespan(long time)
Indicates whether the given timestamp is included in the lifespan of this section.
|
boolean |
Section.isInOutputIncluded(Language language)
Checks if this section is included in the output
for the given language.
|
boolean |
Section.isReference()
Is this a reference section?
|
void |
Section.removeLifespan()
Remove lifespan of the current section.
|
void |
DataProvider.setFormData(FormData formData)
Sets the given
formdata container of this element. |
void |
Section.setLifespan(long from,
long to)
Set the lifespan of the current section.
|
void |
Section.setName(String name)
Set the name of a section
|
void |
Section.setTemplate(T template)
Set the template for this section.
|
Modifier and Type | Method and Description |
---|---|
String |
PageRef.getFilename()
Returns a filename suggestions which may be used for creating urls.
|
Modifier and Type | Method and Description |
---|---|
T |
TemplateProvider.getTemplate()
Returns the template of this element.
|
Modifier and Type | Method and Description |
---|---|
Index.Record |
Index.create(String identifier)
Create a record from the given identifier.
|
Catalog.Card |
Catalog.create(Template template,
FormData formData)
Factory method to create a new card based on the given template and form data.
|
<T> DataAccessSession<T> |
Index.createSession(SpecialistsBroker broker)
Creates a session based on the definition and configuration of the underlying source.
|
default Optional<Catalog.Card> |
Catalog.find(UUID uuid)
Search for a card with the specified unique identifier.
|
UUID |
Catalog.Card.getId()
Provides the unique identifier of this card.
|
String |
Index.Record.getIdentifier()
The identifier of this record.
|
List<String> |
IndexAccessor.getIdentifiers()
Provides the list of identifiers as entered in the index component.
|
FormData |
Catalog.Card.getItem()
Provides the item referred to with this card.
|
List<DataSnippet> |
CatalogAccessor.getSnippets()
Provides a list of snippets corresponding to the entries of the original catalog component.
|
List<DataSnippet> |
IndexAccessor.getSnippets()
Provides a list of snippets corresponding to the entries of the original index component.
|
Template |
Catalog.Card.getTemplate()
Provides the template this card's item is based upon.
|
List<?> |
IndexAccessor.getValues()
Provides the list of values corresponding to the entries of the original index component.
|
boolean |
IndexAccessor.isEmpty()
Indicates the index to be empty, i.e., it does not contain any entry.
|
void |
Catalog.Card.loadItem(FormData formData)
Loads the data from the given item into this card.
|
Modifier and Type | Method and Description |
---|---|
FormField<?> |
FormData.get(Language language,
String fieldName)
Provides a property container describing the field with the given name.
|
GomEditorProvider |
FormData.getForm()
Provides the form definition.
|
Long |
IdentifiedFormData.getId()
Get the form data's identification.
|
FormDataProducer |
FormDataList.getProducer()
Provides a producer able to create form-data based on the data-source definition for this editor.
|
Modifier and Type | Method and Description |
---|---|
int |
JsonSettings.getDataRenderDepth()
Returns the set data render depth.
|
String |
JsonSettings.getFormatVersion()
Returns the json format setting.
|
boolean |
JsonSettings.isMetaDataRendering()
Returns the meta
FormData rendering setting. |
boolean |
JsonSettings.isPrettyPrinting()
Returns the prettyPrinting setting.
|
boolean |
JsonSettings.isSectionTemplateRendering()
Returns the section template rendering setting.
|
JsonSettings |
JsonSettings.setDataRenderDepth(int dataRenderDepth)
Sets the render depth of linked
Dataset s in the JsonOutput . |
JsonSettings |
JsonSettings.setFormatVersion(String formatVersion)
Sets the json format version for rendering.
|
JsonSettings |
JsonSettings.setMetaDataRendering(boolean metaDataRendering)
Turns the meta data for elements on or off.
|
JsonSettings |
JsonSettings.setPrettyPrinting(boolean value)
Turns the prettyPrinting setting on or off.
|
JsonSettings |
JsonSettings.setSectionTemplateRendering(boolean sectionTemplateRendering)
Turns the template rendering for
Section type elements on or off. |
Modifier and Type | Method and Description |
---|---|
ElementProvider<Revision> |
HistoryProvider.asRevisionProvider()
Return an
ElementProvider on this HistoryProvider. |
List<Revision> |
HistoryProvider.getHistory()
Returns the revisions history of this storeelement, starting with the newest revision descending to
the initial revision.
|
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 |
---|---|
Entity |
Entity.copy()
Copies this entity.
|
void |
Entity.copyFrom(Entity entity)
Copy the values of the given
entity to this entity. |
Collection<String> |
Entity.getAttributeNames()
Return a collection of the attributes declared for this entity.
|
EntityType |
Entity.getEntityType()
Return the type of this entity.
|
UUID |
Entity.getGid()
Returns the gid of this entity, if the session supports gids and the gid is already created, else
null . |
Identifier |
Entity.getIdentifier()
Return the identifier of this entity.
|
KeyValue |
Entity.getKeyValue()
Return the business key of this entity or
null if this entity is in state
NEW . |
List<Entity> |
Entity.getList(String name)
Return the value of the specified list attribute ("to N relation").
|
Session |
Entity.getSession()
Returns the session which was used to create or retrieve this entity.
|
Entity.PersistentState |
Entity.getState()
Return the
state of this entity. |
<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 . |
boolean |
Entity.isReleased()
Return
true if this entity is released else false . |
boolean |
Entity.isValid()
Return
true if this entity is valid else false . |
void |
Entity.refresh()
Refresh the content of this entity with the one stored in the database.
|
void |
Entity.rollback()
Revert all attribute changes.
|
void |
Entity.rollbackWithRelations()
Reset all changes, including relations (i.e. this may rollback delete operations of entities which has been set
in relation to this entity).
|
<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