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 |
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.
|
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 . |
Modifier and Type | Field and Description |
---|---|
String |
MailHeader.replyTo
A semicolon-separated list of reply-recipients.
|
String |
MailHeader.sender
The sender of the mail.
|
Modifier and Type | Method and Description |
---|---|
EditorValue<?> |
EditorService.createEditorValue(String tagName)
Deprecated.
|
GomElement |
EditorService.createGomElement(String tagName)
Deprecated.
|
<T> T |
EditorService.createGuiEditor(Class<T> type,
String tagName)
Deprecated.
|
String |
TransitionParameters.getComment()
Get task comment.
|
Connection |
Host.getConnection() |
Context |
GenerationContext.getContext(String name) |
Data |
TransitionParameters.getCustomData()
Deprecated.
since 5.0.207 use
TransitionParameters.getCustomFormData() |
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.
|
Editor<?> |
EditorService.getEditor(String tagName)
Deprecated.
|
IDProvider |
WorkflowContext.getElement()
Returns the element or
null for tasks with no context element. |
FileHandle |
GenerationContext.getFileHandle(String path) |
IDProvider |
GenerationContext.getNavigationContext()
Returns the origin node for relative urls.
|
Context |
GenerationContext.getPageContext() |
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() |
Object |
ReferenceEntry.getReferencedObject() |
String |
ReferenceEntry.getReferenceString() |
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 . |
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() |
ScheduleContext |
GenerationContext.getScheduleContext()
Get the actual schedule context - this is only set when the generate process is initiated from the scheduler.
|
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() |
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) |
Transition |
TransitionParameters.getTransition()
Return selected transition.
|
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 |
---|---|
void |
UserService.exportStoreElements(OutputStream out,
StoreElement[] elements,
ExportHandler exportHandler) |
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.
|
void |
GenerationContext.mediaReferenced(Media media,
Language language,
Resolution resolution) |
void |
GenerationContext.mediaReferenced(Media media,
Language language,
Resolution resolution) |
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)
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()
Get the form definition.
|
TableTemplate |
TableTemplateProvider.getTableTemplate()
Get the table template for this value based on the form's
definition.
|
Object |
EditorValue.getValue()
Deprecated.
since 4.0.17 - use specific attribute accessor
|
Object |
EditorValue.getValue(Language language)
Deprecated.
since 4.0.17 - use specific attribute accessor
|
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 element reference
|
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() |
DocumentGroup |
TargetReference.getDocumentGroup()
|
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()
The id of the section or
null |
KeyValue |
DatasetContainer.getKey()
The key value of the entity.
|
Media |
ElementReference.getMedia() |
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() |
PageRef |
TargetReference.getPageRef()
Returns a set page reference or
null if referenced element is not type of PageRef . |
DomNode |
DomNode.getParent()
Returns parent node, maybe
null (e.g. if this node is the 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() |
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)
Returns a short content text of this table cell
|
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 |
ElementReference.set(Referenceable reference) |
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) |
void |
ElementReference.setSection(Section<?> section) |
void |
TargetReference.setSection(Section<?> section)
Set the section to be referenced.
|
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.
|
LinkTemplateFolder |
Link.getType()
Deprecated.
since 5.0.414, no replacement
|
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. |
Project |
Package.getPublisher()
Gets the publisher
Project of this package. |
Project |
Subscription.getSubscriber()
Returns the subscriber
Project of this subscription. |
TemplatePackage |
ContentPackage.getTemplatePackage()
Returns the TemplatePackage on which this ContentPackage
is dependent or
null if no dependent TemplatePackage
existing for this ContentPackage. |
Modifier and Type | Method and Description |
---|---|
static MetadataDescription.MetadataType |
MetadataDescription.MetadataType.fromType(Class<? extends IDProvider> type)
Returns the related MetadataType for the specified IDProvider type, or null.
|
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 |
MetadataDescription.getDisplayName(Language language)
Gets display name for the given 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 project language with the specified abbreviation.
|
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()
|
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.
|
PageTemplate |
Project.getWebeditDefaultTemplate()
Returns the default page template that should be used in webedit,
or
null if not specified. |
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.
|
Revision |
Project.createTaggedRevision(String tag,
String comment)
Deprecated.
since 4.2.400 - use
Project.createTag(String,String,java.util.Map) |
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 |
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 links
of 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. |
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 |
ScheduleEntry.getDescription() |
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()
The time when the
ScheduleEntry has been finished or null when the entry has not 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
|
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()
the project for
project specific task templates |
ScheduleEntry |
ScheduleStorage.getScheduleEntry(Project project,
String name)
Returns the specified entry or
null if it couldn't be found. |
ScheduleTaskTemplate |
ScheduleStorage.getScheduleTaskTemplate(long id)
Returns the
ScheduleTaskTemplate 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
|
ScheduleTask |
ScheduleContext.getTask()
the acutal task or
null if no task is currently executed |
ScheduleTask |
ScheduleTaskTemplate.getTask()
The task instance.
|
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. |
List<ScheduleTaskTemplate> |
ScheduleStorage.getScheduleTaskTemplates(Project 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) |
void |
ScheduleTask.setDescription(String value)
Provide the description of this task.
|
void |
ScheduleEntry.setEmail(String value) |
void |
FtpTarget.setFtpServerType(String value)
Provide the ftp server type.
|
void |
ScriptTask.setParameter(String name,
String value) |
void |
WebServerConfiguration.setPath(String value)
Deprecated.
since 5.0 - no replacement
|
void |
ScheduleEntry.setProject(Project project) |
void |
ScheduleTaskTemplate.setProject(Project project) |
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) |
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)
Get a data value object by its variable name.
|
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() |
IDProvider |
IDProvider.getInRevision(Revision revision)
Get this element in the state of the given revision.
|
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. |
MultiPageParams |
Data.getMultiPageParams(Language language)
Deprecated.
Since 5.0.104, no replacement.
|
MultiPageParams |
MultiPageParamsProvider.getMultiPageParams(Language language) |
StoreElement |
StoreElement.getNextSibling() |
Package |
PackagePoolItem.getPackage()
Returns the
Package this item belongs to or null . |
IDProvider |
IDProvider.getParent()
|
StoreElement |
StoreElement.getParent()
|
String |
StoreElement.getReferenceName() |
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 |
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)
Create a new
DataValue instance as child of this data object
initializing the child with the respective EditorValue . |
void |
StoreElement.exportStoreElement(OutputStream out,
ExportHandler exportHandler)
Exports this storeelement as zip file to the given outputstream.
|
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.
|
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.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. |
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.
|
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)
Get the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Get the stored URL for the specified parameter set.
|
void |
URLProperties.setStoredUrl(String url,
Media node,
Language language,
Resolution resolution)
Get 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.
|
void |
ProjectProperties.setTemplate(Template template)
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
PictureCropData |
PictureResolution.getCropData()
Get the Crop informations of current pictureresolution if exists (bounds related to original resolution)
or
null if paremeter cropData isn't set |
File |
Media.getFile(Language language) |
Revision |
File.getFileRevision()
Return file content revision or
null if no content exits. |
InputStream |
Picture.getInputStream(Resolution resolution)
Get the picture content of the current picture-media as an inputstream.
|
MimeType |
File.getMimeType()
Get the mime-type.
|
MimeType |
MediaMetaData.getMimeType()
Returns the an immutable MIME type.
|
MimeType |
PictureResolution.getMimeType()
Get the mime-type of the current picture resolution.
|
Picture |
Media.getPicture(Language language) |
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) |
Picture |
Media.getPicture(Language language) |
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 |
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.
|
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 |
---|---|
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
|
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() |
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. |
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
|
Modifier and Type | Method and Description |
---|---|
void |
DocumentGroup.appendChildBefore(StoreElement child,
StoreElement before) |
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) |
Constructor and Description |
---|
ContentMultiPageParams(Session session,
Select select,
int entitesPerPage,
int maxPageCount,
Date time) |
Modifier and Type | Method and Description |
---|---|
String |
Template.getComment()
Get the comment of the Template
|
StyleTemplate |
TableFormatTemplate.getDefaultStyleTemplate()
Returns the
StyleTemplate used for any table cell if not explicitly overridden
using a StyleTemplateLink . |
String |
LinkTemplate.getExternalUrlEditorName()
The name of the editor which will contain the textual representation of an external "url".
|
de.espirit.firstspirit.access.link.LinkConfig |
LinkTemplateFolder.getLinkConfig()
Deprecated.
Get the link configuration for this link folder.
|
String |
LinkTemplate.getPictureEditorName() |
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
templateId or null
if no template exists with the given id. |
String |
LinkTemplate.getTextEditorName() |
Transition |
WorkflowScriptContext.getTransition()
Return result transtion of the script excution.
|
Workflow |
TemplateStoreRoot.getWorkflowById(long workflowId)
Returns the workflow with the given
workflowId
or null if no workflow exits with the givn id. |
Workflow |
TemplateStoreRoot.getWorkflowByName(String name) |
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) |
TableFormatTemplate |
FormatTemplateContainer.createTableFormatTemplate(String uid,
boolean unifyNameOnServer,
Map<Language,String> lang2DisplayName) |
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) |
void |
WorkflowScriptContext.gotoErrorState(String comment,
Throwable throwable) |
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.setExternalUrlEditorName(String value) |
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 . |
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.
|
IDProvider |
GomCheckable.Context.getElement() |
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 |
AbstractGomFormElement.setLabelAndDescription(String lang,
String label,
String description) |
void |
AbstractGomFormElement.setLabelAndDescription(String lang,
String label,
String description) |
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 |
---|---|
String |
ServerInformationAgent.VersionInfo.getBranch()
Returns the name of the branch of the belonging FirstSpirit version or
null . |
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.
|
Modifier and Type | Method and Description |
---|---|
T |
FormField.get()
Provides the current value of the field.
|
Modifier and Type | Method and Description |
---|---|
FormField<?> |
FormData.get(Language language,
String fieldName)
Provides a property container describing the field with the given name.
|
Modifier and Type | Method and Description |
---|---|
String |
MimeType.getExtension()
Get the associated filename extension.
|
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. |
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 |
---|---|
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(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) |
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) |
UUID |
Entity.getGid()
Returns the gid of this entity, if it already exists or
null . |
KeyValue |
Entity.getKeyValue()
Return the business key of this entity or
null if this entity is in state NEW |
EntityValidator |
EntityType.getValidator() |
<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
name to value . |
Copyright © 2014 e-Spirit AG. All Rights Reserved. Build 5.0_BETA.500