Modifier and Type | Method and Description |
---|---|
Map<String,Object> |
CheckedException.getContext()
Return a
Map of contexts for the exception. |
String |
CheckedException.getErrorCode()
Return the error code for the exception.
|
String |
CheckedException.getLocalizedMessage(ResourceBundle bundle)
Return a localized exception message.
|
Class<T> |
TypedFilter.getType()
Get the filter type.
|
Modifier and Type | Method and Description |
---|---|
static <T> TypedFilter<T> |
TypedFilter.create(Class<T> type)
Creates and returns a class based type filter with no additional
conditions.
|
static <T> TypedFilter<T> |
TypedFilter.create(Class<T> type,
Filter<? super T> filter)
Creates and returns a class based type filter based on given
filter instance. |
static <T> TypedFilter<T> |
TypedFilter.create(Class<T> type,
Filter<? super T> filter)
Creates and returns a class based type filter based on given
filter instance. |
static <T> TypedFilter<T> |
TypedFilter.createExcludeFilter(Class<T> type,
Class<? extends T>... excludes)
Creates and returns a class based type filter with an additional exclude filtering of the specified sub classes.
|
static <T> TypedFilter<T> |
TypedFilter.createIncludeFilter(Class<T> type,
Class<? extends T>... includes)
Creates and returns a class based type filter with an additional include filtering of the specified sub classes.
|
Constructor and Description |
---|
TypedFilter(Class<T> type)
Base constructor for filters based on the given type.
|
Modifier and Type | Method and Description |
---|---|
static Logger |
Logging.getLogger()
Get the
Logger instance. |
static MappedDiagnosticContext |
Logging.getMappedDiagnosticContext()
Get the
MappedDiagnosticContext instance. |
Modifier and Type | Method and Description |
---|---|
boolean |
Logger.isDebugEnabled(Class<?> logger)
Checks whether logging with
debug level is enabled for the supplied class. |
static boolean |
Logging.isDebugEnabled(Class<?> clazz)
Check whether the DEBUG level is enabled for the given class.
|
boolean |
Logger.isInfoEnabled(Class<?> logger)
Checks whether logging with
info level is enabled for the supplied class. |
static boolean |
Logging.isInfoEnabled(Class<?> logger)
Check whether the INFO level is enabled for the given class.
|
boolean |
Logger.isTraceEnabled(Class<?> logger)
Checks whether logging with
trace level is enabled for the supplied class. |
static boolean |
Logging.isTraceEnabled(Class<?> clazz)
Check whether the TRACE level is enabled for the given class.
|
boolean |
Logger.isWarnEnabled(Class<?> logger)
Checks whether logging with
warn level is enabled for the supplied class. |
static boolean |
Logging.isWarnEnabled(Class<?> logger)
Check whether the WARN level is enabled for the given class.
|
void |
Logger.logDebug(String message,
Class<?> logger)
Logs a message with
debug level using the logger for the supplied class. |
void |
Logger.logDebug(String message,
Class<?> logger)
Logs a message with
debug level using the logger for the supplied class. |
static void |
Logging.logDebug(String message,
Class<?> logger)
Checks first whether the DEBUG level is enabled for the given class.
|
void |
Logger.logDebug(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logDebug(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logDebug(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logDebug(String message,
Throwable cause,
Class<?> logger)
Checks first whether the DEBUG level is enabled for the given class.
|
void |
Logger.logError(String message,
Class<?> logger)
Logs a message with
error level using the logger for the supplied class. |
void |
Logger.logError(String message,
Class<?> logger)
Logs a message with
error level using the logger for the supplied class. |
static void |
Logging.logError(String message,
Class<?> logger)
Logs the given error message for the given class.
|
void |
Logger.logError(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logError(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logError(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logError(String message,
Throwable cause,
Class<?> logger)
Logs the error message and the stack trace which causes the message for the given class.
|
void |
Logger.logFatal(String message,
Class<?> logger)
Logs a message with
fatal level using the logger for the supplied class. |
void |
Logger.logFatal(String message,
Class<?> logger)
Logs a message with
fatal level using the logger for the supplied class. |
static void |
Logging.logFatal(String message,
Class<?> logger)
Logs the given fatal message for the given class.
|
static void |
Logging.logFatal(String message,
Class<?> logger)
Logs the given fatal message for the given class.
|
void |
Logger.logFatal(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logFatal(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logFatal(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logFatal(String message,
Throwable cause,
Class<?> logger)
Logs the fatal message and the stack trace which causes the message for the given class.
|
static void |
Logging.logFatal(String message,
Throwable cause,
Class<?> logger)
Logs the fatal message and the stack trace which causes the message for the given class.
|
void |
Logger.logInfo(String message,
Class<?> logger)
Logs a message with
info level using the logger for the supplied class. |
void |
Logger.logInfo(String message,
Class<?> logger)
Logs a message with
info level using the logger for the supplied class. |
static void |
Logging.logInfo(String message,
Class<?> logger)
Checks first whether the INFO level is enabled for the given class.
|
void |
Logger.logInfo(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logInfo(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logInfo(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logInfo(String message,
Throwable cause,
Class<?> logger)
Checks first whether the INFO level is enabled for the given class.
|
void |
Logger.logTrace(String message,
Class<?> logger)
Logs a message with
trace level using the logger for the supplied class. |
void |
Logger.logTrace(String message,
Class<?> logger)
Logs a message with
trace level using the logger for the supplied class. |
static void |
Logging.logTrace(String message,
Class<?> logger)
Checks first whether the TRACE level is enabled for the given class.
|
static void |
Logging.logTrace(String message,
Class<?> logger)
Checks first whether the TRACE level is enabled for the given class.
|
void |
Logger.logTrace(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logTrace(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logTrace(String message,
Throwable cause,
Class<?> logger)
Checks first whether the TRACE level is enabled for the given class.
|
static void |
Logging.logTrace(String message,
Throwable cause,
Class<?> logger)
Checks first whether the TRACE level is enabled for the given class.
|
void |
Logger.logWarning(String message,
Class<?> logger)
Logs a message with
warn level using the logger for the supplied class. |
void |
Logger.logWarning(String message,
Class<?> logger)
Logs a message with
warn level using the logger for the supplied class. |
static void |
Logging.logWarning(String message,
Class<?> logger)
Checks first whether the WARN level is enabled for the given class.
|
void |
Logger.logWarning(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logWarning(String message,
Throwable cause,
Class<?> logger)
|
void |
Logger.logWarning(String message,
Throwable cause,
Class<?> logger)
|
static void |
Logging.logWarning(String message,
Throwable cause,
Class<?> logger)
Checks first whether the WARN level is enabled for the given class.
|
void |
MappedDiagnosticContext.putMDC(String key,
String val)
Put a context value (the val parameter) as identified with the key parameter into the current thread's context
map.
|
void |
MappedDiagnosticContext.removeMDC(String key)
Remove the the context identified by the key parameter.
|
Modifier and Type | Method and Description |
---|---|
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. |
static String |
Streams.toBase64(byte[] bytes)
Encodes a raw byte array into a BASE64 string representation in accordance with RFC 2045.
|
static byte[] |
Streams.toByteArray(InputStream in)
Read the content of an input stream into a byte array.
|
static String |
Streams.toString(InputStream in,
String encoding)
Read the content of the specified input stream and returns the content as string using the specified encoding.
|
Modifier and Type | Method and Description |
---|---|
static void |
Windows.centerWindow(Window window)
Centers the given
windowToAdjust relative to the active frame of the application. |
static String |
Strings.implode(Collection<?> objects,
String delimiter)
Generates a string which contains all string values of the specified collection, separated by the given delimiter.
|
static String |
Strings.implode(Collection<?> objects,
String delimiter)
Generates a string which contains all string values of the specified collection, separated by the given delimiter.
|
static <T,D extends T> |
Objects.nvl(T value,
D defaultValue)
Returns the first parameter if it's not
null , else the second. |
static String |
Streams.toBase64(byte[] bytes)
Encodes a raw byte array into a BASE64 string representation in accordance with RFC 2045.
|
static byte[] |
Streams.toByteArray(InputStream in)
Read the content of an input stream into a byte array.
|
static String |
Streams.toString(InputStream in,
String encoding)
Read the content of the specified input stream and returns the content as string using the specified encoding.
|
static String |
Streams.toString(InputStream in,
String encoding)
Read the content of the specified input stream and returns the content as string using the specified encoding.
|
static long |
Streams.write(InputStream in,
OutputStream out)
Transfers all date from the given input stream to the given output stream and returns the number of transfered bytes.
|
static long |
Streams.write(InputStream in,
OutputStream out)
Transfers all date from the given input stream to the given output stream and returns the number of transfered bytes.
|
Modifier and Type | Method and Description |
---|---|
static <T> Filter<T> |
Filter.Util.acceptAll()
A primitive filter accepting any element.
|
static <T> Filter<T> |
Filter.Util.acceptNothing()
A primitive filter accepting no element.
|
static <T> Filter<T> |
Filter.Util.and(Collection<Filter<T>> f)
Factory to create a combinatorial conjunction-filter on a given collection of filters.
|
static <T> Filter<T> |
Filter.Util.and(Filter<T>... f)
Factory to create a combinatorial conjunction-filter on the given arguments.
|
static <T,C extends Collection<T>> |
Filter.Util.doFilter(Collection<T> source,
Filter<T> filter,
C target)
Copies all matching entries of collection source to collection target.
|
static <T> Filter<T> |
Filter.Util.equal(T value)
Factory creating an equality filter with the given value as comparison operand.
|
K |
IdentifierList.getKey(int index)
Returns the key at the given index.
|
Class<T> |
Filter.TypedFilter.getType()
Get the element type of this instance, all filtered instances are of this type.
|
static <T> Filter<T> |
Filter.Util.implies(Filter<T> condition,
Filter<T> implication)
Factory to create a logical consequence based filter on a given condition and its implication.
|
static <T> Filter<T> |
Filter.Util.not(Filter<T> f)
Factory to create a negation of the given filter.
|
static <T> Filter<T> |
Filter.Util.notNull()
A primitive filter accepting all non-null elements.
|
static <T> Filter<T> |
Filter.Util.or(Collection<Filter<T>> f)
Factory to create a combinatorial disjunction-filter on a given collection of filters.
|
static <T> Filter<T> |
Filter.Util.or(Filter<T>... f)
Factory to create a combinatorial disjunction-filter on the given arguments.
|
static List<List<String>> |
CsvReader.parseCsvToList(Reader reader,
char delim)
parses the csv source of the given reader to a list of lists of
String 's |
static String[][] |
CsvReader.parseCsvToStringArray(Reader reader,
char delim)
parses the csv source of the given reader to a StringArray of StringArrays
|
CsvReader.CsvToken |
CsvReader.read()
Returns a
CsvToken of the typeCsvReader.CsvToken.VALUE or CsvReader.CsvToken.NEW_LINE or CsvReader.CsvToken.EOF |
List<T> |
Listable.toList()
Creates a new, mutable list containing all elements.
|
Modifier and Type | Method and Description |
---|---|
static <T> Filter<T> |
Filter.Util.and(Collection<Filter<T>> f)
Factory to create a combinatorial conjunction-filter on a given collection of filters.
|
static <T,C extends Collection<T>> |
Filter.Util.doFilter(Collection<T> source,
Filter<T> filter,
C target)
Copies all matching entries of collection source to collection target.
|
static <T,C extends Collection<T>> |
Filter.Util.doFilter(Collection<T> source,
Filter<T> filter,
C target)
Copies all matching entries of collection source to collection target.
|
static <T,C extends Collection<T>> |
Filter.Util.doFilter(Collection<T> source,
Filter<T> filter,
C target)
Copies all matching entries of collection source to collection target.
|
static <T> Filter<T> |
Filter.Util.implies(Filter<T> condition,
Filter<T> implication)
Factory to create a logical consequence based filter on a given condition and its implication.
|
static <T> Filter<T> |
Filter.Util.implies(Filter<T> condition,
Filter<T> implication)
Factory to create a logical consequence based filter on a given condition and its implication.
|
static <T> Filter<T> |
Filter.Util.not(Filter<T> f)
Factory to create a negation of the given filter.
|
static <T> Filter<T> |
Filter.Util.or(Collection<Filter<T>> f)
Factory to create a combinatorial disjunction-filter on a given collection of filters.
|
static List<List<String>> |
CsvReader.parseCsvToList(Reader reader,
char delim)
parses the csv source of the given reader to a list of lists of
String 's |
static String[][] |
CsvReader.parseCsvToStringArray(Reader reader,
char delim)
parses the csv source of the given reader to a StringArray of StringArrays
|
Constructor and Description |
---|
CsvReader(Reader reader)
Constructs a new CsvReader with the given reader as source of the csv file with default delimiter ';'.
|
CsvReader(Reader reader,
char delim)
Constructs a new CsvReader with the given reader as source of the csv file and the given char as delimiter of the csv file
|
Modifier and Type | Field and Description |
---|---|
String |
MailHeader.recipients
Deprecated.
since 5.2.601 - use
MailHeader.Builder.recipient(String) and MailHeader.getRecipients() instead |
Modifier and Type | Method and Description |
---|---|
MailHeader |
MailHeader.Builder.create()
Constructs a new
MailHeader with the values of this builder. |
static de.espirit.firstspirit.client.io.ServerCaller |
ConnectionManager.createCaller(String host,
int port,
int mode,
String servletZone)
Creates a server caller based on the given information.
|
WorkflowScriptContext |
WorkflowContext.createWorkflowScriptContext(Script script,
Transition transition,
Activity activity,
TaskState.Mode callMode,
Data data)
Deprecated.
|
SpecialistsBroker |
Connection.getBroker()
Returns broker without project binding.
|
static MailHeader.Builder |
MailHeader.getBuilder()
Create a new builder for a
MailHeader . |
ClassLoader |
Connection.getClassLoader()
Returns a class loader which can load classes from the server and from module libraries.
|
ClassLoader |
ModuleAgent.getClassLoader()
Returns a class loader instance which is capable of loading all global module classes.
|
Collection<ComponentDescriptor> |
ModuleAgent.getComponents(Class<?> type)
Returns all components which implements or extends the given type.
|
List<Principal> |
TransitionParameters.getEditors()
Get task editors.
|
Task.ErrorCode |
Task.VerifyError.getErrorCode()
Returns the
error code . |
Collection<ExternalGroup> |
User.getExternalGroups()
Get the users
external groups as a collection . |
static Language |
AccessUtil.getLanguageForKeyNotNull(Project project,
String languageKey)
Gets a single project language by its unique abbreviation.
|
Page |
GenerationContext.getLanguageSpecificPage(Page page)
Get the
Page for the current language |
PageParams |
GenerationContext.getPageParams()
Get the page params of the page which is generated.
|
ServerConfiguration.PluggabilityFeaturesConfiguration |
ServerConfiguration.getPluggabilityFeaturesConfiguration()
Retrieves the configuration of pluggability features for web applications.
|
Task.Priority |
TransitionParameters.getPriority()
Get task priority.
|
String |
MailHeader.getRecipients()
A semicolon-separated list of recipients.
|
<T> T |
ServicesBroker.getService(Class<T> serviceClass)
Returns a service instance as requested by a given class.
|
Object |
Connection.getService(String serviceName)
Returns a service instance for the given name.
|
Date |
GenerationContext.getStartTime()
Start time of generate process.
|
Store |
UserService.getStore(Store.Type storeType,
boolean release)
|
Store |
UserService.getStore(Store.Type storeType,
boolean forceRefresh,
boolean release)
Returns the store with the given type belonging to this userservice.
|
String |
DuplicateReferenceNameException.getSuggestion()
Returns the suggestion for the uid which was unique at the time calculated on the server.
|
Task |
WorkflowContext.getTask()
Get the task.
|
ConversionTable |
ServerConfiguration.getUidConversionTable()
Get conversion table used for creating UIDs suggestions from display names.
|
UrlCreator |
UrlCreatorProvider.getUrlCreator()
Get the current url creator.
|
default Optional<UrlCreatorProvider> |
UrlCreatorProvider.getUrlCreatorProvider(IDProvider node)
Provides a
UrlCreatorProvider for the remote configuration associated with the given IDProvider . |
UrlCreatorProvider |
UrlCreatorProvider.getUrlCreatorProvider(RemoteProjectConfiguration config)
Provides a
UrlCreatorProvider for the given remote configuration. |
UserService |
UrlCreatorProvider.getUserService()
Provides the user service within the provider's context.
|
WebstartConfiguration |
ServerConfiguration.getWebstartConfiguration(String name)
Returns the webstart configuration specified by the given name.
|
Modifier and Type | Method and Description |
---|---|
State |
Task.doTransition(WorkflowContext context,
Transition transition)
Perform transition execution on this task.
|
State |
Task.doTransition(WorkflowContext context,
Transition transition)
Perform transition execution on this task.
|
String |
ServerConfiguration.getActiveWebserverConfiguration(String webAppName)
Gets the active webserver for the named web application.
|
Page |
GenerationContext.getLanguageSpecificPage(Page page)
Get the
Page for the current language |
String |
ServerConfiguration.getSelectedWebserverConfiguration(String webAppName)
Deprecated.
since 5.2.180906 - no replacement
|
Store |
UserService.getStore(Store.Type storeType,
boolean release)
|
Store |
UserService.getStore(Store.Type storeType,
boolean forceRefresh,
boolean release)
Returns the store with the given type belonging to this userservice.
|
default Optional<UrlCreatorProvider> |
UrlCreatorProvider.getUrlCreatorProvider(IDProvider node)
Provides a
UrlCreatorProvider for the remote configuration associated with the given IDProvider . |
UrlCreatorProvider |
UrlCreatorProvider.getUrlCreatorProvider(RemoteProjectConfiguration config)
Provides a
UrlCreatorProvider for the given remote configuration. |
WebstartConfiguration |
ServerConfiguration.getWebstartConfiguration(String name)
Returns the webstart configuration specified by the given name.
|
void |
Task.gotoErrorState(WorkflowContext context,
Activity activity,
String comment,
Throwable throwable)
Goto model error state.
|
void |
GenerationContext.mediaReferenced(Media media,
Language language,
Resolution resolution)
Prints a referenced media to the generation target, if it was not yet printed.
|
MailHeader.Builder |
MailHeader.Builder.recipient(String recipient)
Adds one or more recipients to the mail header.
|
MailHeader.Builder |
MailHeader.Builder.replyTo(String replyTo)
Adds one or more reply-to addresses to the mail header.
|
static ServerActionHandle<? extends RestoreProgress,Boolean> |
AccessUtil.restore(IDProvider newParent,
ElementInfo elementInfo,
boolean restoreParentIfNecessary,
boolean ignoreMissingReferencedObjects,
boolean checkOnlyMode)
Starts a restore action on the server, which restores the deleted element specified by the given
elementInfo |
static ServerActionHandle<? extends RestoreProgress,Boolean> |
AccessUtil.restore(IDProvider newParent,
ElementInfo elementInfo,
boolean restoreParentIfNecessary,
boolean ignoreMissingReferencedObjects,
boolean checkOnlyMode)
Starts a restore action on the server, which restores the deleted element specified by the given
elementInfo |
MailHeader.Builder |
MailHeader.Builder.sender(String sender)
Sets the sender of this mail header.
|
void |
MessageService.sendMessage(String message)
Sends the given message to all users logged in on the server.
|
void |
MessageService.sendMessage(String message,
Group recipientGroup)
Sends the given message to the users contained in the given usergroup.
|
void |
MessageService.sendMessage(String message,
Group recipientGroup)
Sends the given message to the users contained in the given usergroup.
|
void |
MessageService.sendMessage(String message,
List<User> recipients)
Sends the given message to the users specified by the given recipients list.
|
void |
MessageService.sendMessage(String message,
List<User> recipients)
Sends the given message to the users specified by the given recipients list.
|
void |
ServerConfiguration.setActiveWebserverConfiguration(String webAppName,
String selectedWebserver)
Sets the configuration of the given webserver as active for the named web application.
|
void |
ServerConfiguration.setActiveWebserverConfiguration(String webAppName,
String selectedWebserver)
Sets the configuration of the given webserver as active for the named web application.
|
void |
ServerConfiguration.setPluggabilityFeaturesConfiguration(ServerConfiguration.PluggabilityFeaturesConfiguration pluggabilityFeaturesConfiguration)
Sets the configuration of pluggability features for web applications.
|
void |
ServerConfiguration.setSelectedWebserverConfiguration(String webAppName,
String selectedWebserver)
Deprecated.
since 5.2.180906 - no replacement
|
void |
ServerConfiguration.setSelectedWebserverConfiguration(String webAppName,
String selectedWebserver)
Deprecated.
since 5.2.180906 - no replacement
|
void |
ServerConfiguration.setUidConversionTable(ConversionTable table)
Set conversion table used for creating UIDs suggestions from display names.
|
void |
ServerConfiguration.setWebstartConfiguration(String name,
WebstartConfiguration config)
Sets the configuration of webstart for the given application.
|
void |
ServerConfiguration.setWebstartConfiguration(String name,
WebstartConfiguration config)
Sets the configuration of webstart for the given application.
|
Constructor and Description |
---|
DuplicateReferenceNameException(String message,
String oldUid,
String suggestion,
String attribute,
long nodeId)
Constructor for this exception.
|
DuplicateReferenceNameException(String message,
String oldUid,
String suggestion,
String attribute,
long nodeId)
Constructor for this exception.
|
DuplicateReferenceNameException(String message,
String oldUid,
String suggestion,
String attribute,
long nodeId)
Constructor for this exception.
|
MailHeader(String recipients)
Deprecated.
since 5.2.601 - use
MailHeader.Builder instead |
Modifier and Type | Method and Description |
---|---|
Project |
ProjectStorage.createProject(String name,
String description)
Create a new Project.
|
String |
WebstartConfiguration.getConnectionMode()
Returns the connection mode of this Web Start configuration.
|
String |
WebstartConfiguration.getHost()
Returns the hostname to connect to.
|
String |
WebstartConfiguration.getParameters()
Returns optional parameters for the Java Web Start connection, defined as "PARAMETER1=VALUE1; PARAMETER2=VALUE2"
|
List<User> |
UserStorage.getUsersByID(Long[] ids)
Returns users with the given ids.
|
WebstartConfiguration |
JavaClientQuickstart.getWebstartConfiguration()
Returns the webstart configuration.
|
Modifier and Type | Method and Description |
---|---|
ScriptEngine |
ScriptEngineRegistry.getScriptEngine(String engineName)
Returns the script engine specified by given name.
|
ScriptEngine |
ScriptEngineRegistry.getScriptEngineForSource(String scriptSource)
Tries to parse the script source to determine the script engine type.
|
void |
JavaClientQuickstart.setWebstartConfiguration(WebstartConfiguration config)
Sets the webstart configuration.
|
Modifier and Type | Method and Description |
---|---|
List<Reference> |
EditorValue.findReferences()
Deprecated.
Finds references within this editor and returns them as a list.
|
SectionList |
ContentAreaListValue.get(Language language)
Deprecated.
Get the value object in the specified language.
|
FormDataList |
FsListEditorValue.get(Language language)
Deprecated.
since 5.2.311 use
CatalogEditorValue.get(Language) , IndexEditorValue.get(Language) or EditorValue.get(Language) instead |
GraphicalMedium |
PictureEditorValue.get(Language language)
Deprecated.
Get the value object in the specified language.
|
Collection<Activity> |
PermissionsAgent.getActivities(IDProvider element)
Provides activities for the given element containing permissions as defined in the
meta data field of the fieldname configured in the project.
|
Collection<Activity> |
PermissionsAgent.getActivities(IDProvider element,
String fieldname)
Provides activities for the given element containing permissions as defined in the
meta data field of the given fieldname.
|
List<LinkTemplate> |
DomEditorValue.getAllowedLinkTemplates()
Get a list of allowed link types.
|
List<LinkTemplate> |
DomTableEditorValue.getAllowedLinkTemplates()
Get a list of allowed link types.
|
List<LinkTemplate> |
LinkEditorValue.getAllowedLinkTemplates()
Get a list of allowed link types.
|
List<LinkTemplate> |
LinkListEditorValue.getAllowedLinkTemplates()
Deprecated.
Get a list of allowed link types.
|
Iterable<SectionTemplate> |
ContentAreaListValue.getAllowedSectionTemplates()
Deprecated.
Returns an unmodifiable iterable of allowed
section templates
which could be used to create new sections. |
Content2 |
DatasetEditorValue.getDefaultContentNode()
Returns the default table template: The first valid content node configured in
the form . |
String |
Associate.getIndexTerm()
Provides the term to be written identifying the associate in the index.
|
List<? extends Match> |
EditorValue.getMatches(Language language,
Request request)
Deprecated.
Find matches for the given request.
|
Object |
Associate.getType()
Provides the associate's type.
|
Class<T> |
EditorValue.getValueType()
Deprecated.
Get the type of value the editor takes.
|
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.
|
boolean |
ValueIndexer.appendAssociate(Associate associate,
Language language,
boolean followAssociations)
Appends the given associate, to consolidate changes between the data and the associate.
|
boolean |
ValueIndexer.appendAssociate(Associate associate,
Language language,
boolean followAssociations)
Appends the given associate, to consolidate changes between the data and the associate.
|
void |
ValueIndexer.appendDate(String name,
Date value)
Appends the given date value for indexing with respect to the defined field name.
|
void |
ValueIndexer.appendFormData(FormData formData,
Language language,
boolean followAssociations)
Appends the given form data content for indexing.
|
void |
ValueIndexer.appendFormData(FormData formData,
Language language,
boolean followAssociations)
Appends the given form data content for indexing.
|
void |
ValueIndexer.appendNumber(String name,
Number value)
Appends the given number value for indexing with respect to the defined field name.
|
boolean |
ValueIndexer.associate(Entity entity)
Associate an entity with the value under indexing, so that if the entity changes, the value will be updated wrt. its index entry.
|
Modifier and Type | Method and Description |
---|---|
List<Long> |
FormDataProvider.find(String query)
Deprecated.
Find method, delivers a list of ids where the content matches the given query.
|
List<IdentifiedFormData> |
FormDataProvider.get(List<Long> ids)
Deprecated.
Return the values for the specified ids.
|
Map<String,String> |
FormDataProviderContext.getParams()
Delivers the generic paramters defined in the form.
|
Modifier and Type | Method and Description |
---|---|
List<IdentifiedFormData> |
FormDataProvider.get(List<Long> ids)
Deprecated.
Return the values for the specified ids.
|
void |
FormDataProvider.init(FormDataProviderContext context)
Deprecated.
Initializes the provider instance.
|
Modifier and Type | Method and Description |
---|---|
IdProvidingFormData |
ContentFormsProducer.create()
Creates a new form data on the table template defined in the form definition.
|
IdProvidingFormData |
LinkFormsProducer.create(LinkTemplate template,
Language language)
Creates a new form-data container based on the given link template and language.
|
IdProvidingFormData |
SectionFormsProducer.create(SectionTemplate template)
Creates a new form-data container based on the specified section template.
|
Collection<LinkTemplate> |
LinkFormsProducer.getAllowedTemplates()
Returns an unmodifiable collection of allowed
link templates . |
Collection<SectionTemplate> |
SectionFormsProducer.getAllowedTemplates()
Returns an unmodifiable collection of allowed
section templates . |
List<Area> |
MappingMedium.getAreas()
Provides the areas defined for mapping to links.
|
Priority |
Permissions.getPriority()
Provides the priority setting for this permissions.
|
ListDomNode.Style |
ListDomNode.getStyle()
Returns the list style of this list dom node.
|
Modifier and Type | Method and Description |
---|---|
DomNode |
DefaultDomNode.appendChild(FormatTemplate formatTemplate)
Creates and appends a child at the end of the child list.
|
LinkDomNode |
DefaultDomNode.appendChild(Link link)
Creates and appends a link node.
|
TextDomNode |
DefaultDomNode.appendChild(String text)
Creates and appends a text node.
|
TableDomNode |
DefaultDomNode.appendChild(TableFormatTemplate tableFormat)
Creates and appends an (inline) table node.
|
IdProvidingFormData |
LinkFormsProducer.create(LinkTemplate template,
Language language)
Creates a new form-data container based on the given link template and language.
|
IdProvidingFormData |
LinkFormsProducer.create(LinkTemplate template,
Language language)
Creates a new form-data container based on the given link template and language.
|
IdProvidingFormData |
SectionFormsProducer.create(SectionTemplate template)
Creates a new form-data container based on the specified section template.
|
boolean |
Option.ignore(Language language)
Indicates whether this
Option should be ignored and therefore hidden in the gui
for the provided language. |
Section<?> |
TargetReference.loadSection(Page page,
String sectionName)
Load a section of the given referenced page identified by its section name.
|
void |
DomNode.removeChild(DomNode child)
Removes a child of the child list.
|
DomNode |
DomNode.replaceChild(DomNode child,
String text)
Replace a child with a new one at the same position the child list.
|
void |
ListDomNode.setStyle(ListDomNode.Style style)
Provide the list style of this list dom node.
|
Modifier and Type | Method and Description |
---|---|
PolygonBuilder |
PolygonBuilder.add(int x,
int y)
Adds a new edge to the polygon positioned at the given coordinate.
|
RectangleBuilder |
RectangleBuilder.bounds(int left,
int top,
int right,
int bottom)
Defines the bounds for the rectangle.
|
Area |
AreaBuilder.build()
Produces a new area.
|
CircleArea |
CircleBuilder.build()
Produces a new circle area.
|
PolyArea |
PolygonBuilder.build()
Produces a new polygonal area.
|
RectArea |
RectangleBuilder.build()
Produces a new rectangular area.
|
CircleBuilder |
CircleBuilder.center(int x,
int y)
Sets the center coordinates for the circle.
|
CircleBuilder |
ImageMapAgent.getCircleBuilder()
Provides a builder for circular areas.
|
Point |
RectArea.getLeftTop()
Provides the left top coordinate.
|
PolygonBuilder |
ImageMapAgent.getPolygonBuilder()
Provides a builder for polygonal areas.
|
RectangleBuilder |
ImageMapAgent.getRectangleBuilder()
Provides a builder for rectangular areas.
|
Point |
RectArea.getRightBottom()
Provides the right bottom coordinate.
|
AreaBuilder |
AreaBuilder.link(Link link)
Sets the link maintained by the area.
|
CircleBuilder |
CircleBuilder.link(Link link)
Sets the link maintained by the area.
|
PolygonBuilder |
PolygonBuilder.link(Link link)
Sets the link maintained by the area.
|
RectangleBuilder |
RectangleBuilder.link(Link link)
Sets the link maintained by the area.
|
CircleBuilder |
CircleBuilder.radius(int radius)
Sets the radius for the circle.
|
Modifier and Type | Method and Description |
---|---|
AreaBuilder |
AreaBuilder.link(Link link)
Sets the link maintained by the area.
|
CircleBuilder |
CircleBuilder.link(Link link)
Sets the link maintained by the area.
|
PolygonBuilder |
PolygonBuilder.link(Link link)
Sets the link maintained by the area.
|
RectangleBuilder |
RectangleBuilder.link(Link link)
Sets the link maintained by the area.
|
<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.
|
Constructor and Description |
---|
ImportParameters(ExportFile exportFile,
ProjectInfo projectInfo,
String projectName,
String projectDescription,
Map<String,String> layerMapping,
Map<Long,Long> scheduleTaskTemplateMapping)
Creates a new ImportParameters object.
|
ImportParameters(ExportFile exportFile,
ProjectInfo projectInfo,
String projectName,
String projectDescription,
Map<String,String> layerMapping,
Map<Long,Long> scheduleTaskTemplateMapping)
Creates a new ImportParameters object.
|
ImportParameters(ExportFile exportFile,
ProjectInfo projectInfo,
String projectName,
String projectDescription,
Map<String,String> layerMapping,
Map<Long,Long> scheduleTaskTemplateMapping,
Map<Long,String> layerIDMapping)
Creates a new ImportParameters object.
|
ImportParameters(ExportFile exportFile,
ProjectInfo projectInfo,
String projectName,
String projectDescription,
Map<String,String> layerMapping,
Map<Long,Long> scheduleTaskTemplateMapping,
Map<Long,String> layerIDMapping)
Creates a new ImportParameters object.
|
Modifier and Type | Method and Description |
---|---|
Data |
Link.getData()
Deprecated.
since 4.2.440 - use
Link.getFormData() instead |
FormData |
Link.getFormData()
Gets the
formdata container for this link. |
Modifier and Type | Method and Description |
---|---|
void |
Link.setData(Data data)
Deprecated.
since 4.2.440 - use
Link.setFormData(de.espirit.firstspirit.forms.FormData) instead |
void |
Link.setFormData(FormData formData)
Sets the given
formdata container for this link. |
Modifier and Type | Method and Description |
---|---|
IdTranslator |
Subscription.getElementIdTranslator()
Provides a translator between element IDs from the publisher project to the
subscriber project . |
IdTranslator |
Subscription.getTemplateIdTranslator()
Provides a translator between template IDs from the publisher project to the
subscriber project . |
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(String tag,
String comment,
Map<String,String> properties)
Create a tagged revision.
|
String |
ExternalGroup.getExternalName()
Get the external group name.
|
Revision |
Project.getFirstCompleteRevision()
Returns the first revision up to that the history is complete (i.e. has not been archived).
|
List<Group> |
Project.getGroups()
Returns a list of all
groups of this project. |
List<Group> |
Project.getGroups(User user)
|
InlinePreviewConstraints |
Project.getInlinePreviewConstraints()
Get the
media constraints settings of this project. |
MediaConstraints |
Project.getMediaConstraints()
Get the
media constraints settings of thisproject. |
String |
Project.getName()
Get the unique project name
|
List<RemoteProjectConfiguration> |
Project.getRemoteProjectConfigurations()
Return the list of existing remote project configurations for this project.
|
List<RemoteProjectConfiguration> |
Project.getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> filter)
Returns the list of remote project configurations for this project that pass the given filter.
|
Revision |
Project.getRevision(Date revisionDate)
Returns the latest revision with a
creation time less or equal to the time of the given revisionDate |
Revision |
Project.getRevision(long revisionId)
Returns the revision with the specified revision id.
|
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.
|
List<TemplateSet> |
Project.getTemplateSets()
Get all
TemplateSet s of this project. |
UserService |
Project.getUserService()
Creates an
UserService for this project, or returns a cached instance. |
UserService |
Project.getUserService(Date time)
Returns a readonly userservice with frozen store data at the specified point in time.
|
UserService |
Project.getUserService(long revisionId)
Returns a read-only historic view, the provided revision id determines the point in time.
|
UserService |
Project.getUserService(Revision revision)
Returns a readonly userservice with frozen store data at the specified revision.
|
PageFolder |
Project.getWebeditSystemFolder()
Returns the pagefolder that should be used as webedit system folder.
|
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.
|
void |
Project.deleteCustomProperties(String name)
Delete user defined project properties.
|
Map<String,String> |
Project.getCustomProperties(String name)
Returns map of user defined properties.
|
Object |
Project.getProperty(String name)
Returns project property with the given
name or null if not found. |
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. |
List<Revision> |
Project.getRevisions(Revision from,
Revision to,
int maxCount,
Filter<Revision> filter)
Returns a list of revisions in descending order.
|
List<Revision> |
Project.getRevisions(Revision from,
Revision to,
int maxCount,
Filter<Revision> filter)
Returns a list of revisions in descending order.
|
UserService |
Project.getUserService(Date time)
Returns a readonly userservice with frozen store data at the specified point in time.
|
UserService |
Project.getUserService(Revision revision)
Returns a readonly userservice with frozen store data at the specified revision.
|
void |
Project.removeProperty(String name)
Removes the project property with the given
name . |
void |
Project.setCustomProperties(String name,
Map<String,String> properties)
Set user defined project properties.
|
void |
ExternalGroup.setExternalName(String name)
Sets the name of the external group.
|
void |
Project.setInlinePreviewConstraints(InlinePreviewConstraints value)
Set the
inline preview settings of this project. |
void |
RemoteProjectConfiguration.setLoginUser(User user,
String loginPassword)
Sets the user and password which should be used for the remote project connection.
|
void |
RemoteProjectConfiguration.setLoginUser(User user,
String loginPassword)
Sets the user and password which should be used for the remote project connection.
|
void |
Project.setMediaConstraints(MediaConstraints value)
Set the
media constraints settings of this project. |
void |
Project.setName(String name)
Sets the name of the project
|
void |
Project.setProperty(String name,
Object value)
Sets the project property
name to the given value . |
void |
Project.setProperty(String name,
Object value)
Sets the project property
name to the given value . |
Modifier and Type | Method and Description |
---|---|
MPPViewport.Builder |
MPPViewports.builder()
Provides a new builder instance to create a
viewport . |
Modifier and Type | Method and Description |
---|---|
void |
MPPViewports.add(MPPViewport viewport)
Adds the given
viewport to the current collection of viewports. |
boolean |
MPPViewports.remove(MPPViewport viewport)
Removes the given viewport from the current collection.
|
Modifier and Type | Method and Description |
---|---|
DeltaGeneration.ChangeSet |
DeltaGeneration.calculateChangeSet()
Calculate the change set based on the current settings.
|
List<String> |
ScheduleTask.checkParams()
Returns an empty list, if all params are ok, or a list with complaints, each prefixed with
ScheduleTask.getName() . |
ScheduleEntry |
ScheduleStorage.copyScheduleEntry(ScheduleEntry scheduleEntry,
Project project)
Copies the given
scheduleEntry to another project or to server scoped,
if project is null . |
<T extends ScheduleTask> |
ScheduleEntry.copyTask(T value)
Copy's the given task.
|
ScheduleEntry |
ScheduleStorage.createScheduleEntry(String scheduleEntryName)
Creates a new schedule entry for server scoped actions.
|
ScheduleEntry |
ScheduleStorage.createScheduleEntry(String scheduleEntryName,
Project project)
Creates a new schedule entry for the provided project.
|
ScheduleTaskTemplate |
ScheduleStorage.createScheduleTaskTemplate()
Creates a new schedule task template which can be used for project or server scoped actions.
|
ScheduleTask |
ScheduleEntry.createTask(ScheduleTaskTemplate template)
Creates a
ScheduleTask which uses all properties of the given ScheduleTaskTemplate . |
DeltaGeneration |
DeltaGeneration.dependencyRules(EnumSet<DependencyRule> dependencyRules)
The dependency rules which will be obeyed when
calculating the change set . |
List<String> |
MaintenanceModeTask.getAllowedGroupNames()
The server administrator may always connect to the server, even if the maintenance mode is active.
|
List<User> |
MaintenanceModeTask.getAllowedUsers()
The server administrator may always connect to the server, even if the maintenance mode is active.
|
MaintenanceModeTask.ConcurrentTaskHandling |
MaintenanceModeTask.getConcurrentTaskHandling()
Indicates if other tasks may be executed while the maintenance mode is active.
|
InputStream |
ScheduleStorage.getDefaultMailText()
Returns the default mail text used for
MailTask . |
Iterable<DeltaGeneration.DeletedPageInfo> |
DeltaGeneration.ChangeSet.getDeletedPageInfos()
Information for deleted pages.
|
String |
WebServerConfiguration.getDirectory1()
Deprecated.
since 5.0 - no replacement
|
String |
WebServerConfiguration.getDirectory2()
Deprecated.
since 5.0 - no replacement
|
MaintenanceModeTask.DisconnectMode |
MaintenanceModeTask.getDisconnectMode()
Indicates the handling of existing sessions once the stage
MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE begins. |
String |
FtpTarget.FtpServerType.getDisplayName()
Returns the display name of this ftp server type.
|
String |
ScheduleEntryRunningException.getEntryName()
Returns the name of the
ScheduleEntry . |
ExecutionSchedule |
ScheduleEntry.getExecutionSchedule()
Returns the
ExecutionSchedule of this ScheduleEntry . |
String |
ScheduleEntry.getFolderName()
the folder name where pages should be generated in
if folder name is null or length zero, the schedule entry id will be used on task execution |
GenerateTask.GenerationSource |
GenerateTask.getGenerationSource()
Get the generation source state.
|
List<Group> |
ScheduleEntry.getGroups()
a
List of type Group containing all groups allowed to execute this ScheduleEntry interactive. |
List<ScheduleEntryControl> |
ScheduleStorage.getHistory(Date from,
Date until,
int maxCount,
boolean includeProjectEntries)
Get the execution history of server schedule entries.
|
List<ScheduleEntryControl> |
ScheduleStorage.getHistory(Date from,
Date until,
int maxCount,
Project project)
Get the execution history of schedule entries of the given project.
|
String |
FtpTarget.FtpServerType.getId()
Returns either the system key or a fully qualified class name.
|
Language |
DeltaGeneration.DeletedPageInfo.getLanguage()
Language of deleted page.
|
String |
MaintenanceModeTask.getMaintenanceName()
The descriptive name of the maintenance mode started by this task.
|
List<Project> |
MaintenanceModeTask.getMaintenanceProjects()
All projects affected by the maintenance task.
|
MaintenanceModeTask.MaintenanceScope |
MaintenanceModeTask.getMaintenanceScope()
Indicates the scope of this maintenance task, i.e. if only certain projects or the whole server is affected.
|
String |
MaintenanceModeTask.getMessage()
The message which is displayed to all users once the task has been started.
|
MaintenanceModeTask.MessageDisplayType |
MaintenanceModeTask.getMessageDisplayType()
Indicates how the message is displayed to the users.
|
ProjectCleanupTask.Mode |
ProjectCleanupTask.getMode()
Returns the cleanup mode.
|
String |
ScheduleEntry.getName()
Returns the name of this
ScheduleEntry . |
String |
ScheduleTask.getName()
Returns the name of this task.
|
ScheduleEntry.ParallelExecutionMode |
ScheduleEntry.getParallelExecutionMode()
the
ParallelExecutionMode of this entry. |
List<Map.Entry<String,String>> |
ScriptTask.getParameters()
A set of paramaters set for this
ScriptTask |
List<ScheduleEntry> |
ScheduleStorage.getQueuedEntries()
Returns the list schedule entries that would be executed in the future.
|
RemoteTaskType |
ScheduleTask.getRemoteTaskType()
Returns the type of remote task - if the task is executed remote a valid cluster node is choosen according to this type.
|
List<ScheduleEntryControl> |
ScheduleStorage.getRunningEntries()
Returns a list of currently running controllable schedule entries.
|
List<ScheduleEntry> |
ScheduleStorage.getScheduleEntries(boolean includeProjectEntries)
Returns a list of all (
includeProjectEntries == true ) or
only server scoped ((includeProjectEntries == false )) schedule entries. |
List<ScheduleEntry> |
ScheduleStorage.getScheduleEntries(Project project)
Returns a list of schedule entries depending to given
project . |
ScheduleEntry |
ScheduleStorage.getScheduleEntry(long id)
Returns the schedule entry specified by the given id.
|
List<ScheduleTaskTemplate> |
ScheduleStorage.getScheduleTaskTemplates(Project project)
Returns a list of all schedule task templates for given
project . |
List<IDProvider> |
GenerateTask.getStartNodes()
Returns a modifyable list of start nodes for a
partial generate. |
TemplateSet |
DeltaGeneration.DeletedPageInfo.getTemplateSet()
Template set of deleted page.
|
DeployTask.Type |
DeployTask.getType()
The
used for deployment |
GenerateTask.Type |
GenerateTask.getType()
The generation
used for this GenerateTask |
WebServerConfiguration.Type |
WebServerConfiguration.getType()
Deprecated.
since 5.0 - no replacement
|
UrlCreatorSpecification |
GenerateTask.getUrlCreatorSpecification()
Get the url creator setting.
|
List<ScheduleEntry> |
ScheduleTaskTemplate.getUsages()
Returns a list of schedule entries which contains task that use this template.
|
List<User> |
ScheduleEntry.getUsers()
a
List of type User containing all users allowed to execute this ScheduleEntry interactive. |
UserService |
ScheduleContext.getUserService()
the user service for the project of executed schedule entry
|
List<Map.Entry<String,String>> |
GenerateTask.getVariables()
A set of variables set for this
GenerateTask |
DeltaGeneration |
DeltaGeneration.levelRule(int navLevelMin,
int navLevelMax)
A level rule which will be obeyed when
calculating the change set . |
Modifier and Type | Method and Description |
---|---|
void |
ScheduleContext.addCloseable(Closeable closeable)
To register closeable instances which should be
closed when theschedule terminates. |
void |
ScheduleEntry.addGroup(Group group)
Adds a group to execute this schedule entry.
|
void |
ScheduleEntry.addUser(User user)
Adds the given user which should be allowed to execute this schedule entry.
|
void |
DeltaGeneration.ChangeSet.configureGenerateTask(GenerateTask task)
Configure the provided generate task to generate the calculated change set.
|
void |
DeltaGeneration.ChangeSet.configureGenerateTask(ScheduleTaskControl control)
Configure the provided control, provided that it refers to a generating task.
|
ScheduleEntry |
ScheduleStorage.copyScheduleEntry(ScheduleEntry scheduleEntry,
Project project)
Copies the given
scheduleEntry to another project or to server scoped,
if project is null . |
<T extends ScheduleTask> |
ScheduleEntry.copyTask(T value)
Copy's the given task.
|
static DeltaGeneration |
DeploymentUtil.createDeltaGeneration(ScheduleContext context)
Factory method to create an instance of type
DeltaGeneration . |
ScheduleEntry |
ScheduleStorage.createScheduleEntry(String scheduleEntryName)
Creates a new schedule entry for server scoped actions.
|
ScheduleEntry |
ScheduleStorage.createScheduleEntry(String scheduleEntryName,
Project project)
Creates a new schedule entry for the provided project.
|
<T extends DeployTarget> |
DeployTask.createTarget(Class<T> type)
Create a target.
|
ScheduleTask |
ScheduleEntry.createTask(ScheduleTaskTemplate template)
Creates a
ScheduleTask which uses all properties of the given ScheduleTaskTemplate . |
WebServerConfiguration |
DeployTarget.createWebServerConfiguration(WebServerConfiguration.Type type)
Deprecated.
since 5.0 - no replacement
|
DeltaGeneration |
DeltaGeneration.dependencyRules(EnumSet<DependencyRule> dependencyRules)
The dependency rules which will be obeyed when
calculating the change set . |
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. |
long |
MaintenanceModeTask.getDurationOfStage(MaintenanceModeTask.MaintenanceStage stage)
Each stage has a duration after which the next stage is started.
|
static Iterable<String> |
DeploymentUtil.getGeneratedFiles(ScheduleContext context)
Factory method to create an iterable delivering the path for each generated file.
|
List<ScheduleEntryControl> |
ScheduleStorage.getHistory(Date from,
Date until,
int maxCount,
Project project)
Get the execution history of schedule entries of the given project.
|
List<ScheduleEntry> |
ScheduleStorage.getScheduleEntries(Project project)
Returns a list of schedule entries depending to given
project . |
ScheduleEntry |
ScheduleStorage.getScheduleEntry(Project project,
String name)
Returns the specified schedule entry or
null if it couldn't be found. |
void |
ScheduleEntry.removeGroup(Group group)
Removes the given group which users shouldn't be allowed to execute the schedule entry anymore.
|
void |
ScriptTask.removeParameter(String name)
Removes a parameter having the given name.
|
void |
ScheduleEntry.removeUser(User user)
Removes the given user who shouldn't be allowed to execute the schedule entry anymore.
|
void |
GenerateTask.removeVariable(String name)
Removes a variable having the given name.
|
void |
MaintenanceModeTask.setAllowedGroupNames(Collection<String> groupNames)
Specifies the names of all groups who are allowed to connect to the server even if the maintenance mode is active.
|
void |
MaintenanceModeTask.setAllowedUsers(Collection<User> allowedUsers)
Specifies all users who are allowed to connect to the server even if the maintenance mode is active.
|
void |
MaintenanceModeTask.setConcurrentTaskHandling(MaintenanceModeTask.ConcurrentTaskHandling concurrentTaskHandling)
Defines if other tasks may be executed while the maintenance mode is active.
|
void |
WebServerConfiguration.setDirectory1(String value)
Deprecated.
since 5.0 - no replacement
|
void |
WebServerConfiguration.setDirectory2(String value)
Deprecated.
since 5.0 - no replacement
|
void |
MaintenanceModeTask.setDisconnectMode(MaintenanceModeTask.DisconnectMode disconnectMode)
Defines how existing sessions are handled once the stage
MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE begins. |
void |
MaintenanceModeTask.setDurationOfStage(long durationInMilliseconds,
MaintenanceModeTask.MaintenanceStage stage)
Each stage has a duration after which the next stage is started.
|
void |
ScheduleEntry.setFolderName(String value)
Sets the folder (given by its name) where pages should be generated in.
|
void |
GenerateTask.setGenerationSource(GenerateTask.GenerationSource value)
Set the source version to use for generation.
|
void |
MaintenanceModeTask.setMaintenanceName(String name)
Set descriptive name of the maintenance mode started by this task.
|
void |
MaintenanceModeTask.setMaintenanceProjects(Collection<Project> projects)
Specifies the projects which are affected by the maintenance task.
|
void |
MaintenanceModeTask.setMaintenanceScope(MaintenanceModeTask.MaintenanceScope maintenanceScope)
Defines the scope of this maintenance task.
|
void |
MaintenanceModeTask.setMessage(String message)
Set the message which is included in all messages regarding this maintenance task.
|
void |
MaintenanceModeTask.setMessageDisplayType(MaintenanceModeTask.MessageDisplayType messageDisplayType)
Define how the message of this task should be displayed to the users.
|
void |
ProjectCleanupTask.setMode(ProjectCleanupTask.Mode mode)
Defines the cleanup mode.
|
void |
ScheduleEntry.setName(String value)
Provide the name of this
ScheduleEntry . |
void |
ScheduleTask.setName(String value)
Provide the name of this task.
|
void |
ScheduleEntry.setParallelExecutionMode(ScheduleEntry.ParallelExecutionMode mode)
Changes the
ParallelExecutionMode to the given mode. |
void |
ScriptTask.setParameter(String name,
String value)
Set a parameter value having the given name to the provided value.
|
void |
ScheduleContext.setStartTime(Date value)
Set the start time, e.g. to generate an old version of the project.
|
void |
DeployTask.setTarget(DeployTarget target)
Set the deployment target (e.g.
|
void |
DeployTask.setType(DeployTask.Type type)
Provide the
used for deployment |
void |
GenerateTask.setType(GenerateTask.Type type)
Provide the
used for this GenerateTask . |
void |
WebServerConfiguration.setType(WebServerConfiguration.Type type)
Deprecated.
since 5.0 - no replacement
|
void |
GenerateTask.setUrlCreatorSpecification(UrlCreatorSpecification value)
Set the url creator specifiaction.
|
void |
ScriptTask.setUseCustomConnection(String login,
String password)
Use a custom user
Connection to execute this script. |
void |
ScriptTask.setUseCustomConnection(String login,
String password)
Use a custom user
Connection to execute this script. |
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 |
---|---|
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.
|
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 |
---|---|
Set<de.espirit.firstspirit.storage.Contrast> |
IDProvider.contrastWith(IDProvider reference)
Contrast the element with another one.
|
static EnumSet<IDProvider.UidType> |
IDProvider.UidType.forStoreType(Store.Type storeType)
Fetch all the uid types for a given store type.
|
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. |
List<DeletedElementsInfo> |
Store.getDeletedChildren()
Returns a list of deleted children described by the containing
ElementInfo objects. |
List<DeletedElementsInfo> |
Store.getDeletedChildren(long startRevisionId,
int resultCount)
Returns a list of deleted children described by the containing
ElementInfo objects. |
List<DeletedElementsInfo> |
Store.getDeletedChilds()
Deprecated.
since 5.0.100 - use
Store.getDeletedChildren() instead |
List<DeletedElementsInfo> |
Store.getDeletedChilds(long startRevisionId,
int resultCount)
Deprecated.
since 5.0.100 - use
Store.getDeletedChildren(long,int) instead |
Set<Long> |
DeleteProgress.getDeletedElements()
Deprecated.
Returns a set of ID's of all successfully deleted elements since the last progress poll.
|
Set<Long> |
DeleteProgress.getDeleteFailedElements()
Deprecated.
Returns a set of ID's of all elements which couldn't be deleted because of unexpected errors during delete.
|
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.
|
String |
ContentProducer.getFilename()
Get a file or link name for this content producer; without path information and extension, e.g.
|
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. |
Set<Long> |
DeleteProgress.getLockFailedElements()
Deprecated.
Returns a set of ID's of all elements which couldn't be locked for delete
|
Set<Long> |
DeleteProgress.getMissingPermissionElements()
Deprecated.
Returns a set of ID's of all elements which couldn't be deleted cause of missing delete permissions.
|
String |
BasicInfo.getName()
Returns a symbolic name for this info object.
|
String |
StoreElement.getName() |
Set<Long> |
DeleteProgress.getNonChangeablePackagePoolItems()
Deprecated.
Returns a set of ID's of all elements which couldn't be deleted cause they are
package pool items and belong to a non
changeable subscription |
ReferenceEntry[] |
StoreElement.getOutgoingReferences()
Returns all outgoing references of this
StoreElement . |
PageParams |
MultiPageParams.getPageParams(Map<String,?> params)
If the provided map contains the parameter "index" mapped to a number (or a string wich can be converted to a
number) the PageParams for the corresponding index is returned.
|
String |
PageParams.getPageSuffix() |
String |
PageParams.getPreviewSuffix() |
EnumMap<ReleaseProgress.ProblemType,Set<Long>> |
ReleaseProgress.getProblematicElements()
Deprecated.
since 5.2.180606, use
ReleaseOperation instead |
Set<Long> |
DeleteProgress.getReferencedElements()
Deprecated.
Returns a set of ID's of all elements which couldn't be deleted cause of existing incoming references.
|
Store |
StoreElement.getStore()
Provides the store related to the element.
|
Store.Type |
IDProvider.UidType.getStoreType() |
de.espirit.storage.Type |
IDProvider.UidType.getType() |
Class<StoreElement> |
StoreElementFilter.getType()
Get the filter type.
|
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 ! |
String |
Data.toXml()
Deprecated.
since 5.2.21 - see type
|
Modifier and Type | Method and Description |
---|---|
void |
StoreElement.appendChildBefore(StoreElement child,
StoreElement nextsibling)
Deprecated.
since 4.2.204 - use
IDProvider#moveChild(child, nextsibling) |
void |
ContentProducer.createContent(GenerationContext gc,
PageParams params) |
void |
ContentProducer.createContent(GenerationContext gc,
PageParams params) |
static <T> Filter.TypedFilter<T> |
StoreElementFilter.createIncludeFilter(Class<T> type,
Class<? extends T>... includes)
Creates and returns a class based type filter with an additional include filtering of the specified sub classes.
|
<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.
|
String |
ContentProducer.getExtension(TemplateSet templateSet)
Get the file / url extension for this content producer, e.g.
|
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 |
MultiPageParams |
Data.getMultiPageParams(Language language)
Deprecated.
Since 5.0.104, no replacement.
|
MultiPageParams |
MultiPageParamsProvider.getMultiPageParams(Language language) |
MultiPageParams |
ContentProducer.getMultiPageParams(Language language,
TemplateSet templateSet) |
MultiPageParams |
ContentProducer.getMultiPageParams(Language language,
TemplateSet templateSet) |
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.
|
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(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 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 |
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 |
String |
ContentProducer.getUrl(UrlCreatorProvider urlCreatorProvider,
Language lang,
TemplateSet templateSet,
PageParams pageParams,
int mode)
Create an url for this node using the specified
urlCreatorProvider ,
language , template set , and pageParams (sub page). |
String |
ContentProducer.getUrl(UrlCreatorProvider urlCreatorProvider,
Language lang,
TemplateSet templateSet,
PageParams pageParams,
int mode)
Create an url for this node using the specified
urlCreatorProvider ,
language , template set , and pageParams (sub page). |
String |
ContentProducer.getUrl(UrlCreatorProvider urlCreatorProvider,
Language lang,
TemplateSet templateSet,
PageParams pageParams,
int mode)
Create an url for this node using the specified
urlCreatorProvider ,
language , template set , and pageParams (sub page). |
String |
ContentProducer.getUrl(UrlCreatorProvider urlCreatorProvider,
Language lang,
TemplateSet templateSet,
PageParams pageParams,
int mode)
Create an url for this node using the specified
urlCreatorProvider ,
language , template set , and pageParams (sub page). |
void |
IDProvider.revert(Revision revision,
boolean recursive,
EnumSet<IDProvider.RevertType> ignoreRevertTypes)
Reverts this store element to the given FSRevision.
|
void |
IDProvider.revert(Revision revision,
boolean recursive,
EnumSet<IDProvider.RevertType> ignoreRevertTypes)
Reverts this store element to the given FSRevision.
|
void |
IDProvider.setDisplayName(Language language,
String displayName)
Sets the display name (label) for the specified language.
|
void |
IDProvider.setUid(String uid)
Sets the unique identifier.
|
Modifier and Type | Method and Description |
---|---|
Dataset |
DatasetProvider.createDataset()
Creates a new entity with the entity type of this dataset provider and returns a new dataset for this entity.
|
Content2Params |
Content2.getContent2Params()
Returns the params of this content2.
|
Dataset |
Content2.getDataset(Entity entity)
Get a dataset for the given entity.
|
Dataset |
DatasetProvider.getDataset(Entity entity)
Get a dataset for the given entity.
|
Entity |
Dataset.getEntity()
Get the entity bound to this data set.
|
EntityType |
Content2.getEntityType()
Returns the entity type this content2 belongs to.
|
EntityType |
DatasetProvider.getEntityType()
Get the entity type supported by this dataset provider.
|
String |
ContentFolder.getName()
Get the name of the ContentStore-folder
|
Schema |
Content2.getSchema()
Returns the schema this content2 refers to.
|
Schema |
DatasetProvider.getSchema()
Get the schema the provider refers to.
|
TableTemplate |
Dataset.getTableTemplate()
Returns the template of this element.
|
TableTemplate |
Content2.getTemplate()
Returns the
TableTemplate of this content2 node. |
Modifier and Type | Method and Description |
---|---|
List<? extends Entity> |
Content2.getData(Language language)
Deprecated.
since 5.1.102, use
Content2.getDatasets(Language) . |
List<? extends Entity> |
Content2ScriptContext.getData(Language language)
Returns the list of entities respecting defined filter and ordering of the underlying
Content2 element. |
Dataset |
Content2.getDataset(Entity entity)
Get a dataset for the given entity.
|
Dataset |
DatasetProvider.getDataset(Entity entity)
Get a dataset for the given entity.
|
Dataset |
DatasetProvider.getDataset(Entity entity,
Revision revision)
Get a dataset for the given entity in a defined revision.
|
Dataset |
DatasetProvider.getDataset(Entity entity,
Revision revision)
Get a dataset for the given entity in a defined revision.
|
List<Dataset> |
Content2.getDatasets(Language language)
Returns the list of datasets respecting defined filter and ordering.
|
Modifier and Type | Method and Description |
---|---|
Collection<IdProvidingFormData> |
MediaFormsProducer.create(MediaFolder mediaFolder)
Creates new form data objects for all direct
media elements in the given media folder . |
Modifier and Type | Method and Description |
---|---|
List<String> |
URLProperties.getAlternativeUrls(ContentProducer node,
Language language,
TemplateSet templateSet)
Get the list of alternative URLs for the specified parameter set.
|
GlobalContentArea |
GlobalStoreRoot.getGlobalContentArea()
Get the
global content area node. |
String |
GCAFolder.getName()
Get the name of the GCA-folder
|
ProjectProperties |
GlobalStoreRoot.getProjectProperties()
Returns the project property page.
|
PageTemplate |
ProjectProperties.getTemplate()
Returns the template for this project properties or throws a
ReferenceNotFoundException if no template is defined or
defined template couldn't be found. |
URLProperties |
GlobalStoreRoot.getUrlProperties()
Get the url properties node.
|
Modifier and Type | Method and Description |
---|---|
List<String> |
URLProperties.getAlternativeUrls(ContentProducer node,
Language language,
TemplateSet templateSet)
Get the list of alternative URLs for the specified parameter set.
|
List<String> |
URLProperties.getAlternativeUrls(ContentProducer node,
Language language,
TemplateSet templateSet)
Get the list of alternative URLs for the specified parameter set.
|
List<String> |
URLProperties.getAlternativeUrls(ContentProducer node,
Language language,
TemplateSet templateSet)
Get the list of alternative URLs for the specified parameter set.
|
String |
URLProperties.getStoredUrl(ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for the specified parameters set.
|
String |
URLProperties.getStoredUrl(ContentProducer node,
Language language,
TemplateSet templateSet,
Object multiPageObject)
Get the stored URL for the specified parameters set.
|
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(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.
|
String |
URLProperties.getStoredUrl(SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
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.
|
int |
URLProperties.resetStoredUrls(IDProvider node)
Reset the stored URLs for the specified node.
|
void |
URLProperties.setAlternativeUrls(Collection<String> urls,
ContentProducer node,
Language language,
TemplateSet templateSet)
Set the list of alternative URLs for the specified parameter set.
|
void |
URLProperties.setAlternativeUrls(Collection<String> urls,
ContentProducer node,
Language language,
TemplateSet templateSet)
Set the list of alternative URLs for the specified parameter set.
|
void |
URLProperties.setAlternativeUrls(Collection<String> urls,
ContentProducer node,
Language language,
TemplateSet templateSet)
Set the list of alternative URLs for the specified parameter set.
|
void |
URLProperties.setAlternativeUrls(Collection<String> urls,
ContentProducer node,
Language language,
TemplateSet templateSet)
Set the list of alternative URLs 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,
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,
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,
SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
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 |
URLProperties.setStoredUrl(String url,
SiteStoreFolder folder,
Language language,
TemplateSet templateSet)
Set the stored URL for the specified parameter set.
|
Modifier and Type | Method and Description |
---|---|
String |
Media.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
MediaFolder.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
PictureResolution.getName()
Returns the name of the underlying resolution
(e.g.
|
PictureResolution |
Picture.getPictureResolution(Resolution resolution)
Get the picture-resolution of the current picture-media for given resolution as an object
|
IDProvider.UidType |
Media.getUidType()
Return
Media.UID_TYPE . |
Modifier and Type | Method and Description |
---|---|
Media |
MediaStoreRoot.getMediaByUid(String uid)
Returns the media specified by given
uid or null ,
if no media was found with given uid |
void |
Media.makeLanguageIndependent(Language toKeep)
Makes this media language independent.
|
void |
UploadRejectedException.setStoreElement(IDProvider storeElement)
Set upload rejecting @{link IDProvider}.
|
Constructor and Description |
---|
UploadRejectedException(String message)
Create a new exception instance with the given message.
|
UploadRejectedException(String message,
Throwable cause)
Create a new exception instance with the given message and cause.
|
Modifier and Type | Method and Description |
---|---|
FormData |
DataProvider.getFormData()
Gets the
formdata container of this element. |
String |
Body.getName()
Get the name of a body for a Page
|
String |
Page.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
PageFolder.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
Section.getName()
Get the name of the section
|
Section<T> |
SectionReference.getReference()
Return the referenced source
Section . |
TableTemplate |
Content2Section.getTableTemplate()
Returns the
table template this content section belongs to. |
TableTemplate |
Content2Section.getTemplate()
Returns the template of this element.
|
PageTemplate |
Page.getTemplate()
Returns the template of this element.
|
T |
Section.getTemplate()
Returns the template of this element.
|
Modifier and Type | Method and Description |
---|---|
ContentMultiPageParams |
Content2Section.getMultiPageParams(Language language)
Delivers a
ContentMultiPageParams where
ContentMultiPageParams.getData() delivers a
list with one entry. |
void |
DataProvider.setFormData(FormData formData)
Sets the given
formdata container of this element. |
void |
Page.setTemplate(PageTemplate pageTemplate)
Set the template for this page.
|
void |
SectionReference.setTemplate(SectionTemplate template)
Throws an
UnsupportedOperationException . |
void |
Section.setTemplate(T template)
Set the template for this section.
|
void |
Content2Section.setTemplate(TableTemplate template)
Throws an
UnsupportedOperationException as changing the template is not supported. |
Modifier and Type | Method and Description |
---|---|
PageRefFolder |
SiteStoreFolder.createPageRefFolder(String uid,
Map<Language,String> lang2DisplayName,
boolean unifyNameOnServer,
IDProvider nextSibling)
Create a new PageRefFolder as child of this folder and place it before the given next sibling.
|
de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl |
PageLangSpec.createScheduledPageRef(Page page,
Date validFrom)
Creates and adds a scheduled page-ref.
|
FormField<String> |
SiteStoreVariableFormData.get(Language language,
String fieldName)
Provides a property container describing the field with the given name.
|
EntityList |
ContentMultiPageParams.getData()
Provides the records for output.
|
String |
DocumentGroup.getFilename()
Provides the file name of this group.
|
String |
PageRef.getFilename()
Returns a filename suggestions which may be used for creating urls.
|
FolderLangSpec |
PageRefFolder.getFolderLangSpec(Language language)
Get the folder specification for the given language
|
SiteStoreVariableFormData |
SiteStoreFolder.getFormData()
Gets a form data container containing containig all defined sitestore variables.
|
MultiPageParams |
Content2Params.getMultiPageParams(Language language)
Provides the multi page parameters stored for the given language.
|
String |
PageGroup.getName()
Get the name of the page-group
|
String |
PageLangSpec.getName()
Get the name of the pagereference
|
String |
PageRef.getName()
Deprecated.
since 4.1.10 - use
PageRef.getUid() |
PageParams |
ContentMultiPageParams.getPageParams(Map<String,?> params)
Provides the parameters based on the given options.
|
List<AltPageRef> |
PageLangSpec.getScheduledPageRefs()
Returns a modifiable list of scheduled page-refs.
|
Select |
Content2Params.getSelect(Language language)
Provides the select statement for the given language to request records.
|
String |
PageRef.getUid()
Get the unique referenec name of the pagereference.
|
IDProvider.UidType |
DocumentGroup.getUidType()
Return
DocumentGroup.UID_TYPE . |
IDProvider.UidType |
PageRef.getUidType()
Return
PageRef.UID_TYPE . |
Modifier and Type | Method and Description |
---|---|
void |
Content2Params.addOrdering(String columnName,
boolean ascending,
boolean languageDependent)
Adds an ordering to this parameters for the named column.
|
void |
DocumentGroup.appendChildBefore(StoreElement child,
StoreElement before)
Appends a child element to this group, inserting it before a reference element.
|
de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl |
PageLangSpec.createScheduledPageRef(Page page,
Date validFrom)
Creates and adds a scheduled page-ref.
|
de.espirit.firstspirit.store.access.sitestore.AltPageRefImpl |
PageLangSpec.createScheduledPageRef(Page page,
Date validFrom)
Creates and adds a scheduled page-ref.
|
MultiPageParams |
Content2Params.getMultiPageParams(Language language)
Provides the multi page parameters stored for the given language.
|
Select |
Content2Params.getSelect(Language language)
Provides the select statement for the given language to request records.
|
String |
SiteStoreFolder.getStoredUrl(Language language,
TemplateSet templateSet)
Get the stored URL for this node and the provided combination of language and template set.
|
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.
|
String |
SiteStoreRoot.getStoredUrl(Language language,
TemplateSet templateSet)
Get the stored URL for this node and the provided combination of language and template set.
|
void |
AltPageRef.setPage(Page page)
Set the page from PageStore that will be alternative page for an pagereference
|
void |
AltPageRef.setValidFrom(Date date)
Set the date from that the this alternative page is valid
|
Constructor and Description |
---|
ContentMultiPageParams(Session session,
Select select,
int entitesPerPage,
int maxPageCount,
Date time)
Constructor based on some restrictions.
|
ContentMultiPageParams(Session session,
Select select,
int entitesPerPage,
int maxPageCount,
Date time)
Constructor based on some restrictions.
|
Modifier and Type | Method and Description |
---|---|
List<? extends TemplateBody> |
PageTemplate.getBodies()
Returns the list of
template bodies which are defined in this template. |
StyleTemplateLink.Region |
StyleTemplateLink.getColumnRegion()
Returns the column
region set for this rule. |
EntityType |
TableTemplate.getEntityType()
Provides the entity type (the db table) this template bases upon.
|
ReferenceEntry[] |
Schema.getIncomingReferences(Entity entity)
Returns current incoming references of the given
entity . |
ReferenceEntry[] |
Schema.getIncomingReferences(Entity entity,
boolean release)
Returns current or release incoming references of the given
entity . |
TableTemplate.Mapping[] |
TableTemplate.getMappings()
Shortcut for
getMappings(false) |
TableTemplate.Mapping[] |
TableTemplate.getMappings(boolean release)
Provides an array of
TableTemplate.Mapping s, whose entries are safe to change with no feedback to this template. |
String |
LinkTemplate.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
Query.getName()
Deprecated.
since 4.1.10 - use
IDProvider.getUid() |
String |
Script.getName()
Provides the name of the script.
|
String |
TemplateBody.getName()
Returns the name of the belonging body defined in the belonging page template.
|
String |
TemplateFolder.getName()
Get the name of this folder
|
ReferenceEntry[] |
Schema.getOutgoingReferences(Entity entity)
Returns current outgoing references of the given
entity . |
ReferenceEntry[] |
Schema.getOutgoingReferences(Entity entity,
boolean release)
Returns current or release outgoing references of the given
entity . |
StyleTemplateLink.Region |
StyleTemplateLink.getRowRegion()
Returns the row
region set for this rule. |
String |
RulesetContainer.getRulesetDefinition()
Provide the textual definition of this container's rule set.
|
Schema |
TableTemplate.getSchema()
Gets the schema.
|
Session |
Schema.getSession()
Returns the current
or session
Same as getSession(false) . |
Session |
Schema.getSession(boolean release)
Returns the
or session . |
Snippet |
SnippetContainer.getSnippet()
Get a snippet defining object.
|
T |
TemplateProvider.getTemplate()
Returns the template of this element.
|
TemplateExtension |
MasterTemplate.getTemplateExtension(TemplateSet set)
Returns the template extension object for the given
template set . |
Transition[] |
WorkflowScriptContext.getTransitions()
Returns all Transitions allowed for the current user, which points FROM the underlying
activity . |
IDProvider.UidType |
Query.getUidType()
Returns
Query.UID_TYPE . |
IDProvider.UidType |
Script.getUidType()
Returns the value of
Script.UID_TYPE . |
IDProvider.UidType |
TableTemplate.getUidType()
Returns
TableTemplate.UID_TYPE . |
String |
Script.getViewScript()
Returns the view script defined for this script or an empty string.
|
WorkflowContext |
WorkflowScriptContext.getWorkflowContext()
Return the current workflow context.
|
Modifier and Type | Method and Description |
---|---|
StyleTemplateLink |
TableFormatTemplate.addLink(StyleTemplate template)
Provide a
StyleTemplate which should be used for table cells
defined in the returned StyleTemplateLink |
Allowed |
PageTemplate.createAllowed(String bodyName,
Template template)
Set a section or table template which should be allowed for this template for a given body
|
Allowed |
PageTemplate.createAllowed(String bodyName,
Template template)
Set a section or table template which should be allowed for this template for a given body
|
Allowed |
PageTemplate.createAllowed(TemplateBody body,
MasterTemplate template)
Creates a new allowed node for the given section- or table template which should be allowed for the given body
|
Allowed |
PageTemplate.createAllowed(TemplateBody body,
MasterTemplate template)
Creates a new allowed node for the given section- or table template which should be allowed for the given body
|
LinkTemplate |
LinkTemplates.createTemplate(String uid)
Create a new template in this folder.
|
PageTemplate |
PageTemplates.createTemplate(String uid)
Create a new template in this folder.
|
SectionTemplate |
SectionTemplates.createTemplate(String uid)
Create a new template in this folder.
|
T |
TemplateContainer.createTemplate(String uid)
Create a new template in this folder.
|
LinkTemplate |
LinkTemplates.createTemplate(String uid,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
PageTemplate |
PageTemplates.createTemplate(String uid,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
SectionTemplate |
SectionTemplates.createTemplate(String uid,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
T |
TemplateContainer.createTemplate(String uid,
boolean unifyNamesOnServer)
Create a new template in this folder.
|
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)
Create a new sub-folder in this folder
|
TemplateFolder<PageTemplate> |
PageTemplates.createTemplateFolder(String name)
Create a new sub-folder in this folder
|
TemplateFolder<SectionTemplate> |
SectionTemplates.createTemplateFolder(String name)
Create a new sub-folder in this folder
|
TemplateFolder<T> |
TemplateContainer.createTemplateFolder(String name)
Create a new sub-folder 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
|
static StyleTemplateLink.Region |
StyleTemplateLink.Region.forName(String name)
Provides a region for the given name.
|
List<MasterTemplate> |
PageTemplate.getAllowedTemplates(TemplateBody templateBody)
Get the list of
section- or table templates which are allowed for this page template for the given template body. |
FormatTemplateChannel |
FormatTemplate.getChannel(TemplateSet templateSet)
Provides the channel specifica with respect to the given template set.
|
String |
ChannelSourceProvider.getChannelSource(TemplateSet templateSet)
Get the source for the channel specified by the given templateset.
|
LinkTemplate |
LinkTemplates.getTemplate(String uid)
Returns page template with the given uid or
null . |
PageTemplate |
PageTemplates.getTemplate(String uid)
Returns page template with the given uid or
null . |
SectionTemplate |
SectionTemplates.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 . |
TemplateDocument |
TemplateContentProvider.getTemplateDocument(TemplateSet templateSet)
Get a document for a template set for the given channel.
|
boolean |
PageTemplate.isTemplateAllowed(TemplateBody templateBody,
MasterTemplate template)
Indicates whether the given template is allowed for the given
body or not. |
boolean |
PageTemplate.isTemplateAllowed(TemplateBody templateBody,
MasterTemplate template)
Indicates whether the given template is allowed for the given
body or not. |
void |
ChannelSourceProvider.setChannelSource(TemplateSet templateSet,
String source)
Sets the given source for the template channel specified by the given template set
|
void |
StyleTemplateLink.setColumnRegion(StyleTemplateLink.Region region)
Provide the column
region to be used for this rule. |
void |
TemplateBody.setName(String name)
Sets the name parameter of this TemplateBody
|
void |
StyleTemplateLink.setRowRegion(StyleTemplateLink.Region region)
Provide the row
region to be used for this rule. |
void |
RulesetContainer.setRulesetDefinition(String definition)
Sets the given
definition of rule sets. |
void |
SnippetContainer.setSnippet(Snippet snippet)
Set the snippet as defined in the given object.
|
void |
StyleTemplateLink.setTargetTemplate(StyleTemplate styleTemplate)
Provide the
StyleTemplate to be linked to. |
void |
FormatTemplate.setUid(String value)
The uid of format templates is used as tag name in dom and dom-table instances.
|
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.
|
Iterable<GomFormElement> |
GomEditorProvider.forms()
Returns an iterable on all form elements within this provider.
|
String |
GomIncludeValueProvider.getKey(T value)
Return a unique key for a specific value.
|
GomEditorProvider |
GomCheckable.Context.getProvider()
Gets the form defining editor provider.
|
Class<T> |
GomIncludeValueProvider.getType()
The generic content type (see
GomIncludeValueProvider.getValues(SpecialistsBroker) and String getKey(T) ). |
UserService |
GomCheckable.Context.getUserService()
Deprecated.
since 5.2.5, use
SpecialistsBroker.requestSpecialist(SpecialistType) or
SpecialistsBroker.requireSpecialist(SpecialistType) instead. |
List<T> |
GomIncludeValueProvider.getValues(SpecialistsBroker broker)
Get the list of included values.
|
String |
AbstractGomFormElement.name()
Provides the textual name of this form element.
|
String |
GomFormElement.name()
Get the name of this form element.
|
Modifier and Type | Method and Description |
---|---|
Range |
GomValidationError.findPosition(String text,
int start)
Find the position causing this exception within the given text from the given start on.
|
String |
GomIncludeValueProvider.getKey(T value)
Return a unique key for a specific value.
|
List<T> |
GomIncludeValueProvider.getValues(SpecialistsBroker broker)
Get the list of included values.
|
void |
AbstractGomFormElement.setLabelAndDescription(String lang,
String label,
String description)
Sets the label and description for a specific language.
|
void |
Parameterizable.setParameters(Map<String,String> parameters)
Sets the parameters generically defined for this object.
|
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.
|
Item(String name)
Constructor taking the item's name.
|
Modifier and Type | Method and Description |
---|---|
List<Long> |
ExternalFormsProducer.find(String query)
Find method, delivers a list of ids where the content matches the given query.
|
Modifier and Type | Method and Description |
---|---|
<T> DataAccessSession<T> |
GomIndexSource.createSession(SpecialistsBroker broker,
boolean release)
Creates a session based on the definition and configuration of this source.
|
Modifier and Type | Method and Description |
---|---|
<T> DataAccessSession<T> |
GomIndexSource.createSession(SpecialistsBroker broker,
boolean release)
Creates a session based on the definition and configuration of this source.
|
Modifier and Type | Method and Description |
---|---|
MathContext |
MathematicalContext.getMathContext()
Provides the defined mathematical context.
|
Modifier and Type | Method and Description |
---|---|
void |
MathematicalContext.setMathContext(MathContext value)
Sets the matthematical context
|
void |
MathematicalContext.setRoundingMode(RoundingMode mode)
Sets the rounding mode for this context.
|
Modifier and Type | Method and Description |
---|---|
RenderingAgent.Renderer |
RenderingAgent.Renderer.additionalContext(Map<String,?> additionalContext)
Adds the provided values to the topmost context.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.additionalContext(String key,
Object value)
Adds the provided value to the top-most context.
|
Iterable<IDProvider> |
QueryAgent.answer(String query)
Answers a given query by giving iterable access to matching FirstSpirit elements.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.context(PageRef pageRef)
Set the provided page reference as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.context(SiteStoreFolder folder)
Set the provided folder as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
RenderingAgent.createRenderer(IDProvider node)
Create a content renderer for the provided node.
|
RenderingAgent.RendererWithoutLinkRoot |
RenderingAgent.createRenderer(String templateSource)
Create a renderer for a template source string.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.dataset(Dataset dataset)
Provide a dataset to be used for a content projection.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.datasetIdentifier(Identifier identifier)
Provide a dataset to be used for a content projection (e.g. detail view, one entity per page).
|
String |
PasswordAgent.decryptPassword(String namespace,
String password)
Decrypts a password.
|
InputStream |
ModuleAdminAgent.downloadWebApp(WebAppId webAppId)
Download the specified web app as
.war -file. |
String |
PasswordAgent.encryptPassword(String namespace,
String password)
Encrypts a password.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.evaluateProjectProperties(boolean value)
Switch flag if the
ProjectProperties should be evaluated when rendering content . |
SnippetAgent.Fallback |
SnippetAgent.Fallback.extractNone()
Set to not provide any fallback for extract snippet.
|
SnippetAgent.Fallback |
SnippetAgent.fallback()
Creates a new fallback configuration object with its default strategies in place.
|
T |
PreviewUrlAgent.PreviewUrlBuilder.forWebedit()
Configures the builder to create urls for the ContentCreator application.
|
T |
PreviewUrlAgent.PreviewUrlBuilder.fullQualified()
Configures the builder to create full qualified urls like 'http://domain:port/path/'.
|
Collection<MaintenanceModeInfo> |
MaintenanceModeAgent.getActiveMaintenanceModes()
A maintenance mode task is active if one of the stages mentioned
in
MaintenanceModeTask.MaintenanceStage is active. |
Set<String> |
ServerConfigurationAgent.getAllowedRedirectHosts()
In order to prevent redirections to potentially malicious hosts, a whitelist of
allowed host names can be configured for the FirstSpirit server.
|
Image |
UIAgent.getApplicationIcon()
Provides the current application icon.
|
Window |
UIAgent.getApplicationWindow()
Provide the application window.
|
String |
RenderingAgent.RenderResult.getContent()
The rendered content.
|
String |
UIAgent.getDescription(Resolution resolution)
Provides the description for the given resolution according to the currently set UI language and display mode.
|
Language |
UIAgent.getDisplayLanguage()
Provides the currently set language to be used for displaying UI elements.
|
String |
UIAgent.getDisplayName(IDProvider element)
Determines the display name for the given id providing store element according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(Language language)
Determines the display name for the given language according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(Resolution resolution)
Determines the display name for the given resolution according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(TemplateSet templateSet)
Provides the display name for the given template set according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(WorkflowElement workflowElement)
Provides the display name for the given workflow element according to the currently set UI language and display mode.
|
IDProvider |
ElementValidationReport.getElement()
Deprecated.
since 5.0.311, use
ElementValidationReport.getElement(SpecialistsBroker) instead. |
IDProvider |
ElementValidationReport.getElement(SpecialistsBroker broker)
Get the element this report is generated for.
|
BasicElementInfo |
UrlAgent.UrlEntry.getElementInfo()
Returns a
BasicElementInfo for this url entry. |
String[] |
ProjectRestriction.getFolders(Store.Type type)
Retrieves the folder restrictions for the given type.
|
Form |
FormsAgent.getForm(String formDefinition)
Produces a form container for the given definition.
|
Set<String> |
FormValidationReport.getGadgets()
Provides the names of gadgets being reported containing one or more issues.
|
String |
GlobalWebAppId.getGlobalId()
Returns the global web-app identifier.
|
Collection<GlobalWebAppId> |
ModuleAdminAgent.getGlobalWebApps()
Returns all configurable global web-apps.
|
Collection<GlobalWebAppId> |
ModuleAdminAgent.getGlobalWebApps(boolean includeSystem)
Returns all configurable global web-apps with the option to include the ones from the system.
|
String |
LegacyModuleAgent.getGlobalWebAppUrl(String webAppId)
Returns the absolute url to the specified global web-app.
|
String |
LegacyModuleAgent.getGlobalWebAppUrl(String webAppId,
boolean createTicket)
Returns the absolute url to the specified global web-app (with or w/o a FS SSO ticket).
|
List<Group> |
ProjectMembersAgent.getGroups()
Get all groups of the current project.
|
String |
DataSnippet.getHeader()
Provides the header text being used as a short representation of the given object.
|
ImageIcon |
UIAgent.getIcon(IDProvider element)
Provides an icon for the given id providing store element.
|
String |
ModuleAdminAgent.getInstalledVersion(String moduleName)
Returns the version of the given module.
|
Collection<Language> |
MultiFormValidationReport.getLanguages()
Deprecated.
since 5.0.311, use
MultiFormValidationReport.getLanguages(SpecialistsBroker) instead. |
Collection<Language> |
MultiFormValidationReport.getLanguages(SpecialistsBroker broker)
Provides the languages being reported containing problems, not including meta data problems.
|
Locale |
ApplicationAgent.getLocale()
Provides the locale, the application is operating in.
|
String |
RenderingAgent.RenderResult.getLog()
The log produced during rendering.
|
Collection<String> |
FormValidationReport.getMessages(String gadget,
Language displayLanguage)
Get the messages produced for the given gadget.
|
Template |
ProjectAgent.getMetaDataTemplate()
Provides the meta data template.
|
Language |
LanguageAgent.getMetaLanguage()
Provide the language being used for meta data representation.
|
ServerInformationAgent.VersionInfo.Mode |
ServerInformationAgent.VersionInfo.getMode()
Returns the mode which is currently active.
|
Collection<ModuleDescriptor> |
ModuleAdminAgent.getModules()
Return descriptors of all installed modules.
|
String |
UrlAgent.UrlEntry.getPath()
Returns the url path for this url entry.
|
FileSystem<?> |
LegacyModuleAgent.getProjectAppConfig(String moduleName,
String projectAppName,
long projectId)
Deprecated.
|
FileSystem<?> |
ModuleAdminAgent.getProjectAppConfig(String moduleName,
String projectAppName,
Project project)
Returns an access to the project-app configuration directory; read-write-access if the user is project admin,
read-only-access if the user is project user, otherwise a
SecurityException will be thrown. |
Properties |
LegacyModuleAgent.getProjectAppConfigProperties(String propertiesFileName,
String moduleName,
String projectAppName,
long projectId)
Helper method to obtain
properties from the project app configuration
specified by given modulename, projectAppName and project id. |
Collection<Project> |
ModuleAdminAgent.getProjectAppUsages(String moduleName,
String projectAppName)
Returns ids of all projects using the specified project application.
|
String |
LegacyModuleAgent.getProjectWebAppUrl(WebEnvironment.WebScope scope,
long projectId,
boolean createTicket)
Returns the absolute url to the specified project-local web-app (with or w/o a FS SSO ticket).
|
String |
ServerInformationAgent.VersionInfo.getReleaseName()
Returns the release name of the belonging FirstSpirit version.
|
Map<String,RemoteProjectConfiguration> |
ProjectAgent.getRemoteProjectConfigurations(Filter<RemoteProjectConfiguration> remoteCondition)
Get the configurations of remote projects defined.
|
RenderingAgent.RenderResult |
RenderingAgent.Renderer.getResult()
Trigger the rendering of the node and delivers the rendering result.
|
RunLevel |
RunLevelAgent.getRunLevel()
Returns the current
RunLevel of the FirstSpirit server. |
Collection<UrlAgent.UrlEntry> |
UrlAgent.getSEOUrls()
Returns a
collection of all SEO urls for this project. |
ServerConfiguration |
ServerConfigurationAgent.getServerConfiguration()
Returns an instance of the current server configuration, including access to the
Web Start Configuration and Quickstart s. |
FileSystem<?> |
ModuleAdminAgent.getServiceConfig(String serviceName)
Provides access to the configuration of a service.
|
Collection<UrlAgent.UrlEntry> |
UrlAgent.getShortUrls()
Returns a
collection of all short urls for this project. |
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet,
SnippetContext context)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(IDProvider element)
Hands out a snippet provider for the given element or
null , if no snippet provider is available. |
SnippetProvider |
SnippetAgent.getSnippetProvider(IDProvider element,
SnippetAgent.Fallback fallback)
Hands out a snippet provider for the given element applying the given fallback strategy.
|
Store |
StoreAgent.getStore(Store.Type type)
Get the store of the requested type on elements in current state.
|
Store |
StoreAgent.getStore(Store.Type type,
boolean release)
Get the store of the requested type.
|
Store.Type |
SnippetContext.getStoreType()
Provide the store type to create a snippet for.
|
Set<ScheduleTaskFactory<? extends ScheduleTaskFactory.TaskDto,? extends ScheduleTask>> |
ScheduleTaskAgent.getTaskFactories()
Get all available
ScheduleTaskFactory s. |
List<TemplateSet> |
ProjectAgent.getTemplateSets()
Get a list of available template sets.
|
Collection<Project> |
ModuleAdminAgent.ModuleResult.getUpdatedProjectApps()
Returns the projects where project-app components are updated.
|
Collection<WebAppId> |
ModuleAdminAgent.ModuleResult.getUpdatedWebApps()
Returns the ids of all updated web-app components.
|
String |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrl(ContentProducer contentProducer)
|
String |
PreviewUrlAgent.MediaPreviewUrlBuilder.getUrl(Media media)
Returns the URL-String for the Media.
|
PreviewUrl |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrlObject(ContentProducer contentProducer)
|
Collection<Group> |
ProjectMembersAgent.getUserGroups(User user)
Get all project groups where the provided user is a member of.
|
List<User> |
ProjectMembersAgent.getUsers()
Get all users of the current project.
|
FileSystem<?> |
ModuleAdminAgent.getWebAppConfig(String moduleName,
String webAppComponent,
WebAppId webAppId)
Returns the configuration directory of the specified web-app.
|
Collection<WebAppId> |
ModuleAdminAgent.getWebAppUsages(String moduleName,
String webAppComponent)
Returns all usages of the given web-app component.
|
WebEnvironment.WebScope |
ProjectWebAppId.getWebScope()
Returns web-scope.
|
SnippetAgent.Fallback |
SnippetAgent.Fallback.headerNone()
Set to not provide any fallback for header snippet.
|
ModuleAdminAgent.ModuleResult |
ModuleAdminAgent.install(InputStream fsmStream,
boolean updateUsages)
Installs or updates the given module.
|
ModuleAdminAgent.ModuleResult |
ModuleAdminAgent.install(InputStream fsmStream,
boolean updateUsages,
boolean deployWebApps)
Installs or updates the given module.
|
T |
PreviewUrlAgent.PreviewUrlBuilder.language(Language language)
Provide the language for which the url should be rendered.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.language(Language language)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.language(String abbreviation)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(Media media)
The provided node is used as starting point for relative links when evaluating the provided template source.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(PageRef pageRef)
The provided node is used as starting point for relative links when evaluating the provided template source.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(SiteStoreFolder folder)
The provided folder is used as starting point for relative links when evaluating the provided template source.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.logListener(LogListener logListener)
Provide the listener for log events during rendering.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.mediaLinkListener(RenderingAgent.MediaLinkListener mediaLinkListener)
Provide the listener for media link events during rendering.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.mode(RenderingAgent.RenderMode mode)
Set the desired
render mode . |
RenderingAgent.Renderer |
RenderingAgent.Renderer.pageIndex(int index)
Provide the sub-page index for content projections.
|
PreviewUrlAgent.ContentProducerPreviewUrlBuilder |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.pageParams(PageParams pageParams)
Sets the
PageParams to use for rendering the preview url. |
RenderingAgent.Renderer |
RenderingAgent.Renderer.preview()
Shortcut for
mode (PREVIEW ). |
RenderingAgent.Renderer |
RenderingAgent.Renderer.redirectTemplateLogToDefaultLog()
Redirect template logging to default log.
|
String |
RenderingAgent.Renderer.render()
Trigger the rendering of the node and delivers the rendered output.
|
default <S> S |
SpecialistsBroker.requireSpecialist(SpecialistType<S> type)
Require a specialist.
|
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 . |
RenderingAgent.Renderer |
RenderingAgent.Renderer.skipProjectProperties()
Switch off
ProjectProperties evaluation when rendering content . |
RenderingAgent.Renderer |
RenderingAgent.Renderer.strict()
Shortcut for
mode (STRICT ). |
RenderingAgent.Renderer |
RenderingAgent.Renderer.templateSet(String templateSetUid)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
PreviewUrlAgent.ContentProducerPreviewUrlBuilder |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.templateSet(TemplateSet templateSet)
Selects the
TemplateSet to use for rendering the preview url. |
RenderingAgent.Renderer |
RenderingAgent.Renderer.templateSet(TemplateSet templateSet)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactory(String publicName)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactory(UrlFactory urlFactory)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactorySettings(Map<String,String> urlFactorySettings)
Set custom initialization parameters (will be passed to
UrlFactory.init(Map, PathLookup) of the
configured url factory). |
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlPrefix(String urlPrefix)
Set the url prefix used for absolute urls generated with
$CMS_REF(..., abs:1)$ . |
RunLevel |
RunLevelAgent.waitForRunLevel(RunLevel runLevel,
Duration maxWaitDuration)
Wait until the FirstSpirit server reaches a
RunLevel or a timeout occurs. |
RenderingAgent.Renderer |
RenderingAgent.Renderer.webedit()
Shortcut for
mode (WEBEDIT ). |
Modifier and Type | Method and Description |
---|---|
RenderingAgent.Renderer |
RenderingAgent.Renderer.additionalContext(Map<String,?> additionalContext)
Adds the provided values to the topmost context.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.additionalContext(String key,
Object value)
Adds the provided value to the top-most context.
|
Iterable<IDProvider> |
QueryAgent.answer(String query)
Answers a given query by giving iterable access to matching FirstSpirit elements.
|
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.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.context(PageRef pageRef)
Set the provided page reference as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.context(SiteStoreFolder folder)
Set the provided folder as context (e.g. to provide the sitestore variables in the rendering context).
|
RenderingAgent.Renderer |
RenderingAgent.createRenderer(IDProvider node)
Create a content renderer for the provided node.
|
RenderingAgent.RendererWithoutLinkRoot |
RenderingAgent.createRenderer(String templateSource)
Create a renderer for a template source string.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.dataset(Dataset dataset)
Provide a dataset to be used for a content projection.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.datasetIdentifier(Identifier identifier)
Provide a dataset to be used for a content projection (e.g. detail view, one entity per page).
|
String |
PasswordAgent.decryptPassword(String namespace,
String password)
Decrypts a password.
|
String |
PasswordAgent.decryptPassword(String namespace,
String password)
Decrypts a password.
|
boolean |
ModuleAdminAgent.deployWebApp(WebAppId webAppId)
Deploys the given web app to its web-server.
|
boolean |
ModuleAdminAgent.deployWebApps(Iterable<WebAppId> webAppIds)
Deploys the given web apps to their corresponding web-servers.
|
String |
PasswordAgent.encryptPassword(String namespace,
String password)
Encrypts a password.
|
String |
PasswordAgent.encryptPassword(String namespace,
String password)
Encrypts a password.
|
SpecialistsBroker |
BrokerAgent.getBroker(String symbolicProjectName)
Try getting hold of a broker for a remote project registered under the given symbolic name.
|
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. |
String |
UIAgent.getDescription(Resolution resolution)
Provides the description for the given resolution according to the currently set UI language and display mode.
|
String |
UIAgent.getDescription(WorkflowElement workflowElement)
Provides the description for the given workflow element according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(IDProvider element)
Determines the display name for the given id providing store element according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(Language language)
Determines the display name for the given language according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(Resolution resolution)
Determines the display name for the given resolution according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(Store.Type type)
Provides the display name to be used for the given store type.
|
String |
UIAgent.getDisplayName(TemplateSet templateSet)
Provides the display name for the given template set according to the currently set UI language and display mode.
|
String |
UIAgent.getDisplayName(WorkflowElement workflowElement)
Provides the display name for the given workflow element according to the currently set UI language and display mode.
|
Group |
ProjectMembersAgent.getGroupByName(String name)
Gets the group with the specified name.
|
String |
UIAgent.getHeadline(Store store)
Determines a headline to be used for the given store.
|
ImageIcon |
UIAgent.getIcon(IDProvider element)
Provides an icon for the given id providing store element.
|
FileSystem<?> |
ModuleAdminAgent.getProjectAppConfig(String moduleName,
String projectAppName,
Project project)
Returns an access to the project-app configuration directory; read-write-access if the user is project admin,
read-only-access if the user is project user, otherwise a
SecurityException will be thrown. |
<T> TransferType<T> |
TransferAgent.getRawValueType(Class<T> valueType)
Provides the value transfer type for a ValueHolder (SwingGadget) where
|
<PROPERTY_TYPE> |
ServerConfigurationAgent.getServerProperty(ServerProperty<PROPERTY_TYPE> property)
Returns the current value of a server property.
|
FileSystem<?> |
ModuleAdminAgent.getServiceConfig(String serviceName)
Provides access to the configuration of a service.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet,
SnippetContext context)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet,
SnippetContext context)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(FormData formData,
Snippet snippet,
SnippetContext context)
Serves a snippet provider based on the given snippet and form data.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(IDProvider element)
Hands out a snippet provider for the given element or
null , if no snippet provider is available. |
SnippetProvider |
SnippetAgent.getSnippetProvider(IDProvider element,
SnippetAgent.Fallback fallback)
Hands out a snippet provider for the given element applying the given fallback strategy.
|
SnippetProvider |
SnippetAgent.getSnippetProvider(IDProvider element,
SnippetAgent.Fallback fallback)
Hands out a snippet provider for the given element applying the given fallback strategy.
|
Store |
StoreAgent.getStore(Store.Type type)
Get the store of the requested type on elements in current state.
|
Store |
StoreAgent.getStore(Store.Type type,
boolean release)
Get the store of the requested type.
|
Optional<ScheduleTaskFactory<? extends ScheduleTaskFactory.TaskDto,? extends ScheduleTask>> |
ScheduleTaskAgent.getTaskFactory(Class<? extends ScheduleTaskApplication<?>> applicationClass)
Get the
ScheduleTaskFactory responsible for creating and executing schedule tasks defined by a
ScheduleTaskApplication . |
<T> TransferType<T> |
TransferAgent.getType(String mime,
Class<T> clazz)
Provides the transfer type for a given mime descriptor and the class of objects being transferred.
|
<T> TransferType<T> |
TransferAgent.getType(String mime,
Class<T> clazz)
Provides the transfer type for a given mime descriptor and the class of objects being transferred.
|
Image<?> |
SnippetAgent.getTypeIcon(IDProvider element)
Provides a type image resource for the given element.
|
String |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrl(ContentProducer contentProducer)
|
String |
PreviewUrlAgent.MediaPreviewUrlBuilder.getUrl(Media media)
Returns the URL-String for the Media.
|
PreviewUrl |
PreviewUrlAgent.ContentProducerPreviewUrlBuilder.getUrlObject(ContentProducer contentProducer)
|
User |
ProjectMembersAgent.getUserByLogin(String login)
Gets the user with the specified login name.
|
Collection<Group> |
ProjectMembersAgent.getUserGroups(User user)
Get all project groups where the provided user is a member of.
|
FileSystem<?> |
ModuleAdminAgent.getWebServerConfiguration(String moduleName,
String componentName,
String instanceName)
Returns the configuration file system specified by the given web server.
|
FileSystem<?> |
ModuleAdminAgent.getWebServerConfiguration(String moduleName,
String componentName,
String instanceName)
Returns the configuration file system specified by the given web server.
|
FileSystem<?> |
ModuleAdminAgent.getWebServerConfiguration(String moduleName,
String componentName,
String instanceName)
Returns the configuration file system specified by the given web server.
|
ModuleAdminAgent.ModuleResult |
ModuleAdminAgent.install(InputStream fsmStream,
boolean updateUsages)
Installs or updates the given module.
|
ModuleAdminAgent.ModuleResult |
ModuleAdminAgent.install(InputStream fsmStream,
boolean updateUsages,
boolean deployWebApps)
Installs or updates the given module.
|
void |
ModuleAdminAgent.installProjectApp(String moduleName,
String projectAppName,
Project project)
Installs or updates a project application to the specified project.
|
void |
ModuleAdminAgent.installWebApp(String moduleName,
String webAppComponent,
WebAppId webAppId)
Installs or updates the given web-app component into the specified web app and deploys the web app
to its web-server.
|
void |
ModuleAdminAgent.installWebApp(String moduleName,
String webAppComponent,
WebAppId webAppId,
boolean deploy)
Installs or updates the given web-app component into the specified web app and deploys the web app
to its web-server, if
deploy is set to true . |
boolean |
PasswordAgent.isHigherPriorityKeyAvailableForPassword(String password)
Tests whether the encrypted password has been encrypted with a low priority key while a higher priority key is
available on the FirstSpirit server in the meantime.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.language(Language language)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.language(String abbreviation)
Overwrite which language should be used for rendering - default language is the project master language.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(Media media)
The provided node is used as starting point for relative links when evaluating the provided template source.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(PageRef pageRef)
The provided node is used as starting point for relative links when evaluating the provided template source.
|
RenderingAgent.Renderer |
RenderingAgent.RendererWithoutLinkRoot.linkRoot(SiteStoreFolder folder)
The provided folder is used as starting point for relative links when evaluating the provided template source.
|
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 . |
IDProvider |
StoreElementAgent.loadStoreElement(String uid,
IDProvider.UidType uidType,
boolean release)
Load a store object with the given
uid and uidType . |
RenderingAgent.Renderer |
RenderingAgent.Renderer.logListener(LogListener logListener)
Provide the listener for log events during rendering.
|
void |
RenderingAgent.MediaLinkListener.mediaLinked(Media media,
Language language,
Resolution resolution)
Callback
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.mediaLinkListener(RenderingAgent.MediaLinkListener mediaLinkListener)
Provide the listener for media link events during rendering.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.mode(RenderingAgent.RenderMode mode)
Set the desired
render mode . |
String |
GenerateElementOperation.perform(PageRef element,
Language language)
Executes the configured
ScheduleEntry and waits for its completion. |
String |
GenerateElementOperation.perform(PageRef element,
Language language)
Executes the configured
ScheduleEntry and waits for its completion. |
void |
ModuleAdminAgent.registerWebServer(String moduleName,
String componentName,
String instanceName)
Registers a new web server with the specified instance name.
|
void |
ModuleAdminAgent.registerWebServer(String moduleName,
String componentName,
String instanceName)
Registers a new web server with the specified instance name.
|
void |
ModuleAdminAgent.registerWebServer(String moduleName,
String componentName,
String instanceName)
Registers a new web server with the specified instance name.
|
void |
MPPViewportAgent.set(MPPViewports viewports)
Takes the given
configuration and writes it back the the current project. |
<PROPERTY_TYPE> |
ServerConfigurationAgent.setServerProperty(ServerProperty<PROPERTY_TYPE> property,
PROPERTY_TYPE value)
Modifies the current value of a server property.
|
<PROPERTY_TYPE> |
ServerConfigurationAgent.setServerProperty(ServerProperty<PROPERTY_TYPE> property,
PROPERTY_TYPE value)
Modifies the current value of a server property.
|
void |
UIAgent.setStatus(UIAgent.Status status)
Set the UI status, which will be visualized to the user in some form.
|
void |
SnippetContext.setStoreType(Store.Type storeType)
Sets the store type to be used for snippet building.
|
void |
MaintenanceModeAgent.stopMaintenanceMode(MaintenanceModeInfo info)
Stops a maintenance mode task, skipping any future stages.
|
<O> O |
Image.supply(Image.Consumer<O> consumer)
Supply the image to the given consumer.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.templateSet(String templateSetUid)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.templateSet(TemplateSet templateSet)
Overwrite which template set should be used for rendering - default template set is the first template set of
the project.
|
void |
TrackingAgent.track(UUID uuid,
String label,
String categoryName)
Tracking of usages.
|
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.
|
void |
TrackingAgent.track(UUID uuid,
String label,
String value,
String categoryName,
String explanation)
Tracking of usages.
|
void |
ModuleAdminAgent.uninstallProjectApp(String moduleName,
String projectAppName,
Project project)
Removes the project application from the specified project.
|
void |
ModuleAdminAgent.unregisterWebServer(String moduleName,
String componentName,
String instanceName)
Removes the specified web server and deletes its directories from the configuration directory.
|
void |
ModuleAdminAgent.unregisterWebServer(String moduleName,
String componentName,
String instanceName)
Removes the specified web server and deletes its directories from the configuration directory.
|
void |
ModuleAdminAgent.unregisterWebServer(String moduleName,
String componentName,
String instanceName)
Removes the specified web server and deletes its directories from the configuration directory.
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactory(String publicName)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactory(UrlFactory urlFactory)
Set a custom url factory (default is the preview url factory).
|
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlFactorySettings(Map<String,String> urlFactorySettings)
Set custom initialization parameters (will be passed to
UrlFactory.init(Map, PathLookup) of the
configured url factory). |
RenderingAgent.Renderer |
RenderingAgent.Renderer.urlPrefix(String urlPrefix)
Set the url prefix used for absolute urls generated with
$CMS_REF(..., abs:1)$ . |
RunLevel |
RunLevelAgent.waitForRunLevel(RunLevel runLevel,
Duration maxWaitDuration)
Wait until the FirstSpirit server reaches a
RunLevel or a timeout occurs. |
RunLevel |
RunLevelAgent.waitForRunLevel(RunLevel runLevel,
Duration maxWaitDuration)
Wait until the FirstSpirit server reaches a
RunLevel or a timeout occurs. |
Modifier and Type | Method and Description |
---|---|
<T> T |
Aspectable.getAspect(AspectType<T> aspect)
Request an aspect from the aspectable.
|
<A,C extends A> |
AspectMap.put(AspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
AspectMap.put(AspectType<A> type,
C aspect)
Put an aspect for specific type.
|
Modifier and Type | Method and Description |
---|---|
static StoreType |
StoreType.forName(String name)
Returns the
StoreType with the specified store-name (e.g. |
String |
StoreType.getName()
Returns old style store name (e.g.
|
Modifier and Type | Method and Description |
---|---|
static StoreType |
StoreType.forName(String name)
Returns the
StoreType with the specified store-name (e.g. |
Modifier and Type | Method and Description |
---|---|
Serializable |
EditorItemNode.getIdentifier()
The item's identifier.
|
EditorNode |
EditorNode.getLast()
Gets the last editor node of the chain starting from this node.
|
String |
EditorNode.getName()
The edit component's name.
|
Modifier and Type | Method and Description |
---|---|
List<Reference> |
FormReferenceContaining.collectFormReferences(F formElement)
Collect references stored in the provided
formElement . |
List<Reference> |
ReferenceContaining.collectReferences(T value)
Collect references as used by the given value.
|
List<Difference> |
DifferenceComputing.computeDifferences(T actualValue,
T oldValue)
Compute the list of differences between the two provided values.
|
List<Difference> |
Contrastable.contrastWith(Language language,
Object value)
Contrasts this instance with a given value.
|
T |
ValueEngineer.copy(T original)
Create a copy of the given value, i.e., it produces a new instance having the same contents.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(IDProvider element,
String remoteConfigName)
Create an element referencing container from a given id providing store element.
|
ExternalReferenceHolder |
ReferenceConstructionAgent.create(String resource,
String category)
Create an external referencing container from a given resource (e.g. an URL) and category.
|
SpecialistsBroker |
ValueEngineerContext.getBroker()
Provides access to a specialitsts broker.
|
List<Node> |
Node.getChildren()
The list of child nodes.
|
F |
ValueEngineerContext.getGom()
Gives the form definition as GOM element.
|
List<? extends Match> |
MatchSupporting.getMatches(Request request,
T value)
Calculate a list of matches for a given request-value pair.
|
Modification |
Difference.getModification()
Type of modification related to this difference.
|
String |
Node.getName()
The name of the node.
|
Class<T> |
JsonSupporting.getSupportedClass()
This method should return the value type for which this
supporting is responsible - same as in ValueEngineer . |
ReferenceHolder |
ReferenceTransformationAgent.read(Node node,
Language language,
boolean release)
Read an element referencing container from a persistency node.
|
Reference |
ReferenceHolder.toReference(ReferenceHolder.ChangeCallback callback)
Resolves a reference descriptor from the referenced element.
|
Node |
ReferenceTransformationAgent.write(String tag,
ReferenceHolder holder)
Write an element referencing container to a persistency node.
|
List<Node> |
ValueEngineer.write(T value)
Persist the given value.
|
Modifier and Type | Method and Description |
---|---|
void |
ReferenceAwareValueIndexSupporting.appendIndexData(ValueIndexer indexer,
T value,
boolean includeReferences)
Asks to append indexing data for the given value to the handed indexer.
|
void |
ReferenceAwareValueIndexSupporting.appendIndexData(ValueIndexer indexer,
T value,
boolean includeReferences)
Asks to append indexing data for the given value to the handed indexer.
|
List<Reference> |
ReferenceContaining.collectReferences(T value)
Collect references as used by the given value.
|
List<Difference> |
DifferenceComputing.computeDifferences(T actualValue,
T oldValue)
Compute the list of differences between the two provided values.
|
List<Difference> |
DifferenceComputing.computeDifferences(T actualValue,
T oldValue)
Compute the list of differences between the two provided values.
|
T |
ValueEngineer.copy(T original)
Create a copy of the given value, i.e., it produces a new instance having the same contents.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(IDProvider element,
String remoteConfigName)
Create an element referencing container from a given id providing store element.
|
static Node |
Node.create(String name)
Create a node with the specified name.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String uid,
IDProvider.UidType uidType,
String remoteConfigName)
Create an element referencing container on given store element information.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String uid,
IDProvider.UidType uidType,
String remoteConfigName)
Create an element referencing container on given store element information.
|
static Node |
Node.create(String name,
Node... children)
Create a node with the specified name and the specified child nodes.
|
static Node |
Node.create(String name,
Node... children)
Create a node with the specified name and the specified child nodes.
|
static Node |
Node.create(String name,
Node child)
Create a node with the specified name and the one specified child node.
|
static Node |
Node.create(String name,
Node child)
Create a node with the specified name and the one specified child node.
|
static Node |
Node.create(String name,
String text)
Create a node with the specified name and the specified text content.
|
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,
KeyValue keyValue,
String remoteConfigName)
Create a dataset referencing container on given information.
|
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.
|
IDProviderReferenceHolder |
ReferenceConstructionAgent.create(String schemaUid,
String entityTypeName,
UUID gid,
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.
|
<T> T |
ValueEngineer.getAspect(ValueEngineerAspectType<T> aspect)
Request an aspect of the given type.
|
List<? extends Match> |
MatchSupporting.getMatches(Request request,
T value)
Calculate a list of matches for a given request-value pair.
|
List<? extends Match> |
MatchSupporting.getMatches(Request request,
T value)
Calculate a list of matches for a given request-value pair.
|
boolean |
ValueEngineer.isEmpty(T value)
Check if the provided value is empty.
|
T |
ValueEngineer.read(List<Node> nodes)
Read the value.
|
ReferenceHolder |
ReferenceTransformationAgent.read(Node node,
Language language,
boolean release)
Read an element referencing container from a persistency node.
|
Node |
Node.setAttribute(String name,
String value)
Sets the named attribute to a provided value, which might also be
null . |
Node |
ReferenceTransformationAgent.write(String tag,
ReferenceHolder holder)
Write an element referencing container to a persistency node.
|
Node |
ReferenceTransformationAgent.write(String tag,
ReferenceHolder holder)
Write an element referencing container to a persistency node.
|
List<Node> |
ValueEngineer.write(T value)
Persist the given value.
|
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 |
---|---|
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.
|
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.
|
<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.
|
void |
Catalog.Card.loadItem(FormData formData)
Loads the data from the given item into this card.
|
Modifier and Type | Method and Description |
---|---|
Object |
JavaClientApi.execute(String identifier)
Executes a script or executable specified by the given identifier.
|
Object |
JavaClientApi.execute(String identifier,
Map<String,Object> params)
Executes a script or executable specified by the given identifier.
|
Object |
JavaClientApi.execute(String identifier,
Map<String,Object> params)
Executes a script or executable specified by the given identifier.
|
Modifier and Type | Method and Description |
---|---|
T |
ApplicationTab.getApplication()
Returns the application inside this tab.
|
Modifier and Type | Method and Description |
---|---|
void |
BrowserNodeHandlerBuilder.addDropHandler(BrowserNodeHandlerBuilder.DropHandler<N> handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
BrowserNodeHandlerBuilder.addDropHandler(BrowserNodeHandlerBuilder.DropHandler<N> handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
BrowserNodeHandlerBuilder.addDropHandler(BrowserNodeHandlerBuilder.DropHandler<N> handler,
TransferType<?>... types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
BrowserNodeHandlerBuilder.addDropHandler(BrowserNodeHandlerBuilder.DropHandler<N> handler,
TransferType<?>... types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
ApplicationTab.addTabListener(TabListener listener)
Adds the given
listener . |
<T> void |
BrowserNodeHandlerBuilder.DragContext.addTransferItem(TransferType<T> type,
T item)
Adds a transferable object for a given type to this context.
|
<T> void |
BrowserNodeHandlerBuilder.DragContext.addTransferItem(TransferType<T> type,
T item)
Adds a transferable object for a given type to this context.
|
<T> void |
BrowserNodeHandlerBuilder.DragContext.addTransferItems(TransferType<T> type,
Collection<T> items)
Adds a collection of transferable objects for a given type to this context.
|
<T> void |
BrowserNodeHandlerBuilder.DragContext.addTransferItems(TransferType<T> type,
Collection<T> items)
Adds a collection of transferable objects for a given type to this context.
|
void |
BrowserNodeHandlerBuilder.DropHandler.onDrop(CommodityContainer commodities,
N node)
Method will be called on dropping related
TransferType 's over specified node. |
void |
ApplicationTab.removeTabListener(TabListener listener)
Removes the given
listener . |
Modifier and Type | Method and Description |
---|---|
void |
BrowserApplication.addBrowserListener(BrowserListener listener)
Adds the given
browser listener to be notified on browser change events. |
BrowserApplicationConfiguration |
BrowserApplicationConfiguration.engineType(EngineType type)
Sets the type of the browser engine to be used for the
browser application configured
with this browser configuration. |
void |
BrowserListener.onLocationChange(String url)
Called when the location (url) of the browser changed.
|
void |
BrowserListener.Adapter.onLocationChange(String url)
Called when the location (url) of the browser changed.
|
void |
BrowserApplication.removeBrowserListener(BrowserListener listener)
Removes the given
browser listener . |
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.
|
void |
MPPWebControl.setParameter(String name,
Object value)
Sets the current value of the specified preview parameter.
|
Modifier and Type | Method and Description |
---|---|
DataProvider<T> |
ReportPlugin.createDataProvider()
Factory method to create an object provider instance for use with this report plug-in.
|
DataRenderer<T> |
ReportPlugin.createDataRenderer()
Factory method to create a renderer instance for use with this report plug-in.
|
<A extends ClientPluginAction<?>> |
ClientPlugin.getActions(ClientPluginScope<A> scope)
Deprecated.
since 5.0.100 use a specific
plug-in type instead (see hierarchy). |
String |
ItemIdentifiable.getIdentifier()
Returns a unique identifier for the contextual item.
|
Collection<? extends A> |
ItemsPlugin.getItems()
Get all items eligible for the plug-ins contextual setting.
|
Collection<? extends JavaClientContextMenuItem> |
JavaClientContextNewMenuItemsPlugin.getItems()
Get all items eligible for context menus.
|
Collection<? extends JavaClientContextMenuItem> |
JavaClientContextPluginsMenuItemsPlugin.getItems()
Get all items eligible for the plugins menu.
|
Collection<? extends JavaClientToolbarItem> |
JavaClientEditorialToolbarItemsPlugin.getItems()
Provide toolbar specific items wrt. the plug-ins contextual setting.
|
Collection<? extends ExternalPreviewItem> |
ExternalPreviewItemsPlugin.getItems()
Provide items regarding external preview services.
|
String |
ExecutablePluginItem.getLabel(C context)
Provides a label for this item wrt. the given context.
|
List<Parameter<?>> |
ReportPlugin.getParameter()
Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within
the user interface.
|
List<? extends T> |
GroupingPluginItem.getSubItems(C context)
Provides a list of sub items.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutablePluginItem.execute(C context)
Executes an operation associated with this item considering the given context.
|
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.
|
String |
ExecutablePluginItem.getLabel(C context)
Provides a label for this item wrt. the given context.
|
String |
ExternalPreviewItem.getLabel(ExternalPreviewContext context)
Returns a human-readable title representing this report plug-in.
|
List<? extends T> |
GroupingPluginItem.getSubItems(C context)
Provides a list of sub items.
|
String |
ExternalPreviewItem.getUrl(ExternalPreviewContext context)
Provides an url for the given
IDProvider . |
boolean |
Item.isEnabled(C context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
Item.isVisible(C context)
Indicates the visibility of this item wrt. the given context.
|
void |
Plugin.setUp(BaseContext context)
Defines the beginning of this plug-in's life providing a context that allows access to the
plug-ins programmatic environment.
|
Modifier and Type | Method and Description |
---|---|
Listable<IDProvider> |
ContextMenuContext.getElements()
Get the contextual store elements.
|
String |
JavaClientContextMenuItem.getLabel(ContextMenuContext context)
Provides a label for this item wrt. the given context.
|
String |
SeparatorContextMenuItem.getLabel(ContextMenuContext context)
Noop.
|
Store.Type |
ContextMenuContext.getStoreType()
Provides the store type the toolbar context relates to.
|
List<? extends JavaClientContextMenuItem> |
GroupingContextMenuItem.getSubItems(ContextMenuContext context)
Provides a list of sub menu items.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutableContextMenuItem.execute(ContextMenuContext context)
Executes an operation associated with this item considering the given context.
|
Icon |
JavaClientContextMenuItem.getIcon(ContextMenuContext context)
Returns the icon of this item or
null if this item has no icon. |
Icon |
SeparatorContextMenuItem.getIcon(ContextMenuContext context)
Noop.
|
String |
JavaClientContextMenuItem.getLabel(ContextMenuContext context)
Provides a label for this item wrt. the given context.
|
String |
SeparatorContextMenuItem.getLabel(ContextMenuContext context)
Noop.
|
List<? extends JavaClientContextMenuItem> |
GroupingContextMenuItem.getSubItems(ContextMenuContext context)
Provides a list of sub menu items.
|
boolean |
JavaClientContextMenuItem.isEnabled(ContextMenuContext context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
SeparatorContextMenuItem.isEnabled(ContextMenuContext context)
Noop.
|
boolean |
JavaClientContextMenuItem.isVisible(ContextMenuContext context)
Indicates the visibility of this item wrt. the given context.
|
boolean |
SeparatorContextMenuItem.isVisible(ContextMenuContext context)
Noop.
|
Modifier and Type | Method and Description |
---|---|
DataSnippetProvider<D> |
DataAccessSession.createDataSnippetProvider()
Provides the renderer having means to produce representable information for displaying a data element.
|
DataStream<D> |
DataStreamBuilder.createDataStream()
Creates a new data stream.
|
DataStreamBuilder<D> |
DataAccessSession.createDataStreamBuilder()
Creates an aspectable builder for data streams.
|
DataAccessSession<D> |
DataAccessSessionBuilder.createSession(BaseContext context)
Create a session based on the given configuration.
|
DataAccessSessionBuilder<D> |
DataAccessPlugin.createSessionBuilder()
Provides a builder for creating a (configured) session for accessing data.
|
List<D> |
DataAccessSession.getData(Collection<String> identifiers)
Bulk operation to get data objects by their identifiers.
|
D |
DataAccessSession.getData(String identifier)
Gets a data object by its identifier.
|
String |
DataSnippetProvider.getHeader(D object,
Language language)
Provides the header text being used as a short representation of the given object.
|
String |
DataAccessSession.getIdentifier(D object)
Provide a unique identifier for the given data object.
|
String |
DataAccessPlugin.getLabel()
Provides a human-readable label to be shown when displaying this plug-in or information thereon.
|
List<D> |
DataStream.getNext(int count)
Returns an incremental result set of data objects based on the settings provided when starting the stream.
|
Modifier and Type | Method and Description |
---|---|
DataAccessSession<D> |
DataAccessSessionBuilder.createSession(BaseContext context)
Create a session based on the given configuration.
|
<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.
|
List<D> |
DataAccessSession.getData(Collection<String> identifiers)
Bulk operation to get data objects by their identifiers.
|
D |
DataAccessSession.getData(String identifier)
Gets a data object by its identifier.
|
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.getIcon(D object)
Provides a type image resource for the given object or
null if no type image is available. |
String |
DataAccessSession.getIdentifier(D object)
Provide a unique identifier for the given data 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 |
---|---|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.attribute(String name,
Object value)
Configures an attribute to be available in the generation context.
|
static UrlGenerationContext.Builder |
UrlGenerationContext.builder()
Creates a builder for the context in which an URL will be requested.
|
UrlGenerationContext |
UrlGenerationContext.Builder.create()
Creates a new
UrlGenerationContext instance based on the given configuration. |
GomElement |
GomConfigurable.createConfiguration()
Provides a new GOM object for configuration.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.from(GenerationContext context)
The
GenerationContext to extract the context information from,
which consists of:
The UrlCreator configured in the given generation context
The UrlCreatorProvider available in the given generation context
The contextual Language
Whether or not the release version is used
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.from(JsonGenerationContext context)
The
JsonGenerationContext to extract the context information from,
which consists of:
The UrlCreator configured in the generation context
The UrlCreatorProvider available in the generation context
The contextual Language
Whether or not the release version is used
The current attributes available in the given JSON generation context
|
DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> |
DataAssociating.getAssociationType()
Returns the type of data assocation this aspect is working on.
|
<O> Optional<O> |
UrlGenerationContext.getAttribute(String name)
Lookup an attribute with the given
name in this generation context. |
List<Parameter<?>> |
Filterable.getDefinedParameters()
Returns a list of parameter definitions supported by the data stream, used to enable interactive filter configuration.
|
Collection<? extends ReportItem<D>> |
ReportItemsProviding.getItems()
Provides an arbitrary number of report items defining actions available with a single entry.
|
Collection<? extends ReportItem<D>> |
ReportItemsProviding.Adapter.getItems()
Provides an arbitrary number of report items defining actions available with a single entry.
|
Language |
UrlGenerationContext.getLanguage()
Returns the contextual
Language when requesting the URL. |
Class<D> |
JsonSupporting.getSupportedClass()
This method should return the targeted data type for which this
supporting is responsible - same as in DataAccessSession . |
Optional<String> |
UrlSupporting.getUrl(UrlGenerationContext context,
D object)
Returns an URL string for the given object in the specified language,
if there is any.
|
UrlCreator |
UrlGenerationContext.getUrlCreator()
Returns the url creator to be used in the current generation context.
|
UrlCreatorProvider |
UrlGenerationContext.getUrlCreatorProvider()
Returns the provider of url creators in the current generation context.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.language(Language language)
Configures the contextual
Language when requesting the URL. |
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.release(boolean release)
Indicates whether or not the URL is requested in the context of a release version.
|
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 |
---|---|
void |
DataTemplating.ParameterSet.addAttribute(String name,
String text)
Adds text as parameter for attribute use.
|
void |
DataTemplating.ParameterSet.addAttribute(String name,
String text)
Adds text as parameter for attribute use.
|
void |
ValueReferencesJournal.addBrokenReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Deprecated.
since 5.2.200403 - use
ValueReferencesJournal.addReferenceToDataset(Schema, String, UUID) instead |
void |
ValueReferencesJournal.addBrokenReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Deprecated.
since 5.2.200403 - use
ValueReferencesJournal.addReferenceToDataset(Schema, String, UUID) instead |
void |
ValueReferencesJournal.addBrokenReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Deprecated.
since 5.2.200403 - use
ValueReferencesJournal.addReferenceToDataset(Schema, String, UUID) instead |
void |
ValueReferencesJournal.addBrokenReferenceToElement(String uid,
IDProvider.UidType uidType,
String remote)
Deprecated.
since 5.2.200403 - use
ValueReferencesJournal.addReferenceToElement(String, IDProvider.UidType, String) instead |
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.addHtml(String name,
String html)
Adds HTML as parameter.
|
void |
DataTemplating.ParameterSet.addHtml(String name,
String html)
Adds HTML as parameter.
|
void |
DataTemplating.ParameterSet.addImage(String name,
Image<?> image,
String altText)
Adds an image as parameter.
|
void |
DataTemplating.ParameterSet.addImage(String name,
Image<?> image,
String altText)
Adds an image as parameter.
|
void |
DataTemplating.ParameterSet.addImage(String name,
Image<?> image,
String altText)
Adds an image as parameter.
|
void |
DataTemplating.ParameterSet.addMedium(String name,
Media media,
Resolution resolution)
Adds a medium as parameter.
|
void |
DataTemplating.ParameterSet.addMedium(String name,
Media media,
Resolution resolution)
Adds a medium as parameter.
|
void |
ModelReferencesJournal.addModelElement(IDProvider element)
Adds the given FirstSpirit element as model reference to this journal.
|
void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
KeyValue keyValue)
Adds a reference to a FirstSpirit
Dataset to this journal. |
void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
KeyValue keyValue)
Adds a reference to a FirstSpirit
Dataset to this journal. |
void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
KeyValue keyValue)
Adds a reference to a FirstSpirit
Dataset to this journal. |
default void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Adds a reference to a FirstSpirit
Dataset to this journal. |
default void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Adds a reference to a FirstSpirit
Dataset to this journal. |
default void |
ValueReferencesJournal.addReferenceToDataset(Schema schema,
String entityTypeName,
UUID gid)
Adds a reference to a FirstSpirit
Dataset to this journal. |
void |
ValueReferencesJournal.addReferenceToElement(IDProvider element)
Adds a reference to a FirstSpirit element to this journal.
|
default void |
ValueReferencesJournal.addReferenceToElement(String uid,
IDProvider.UidType uidType,
String remote)
Adds a reference to a FirstSpirit element to this journal.
|
default void |
ValueReferencesJournal.addReferenceToElement(String uid,
IDProvider.UidType uidType,
String remote)
Adds a reference to a FirstSpirit element to this journal.
|
void |
ValueReferencesJournal.addReferenceToExternal(String category,
String reference)
Adds a reference to an external element to this journal.
|
void |
ValueReferencesJournal.addReferenceToExternal(String category,
String reference)
Adds a reference to an external element to this journal.
|
void |
DataTemplating.ParameterSet.addText(String name,
String text)
Adds text as parameter.
|
void |
DataTemplating.ParameterSet.addText(String name,
String text)
Adds text as parameter.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.attribute(String name,
Object value)
Configures an attribute to be available in the generation context.
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.from(GenerationContext context)
The
GenerationContext to extract the context information from,
which consists of:
The UrlCreator configured in the given generation context
The UrlCreatorProvider available in the given generation context
The contextual Language
Whether or not the release version is used
|
UrlGenerationContext.Builder |
UrlGenerationContext.Builder.from(JsonGenerationContext context)
The
JsonGenerationContext to extract the context information from,
which consists of:
The UrlCreator configured in the generation context
The UrlCreatorProvider available in the generation context
The contextual Language
Whether or not the release version is used
The current attributes available in the given JSON generation context
|
<O> Optional<O> |
UrlGenerationContext.getAttribute(String name)
Lookup an attribute with the given
name in this generation context. |
String |
DataTemplating.getTemplate(D object,
Language language)
Provides the template to be used for extended data representation.
|
String |
DataTemplating.getTemplate(D object,
Language language)
Provides the template to be used for extended data representation.
|
Optional<String> |
UrlSupporting.getUrl(UrlGenerationContext context,
D object)
Returns an URL string for the given object in the specified language,
if there is any.
|
Optional<String> |
UrlSupporting.getUrl(UrlGenerationContext context,
D object)
Returns an URL string for the given object in the specified language,
if there is any.
|
<A,C extends A> |
DataAccessAspectMap.put(DataAccessAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
DataAccessAspectMap.put(DataAccessAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
SessionAspectMap.put(SessionAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
SessionAspectMap.put(SessionAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
SessionBuilderAspectMap.put(SessionBuilderAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
SessionBuilderAspectMap.put(SessionBuilderAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
StreamBuilderAspectMap.put(StreamBuilderAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
StreamBuilderAspectMap.put(StreamBuilderAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
void |
DataTemplating.registerParameters(DataTemplating.ParameterSet parameters,
D object,
Language language)
Asks to register needed parameters to the given set.
|
void |
DataTemplating.registerParameters(DataTemplating.ParameterSet parameters,
D object,
Language language)
Asks to register needed parameters to the given set.
|
void |
DataTemplating.registerParameters(DataTemplating.ParameterSet parameters,
D object,
Language language)
Asks to register needed parameters to the given set.
|
default void |
ReferencesReporting.reportModelReferences(ModelReferencesJournal journal)
Reports references made by model objects.
|
default void |
ReferencesReporting.reportValueReferences(ValueReferencesJournal journal,
Set<String> identifiers)
Reports references made by data objects represented by the given identifiers.
|
default void |
ReferencesReporting.reportValueReferences(ValueReferencesJournal journal,
Set<String> identifiers)
Reports references made by data objects represented by the given identifiers.
|
void |
DataAccessControlling.requireAccess(BaseContext context)
Requires the session to enable accessing its data and provide the current access state.
|
void |
DataAssociating.setAssociation(A association)
Sets the element association to be used for a data stream being build.
|
void |
GomConfigurable.setConfiguration(GomElement configuration)
Sets the given GOM based configuration for building a session.
|
void |
Filterable.setFilter(ParameterMap filter)
Sets the filter to be used for the resulting stream.
|
Modifier and Type | Method and Description |
---|---|
List<D> |
HandlerHost.Handler.handle(List<A> commodities)
Handle the given transfers.
|
Modifier and Type | Method and Description |
---|---|
List<D> |
HandlerHost.Handler.handle(List<A> commodities)
Handle the given transfers.
|
<A> void |
HandlerHost.registerHandler(TransferType<A> type,
HandlerHost.Handler<D,A> handler)
Registers a supplier for the hosted gadget itself.
|
<A> void |
HandlerHost.registerHandler(TransferType<A> type,
HandlerHost.Handler<D,A> handler)
Registers a supplier for the hosted gadget itself.
|
void |
TransferHandling.registerHandlers(HandlerHost<D> host)
Register handler responsible for receiving commodities in a specific context.
|
void |
TransferSupplying.registerSuppliers(SupplierHost<D> host)
Register suppliers responsible for providing commodities.
|
List<A> |
SupplierHost.Supplier.supply(D object)
Supply a list of commodities to be transferred for a given data object.
|
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. |
boolean |
ReportItem.isEnabled(ReportContext<T> context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
ReportItem.isVisible(ReportContext<T> context)
Indicates the visibility of this item wrt. the given context.
|
void |
TransferHandler.registerSuppliers(TransferHandler.SupplierHost<T> host)
Register suppliers responsible for providing commodities.
|
String |
DataProvider.serialize(T object)
Returns a string identifier for the given
object or null if this element
has no identifier. |
List<A> |
TransferHandler.SupplierHost.Supplier.supply(T object)
Supply a list of commodities.
|
Modifier and Type | Method and Description |
---|---|
static TimelineEntry.Factory |
TimelineEntry.Factory.builder()
Creates an instance of this factory for creation of
TimelineEntry using a builder pattern. |
TimelineEntry |
TimelineEntry.Factory.create()
Creates a
TimelineEntry based on the given settings. |
static TimelineEntry |
TimelineEntry.Factory.create(Date timestamp)
Creates a
TimelineEntry associated with the specified timestamp. |
static TimelineEntry |
TimelineEntry.Factory.create(Revision revision)
Creates a
TimelineEntry associated with the specified revision. |
Collection<TimelineEntry> |
TimelineEntryProvider.getEntries(IDProvider element,
Language language)
Returns a list of entries that should be shown in the related timeline.
|
Date |
TimelineEntry.getTimestamp()
Returns the associated timestamp of this timeline entry.
|
TimelineEntry.Factory |
TimelineEntry.Factory.revision(Revision revision)
Sets the revision, the resulting
TimelineEntry should be associated with. |
TimelineEntry.Factory |
TimelineEntry.Factory.timestamp(Date timestamp)
Sets the timestamp, the resulting
TimelineEntry should be associated with. |
Modifier and Type | Method and Description |
---|---|
static TimelineEntry |
TimelineEntry.Factory.create(Date timestamp)
Creates a
TimelineEntry associated with the specified timestamp. |
static TimelineEntry |
TimelineEntry.Factory.create(Revision revision)
Creates a
TimelineEntry associated with the specified revision. |
Collection<TimelineEntry> |
TimelineEntryProvider.getEntries(IDProvider element,
Language language)
Returns a list of entries that should be shown in the related timeline.
|
Collection<TimelineEntry> |
TimelineEntryProvider.getEntries(IDProvider element,
Language language)
Returns a list of entries that should be shown in the related timeline.
|
Modifier and Type | Method and Description |
---|---|
String |
JavaClientToolbarItem.getLabel(ToolbarContext context)
Provide the label for this item.
|
List<? extends JavaClientContextMenuItem> |
ExecutableGroupingToolbarItem.getSubItems(ContextMenuContext context)
Provides a list of executable toolbar sub items.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutableGroupingToolbarItem.execute(ToolbarContext context)
Executes an operation associated with this toolbar item considering the given context.
|
void |
ExecutableToolbarItem.execute(ToolbarContext context)
Executes an operation associated with this toolbar item considering the given context.
|
Icon |
JavaClientToolbarItem.getIcon(ToolbarContext context)
Returns the icon of this item or
null if this item has no icon. |
String |
JavaClientToolbarItem.getLabel(ToolbarContext context)
Provide the label for this item.
|
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. |
List<? extends JavaClientContextMenuItem> |
ExecutableGroupingToolbarItem.getSubItems(ContextMenuContext context)
Provides a list of executable toolbar sub items.
|
boolean |
JavaClientToolbarItem.isEnabled(ToolbarContext context)
Indicate, whether this item is enabled wrt. the given context.
|
boolean |
JavaClientToolbarItem.isVisible(ToolbarContext context)
Indicates the visibility of this item wrt. the given context.
|
void |
ToggleableToolbarItem.setSelected(ToolbarContext context,
boolean selected)
Sets the selection mode of this item.
|
Modifier and Type | Method and Description |
---|---|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
List<Entity> elements,
boolean force)
Adapts the given elements GID's.
|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
Map<Entity,UUID> elementsMapping,
boolean force)
Adapts the given elements GID's to the mapping defined one.
|
Map<Entity,Pair<UUID,UUID>> |
GidAgent.GidAdaptationResult.changes()
The result key value pairs.
|
Session |
GidAgent.migrateSchema(Schema schema)
Migrates the given schema to support
fs_gid's if necessary. |
Modifier and Type | Method and Description |
---|---|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
List<Entity> elements,
boolean force)
Adapts the given elements GID's.
|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
List<Entity> elements,
boolean force)
Adapts the given elements GID's.
|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
Map<Entity,UUID> elementsMapping,
boolean force)
Adapts the given elements GID's to the mapping defined one.
|
GidAgent.GidAdaptationResult |
GidAgent.adaptGid(Schema schema,
Map<Entity,UUID> elementsMapping,
boolean force)
Adapts the given elements GID's to the mapping defined one.
|
Entity |
GidAgent.findEntity(String gid)
Finds a
Entity by its globalId (gid). |
Session |
GidAgent.migrateSchema(Schema schema)
Migrates the given schema to support
fs_gid's if necessary. |
Modifier and Type | Method and Description |
---|---|
FeatureDescriptor |
FeatureAgent.FeatureBuilder.create()
Create a new feature descriptor with the current settings.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.createFeatureBuilder(FeatureDescriptor descriptor)
Returns a builder where you can create a new feature descriptor using the provided instance as blueprint.
|
Set<BasicElementInfo> |
FeatureInstallResult.getCreatedElements()
Provides the set of newly created elements.
|
Map<Schema,Map<EntityType,Collection<Dataset>>> |
FeatureModel.getDataRecords()
Returns all
data records contained in this feature model as an unmodifiable map. |
Set<BasicElementInfo> |
FeatureInstallResult.getDeletedElements()
Provides the set of deleted elements.
|
EnumMap<Store.Type,List<BasicElementInfo>> |
FeatureInstallResult.getDeletedStoreNodes()
Deprecated.
since 5.2.181006 - use
FeatureInstallResult.getDeletedElements() instead |
Map<Long,List<FeatureError>> |
FeatureAnalyseResult.getEntryErrors()
Returns the feature errors of this analyze result.
|
List<FeatureError> |
FeatureAnalyseResult.getGlobalErrors()
Returns the list of global errors.
|
Set<BasicElementInfo> |
FeatureInstallResult.getLostAndFoundElements()
Provides the set of elements being moved to the lost and found folder instead of being deleted.
|
EnumMap<Store.Type,List<BasicElementInfo>> |
FeatureInstallResult.getLostAndFoundStoreNodes()
Deprecated.
since 5.2.181006 - use
FeatureInstallResult.getLostAndFoundElements() instead |
Map<String,String> |
FeatureAnalyseResult.getMappedLayers()
Mapping of
layer names (key = layer name in source project; value = layer name in
target project). |
Set<BasicElementInfo> |
FeatureInstallResult.getMovedElements()
Provides the set of moved elements.
|
Map<Store.Type,Collection<IDProvider>> |
FeatureModel.getStoreNodes()
Returns all store nodes contained in this feature model as an unmodifiable mapping from
store type to a collection of IdProvider. |
List<String> |
FeatureAnalyseResult.getUnmappedLayers()
List of
layer names of the source project which exists in the feature because of
schema nodes or datarecords which couldn't be mapped to existing layers in target project. |
Set<BasicElementInfo> |
FeatureInstallResult.getUpdatedElements()
Provides the set of updated elements.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useLatestRevision()
Set the revision the new feature descriptor should operate in to the newest project revision which is
currently available.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useRelease(boolean value)
Should the feature descriptor deliver the release or current version of elements.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useRevision(Date date)
Set the date of the revision the new feature descriptor should operate in.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useRevision(Revision revision)
Set the revision the new feature descriptor should operate in.
|
Modifier and Type | Method and Description |
---|---|
ServerActionHandle<? extends FeatureProgress,FeatureAnalyseResult> |
FeatureInstallAgent.analyzeFeature(FeatureFile featureFile)
Starts a server side feature analyze process for the given feature file.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.createFeatureBuilder(FeatureDescriptor descriptor)
Returns a builder where you can create a new feature descriptor using the provided instance as blueprint.
|
InputStream |
FeatureAgent.downloadFeatureFile(FeatureFile featureFile)
Download the feature transport zip file specified by the given
featureFile . |
ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> |
FeatureInstallAgent.installFeature(FeatureFile featureFile,
LayerMapper layerMapper)
Starts a server side feature installation process for the given feature file.
|
ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> |
FeatureInstallAgent.installFeature(FeatureFile featureFile,
Map<String,String> layerMapping)
Deprecated.
since 5.2.513 - use
FeatureInstallAgent.installFeature(FeatureFile, LayerMapper) instead |
ServerActionHandle<? extends FeatureProgress,FeatureInstallResult> |
FeatureInstallAgent.installFeature(FeatureFile featureFile,
Map<String,String> layerMapping)
Deprecated.
since 5.2.513 - use
FeatureInstallAgent.installFeature(FeatureFile, LayerMapper) instead |
void |
FeatureDescriptor.setFeatureName(String featureName)
Sets the name of the feature this descriptor belongs to.
|
FeatureFile |
FeatureInstallAgent.uploadFeatureFile(InputStream stream)
Uploads the given stream (originated from a feature transport zip file) to the server and returns the related
feature file |
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useRevision(Date date)
Set the date of the revision the new feature descriptor should operate in.
|
FeatureAgent.FeatureBuilder |
FeatureAgent.FeatureBuilder.useRevision(Revision revision)
Set the revision the new feature descriptor should operate in.
|
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.
|
GomEditorProvider |
FormData.getForm()
Provides the form definition.
|
FormDataProducer |
FormDataList.getProducer()
Provides a producer able to create form-data based on the data-source definition for this editor.
|
Constructor and Description |
---|
InappropriateValueException(GomFormElement form,
Language language,
Object value,
de.espirit.firstspirit.client.common.locale.LocalizableException e)
Create a new instance.
|
InappropriateValueException(GomFormElement form,
Language language,
Object value,
de.espirit.firstspirit.client.common.locale.LocalizableException e)
Create a new instance.
|
Modifier and Type | Method and Description |
---|---|
Map<String,String> |
UrlFactoryContext.getParameters()
Returns the settings provided in module.xml file in section {@code
|
PathLookup |
UrlFactoryContext.getPathLookup()
Returns the path lookup for user defined paths.
|
String |
UrlFactory.getUrl(ContentProducer node,
TemplateSet templateSet,
Language language,
PageParams pageParams)
Calculate path to provided combination of node, template set, language, and page params.
|
String |
UrlFactory.getUrl(Media node,
Language language,
Resolution resolution)
Calculate path to provided combination of node, language, and resolution.
|
UrlCreatorProvider |
UrlFactoryContext.getUrlCreatorProvider()
Provides the contextual
UrlCreatorProvider . |
Modifier and Type | Method and Description |
---|---|
static UrlCreator |
UrlCreator.Factory.from(UrlCreator urlCreator)
Transform instances to satisfy the new interface
UrlCreator . |
String |
UrlFactory.getUrl(ContentProducer node,
TemplateSet templateSet,
Language language,
PageParams pageParams)
Calculate path to provided combination of node, template set, language, and page params.
|
String |
UrlFactory.getUrl(ContentProducer node,
TemplateSet templateSet,
Language language,
PageParams pageParams)
Calculate path to provided combination of node, template set, language, and page params.
|
String |
UrlFactory.getUrl(ContentProducer node,
TemplateSet templateSet,
Language language,
PageParams pageParams)
Calculate path to provided combination of node, template set, language, and page params.
|
String |
UrlFactory.getUrl(ContentProducer node,
TemplateSet templateSet,
Language language,
PageParams pageParams)
Calculate path to provided combination of node, template set, language, and page params.
|
String |
UrlFactory.getUrl(Media node,
Language language,
Resolution resolution)
Calculate path to provided combination of node, language, and resolution.
|
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).
|
default void |
UrlFactory.init(Map<String,String> settings,
PathLookup pathLookup)
Initialization method.
|
default void |
UrlFactory.init(Map<String,String> settings,
PathLookup pathLookup)
Initialization method.
|
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. |
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. |
default void |
UrlFactory.setUp(UrlFactoryContext context)
Configures the in which the
UrlFactory is operating. |
Modifier and Type | Method and Description |
---|---|
<O> Optional<O> |
JsonGenerationContext.getAttribute(String name)
Lookup an attribute with the given
name in the current stack. |
String |
JsonSettings.getFormatVersion()
Returns the json format setting.
|
JsonGenerationContext.JsonLogger |
JsonGenerationContext.getLogger()
Returns the
JsonGenerationContext.JsonLogger of the current JsonGenerationContext . |
JsonSettings |
JsonGenerationContext.getSettings()
Returns the current
json settings of this generation context. |
<T> JsonElement<?> |
JsonGenerationContext.handle(T object)
Entry point for the transformation of an object to a
JsonElement . |
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 |
---|---|
<O> Optional<O> |
JsonGenerationContext.getAttribute(String name)
Lookup an attribute with the given
name in the current stack. |
void |
JsonGenerationContext.JsonLogger.logDebug(String message)
Logs the given message with the log level debug.
|
void |
JsonGenerationContext.JsonLogger.logError(String message)
Logs the given message with the log level error.
|
void |
JsonGenerationContext.JsonLogger.logError(String message,
Throwable throwable)
Logs the given message and the given
Throwable with the log level error. |
void |
JsonGenerationContext.JsonLogger.logError(String message,
Throwable throwable)
Logs the given message and the given
Throwable with the log level error. |
void |
JsonGenerationContext.JsonLogger.logInfo(String message)
Logs the given message with the log level info.
|
void |
JsonGenerationContext.JsonLogger.logWarning(String message)
Logs the given message with the log level warning.
|
<O> void |
JsonGenerationContext.setAttribute(String name,
O value)
Sets the given value in the this
context . |
JsonSettings |
JsonSettings.setFormatVersion(String formatVersion)
Sets the json format version for rendering.
|
Modifier and Type | Method and Description |
---|---|
Class<T> |
JsonHandler.getSupportedClass()
This method provides the class for which the handler is responsible.
|
JsonElement<?> |
JsonHandler.handle(JsonGenerationContext context,
T value)
This method transforms the given value to a valid
JsonElement . |
Modifier and Type | Method and Description |
---|---|
JsonElement<?> |
JsonHandler.handle(JsonGenerationContext context,
T value)
This method transforms the given value to a valid
JsonElement . |
JsonElement<?> |
JsonHandler.handle(JsonGenerationContext context,
T value)
This method transforms the given value to a valid
JsonElement . |
Modifier and Type | Method and Description |
---|---|
OutputStream |
FileHandle.getOutputStream()
Returns an OutputStream to store content to the file.
|
OutputStream |
FileHandle.getOutputStream(boolean append)
Provides an OutputStream to store content to the file.
|
FileType |
FileHandle.getType()
Returns the
type of the file handle. |
List<FileHandle> |
FileHandle.listFiles()
Returns the files in the directory referenced by the handle.
|
InputStream |
FileHandle.load()
If
FileHandle.isFile() returns true, returns a stream handle on the file's content. |
T |
FileSystem.obtain(String path)
Obtain a handle to the file or directory with the given path.
|
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.
|
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.
|
FileSystem<? extends FileHandle> |
FileSystemsAgent.getOSFileSystem(String rootPath)
Provides an OS-based file system instance having the given path as root.
|
FileSystem<? extends FileHandle> |
FileSystemsAgent.getRelativeFileSystem(FileHandle root)
Provides a file system instance having the given root, which must represent a directory.
|
static void |
FileHandleSupport.serializeTo(Object value,
FileHandle targetFileHandle,
ClassLoader classLoader)
Serializes the given value using a special serialization algorithm and stores it to the provided file handle.
|
static void |
FileHandleSupport.serializeTo(Object value,
FileHandle targetFileHandle,
ClassLoader classLoader)
Serializes the given value using a special serialization algorithm and stores it to the provided file handle.
|
static void |
FileHandleSupport.serializeTo(Object value,
FileHandle targetFileHandle,
ClassLoader classLoader)
Serializes the given value using a special serialization algorithm and stores it to the provided file handle.
|
Modifier and Type | Method and Description |
---|---|
JsonArray |
JsonArray.add(Collection<? extends JsonElement<?>> values)
This method adds a collection of
JsonElement instances to the list. |
JsonArray |
JsonArray.add(JsonElement<?>... values)
This method adds one or more elements to the list.
|
JsonElement<?> |
JsonArray.get(int index)
Returns the
element at the specified position in this array. |
String |
JsonPair.getKey()
This method returns the current key of the pair.
|
JsonElement<?> |
JsonPair.getValue()
This method returns the current value of the pair.
|
static JsonPair |
JsonPair.of(String key,
JsonElement<?> value)
|
Collection<JsonPair> |
JsonObject.pairs()
This method can be used to get all currently pairs that are part of the object.
|
JsonObject |
JsonObject.put(Collection<? extends JsonPair> pairs)
This methods adds any kind of collection of
JsonPair s to the object. |
JsonObject |
JsonObject.put(JsonPair pair)
This method adds one pair to the object.
|
JsonObject |
JsonObject.put(String key,
JsonElement<?> value)
This method adds one pair to the object.
|
JsonArray |
JsonArray.remove(Collection<? extends JsonElement<?>> values)
This method removes a collection of
JsonElement instances from the list. |
JsonArray |
JsonArray.remove(JsonElement<?>... values)
This method removes the given {link JsonElement elements}.
|
default Stream<JsonElement<?>> |
JsonArray.stream()
This method transforms the current values list to a stream and returns it.
|
Collection<JsonElement<?>> |
JsonArray.values()
Returns the current
values in a new collection . |
Modifier and Type | Method and Description |
---|---|
JsonArray |
JsonArray.add(Collection<? extends JsonElement<?>> values)
This method adds a collection of
JsonElement instances to the list. |
JsonArray |
JsonArray.add(JsonElement<?>... values)
This method adds one or more elements to the list.
|
JsonElement<?> |
JsonObject.get(String key)
Get the value with the specified key.
|
boolean |
JsonObject.hasAttribute(String name)
Checks if this
object contains an attribute with the given name. |
static JsonPair |
JsonPair.of(String key,
JsonElement<?> value)
|
static JsonPair |
JsonPair.of(String key,
JsonElement<?> value)
|
JsonObject |
JsonObject.put(Collection<? extends JsonPair> pairs)
This methods adds any kind of collection of
JsonPair s to the object. |
JsonObject |
JsonObject.put(JsonPair pair)
This method adds one pair to the object.
|
JsonObject |
JsonObject.put(String key,
JsonElement<?> value)
This method adds one pair to the object.
|
JsonObject |
JsonObject.put(String key,
JsonElement<?> value)
This method adds one pair to the object.
|
JsonArray |
JsonArray.remove(Collection<? extends JsonElement<?>> values)
This method removes a collection of
JsonElement instances from the list. |
JsonArray |
JsonArray.remove(JsonElement<?>... values)
This method removes the given {link JsonElement elements}.
|
JsonObject |
JsonObject.remove(JsonPair pair)
This methods removes the pair with the specified key.
|
JsonObject |
JsonObject.remove(String key)
This methods removes the pair with the specified key.
|
JsonElement<?> |
JsonObject.resolve(String path)
Get the value for the specified path.
|
Modifier and Type | Method and Description |
---|---|
static JsonBooleanValue |
JsonBooleanValue.of(boolean value)
Returns a new
json element wrapping the given value . |
static JsonDateValue |
JsonDateValue.of(Date date)
Returns a new
json element wrapping the given date . |
static JsonNumberValue |
JsonNumberValue.of(Number value)
Returns a new
json element wrapping the given value . |
static JsonStringValue |
JsonStringValue.of(String value)
Returns a new
json element wrapping the given value . |
static JsonStringValue |
JsonStringValue.of(UUID uuid)
|
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 |
---|---|
static JsonDateValue |
JsonDateValue.of(Date date)
Returns a new
json element wrapping the given date . |
static JsonNumberValue |
JsonNumberValue.of(Number value)
Returns a new
json element wrapping the given value . |
static JsonStringValue |
JsonStringValue.of(String value)
Returns a new
json element wrapping the given value . |
static JsonStringValue |
JsonStringValue.of(UUID uuid)
|
Modifier and Type | Method and Description |
---|---|
Optional<LocalDate> |
LicenseService.getLicenseExpirationDate()
Returns expiration date of license.
|
Modifier and Type | Method and Description |
---|---|
SpecialistsBroker |
GadgetContext.getBroker()
Provides access to a specialists broker.
|
FileSystem<? extends FileHandle> |
ServerEnvironment.getConfDir()
Returns the configuration directory of this environment.
|
String |
WebServer.getContextPath(String contextName,
String targetPath)
Returns the path to the directory of the specified web application relative to
WebServer.getWebAppDir() . |
Language |
GadgetContext.getDisplayLanguage()
The display language to be used for displaying the form (labels).
|
String |
GadgetContext.getFormUid()
Provides the form identifying uid.
|
E |
GadgetContext.getGom()
Gives the form definition as GOM element.
|
Language |
GadgetContext.getPersistencyLanguage()
The persistency language of the gadget's value.
|
Store.Type |
GadgetContext.getStoreType()
Provides the store type the gadget operates in.
|
String |
WebServer.getWebAppDir()
Returns the path to the web application directory of this web server
|
Modifier and Type | Method and Description |
---|---|
void |
WebServer.deploy(String webAppName,
String contextName,
String targetPath,
String warFilePath)
Deploys the specified war file to the configured web server
|
void |
WebServer.deploy(String webAppName,
String contextName,
String targetPath,
String warFilePath)
Deploys the specified war file to the configured web server
|
void |
WebServer.deploy(String webAppName,
String contextName,
String targetPath,
String warFilePath)
Deploys the specified war file to the configured web server
|
void |
WebServer.deploy(String webAppName,
String contextName,
String targetPath,
String warFilePath)
Deploys the specified war file to the configured web server
|
boolean |
WebServer.isDeployed(String webAppName,
String contextName,
String targetPath)
Returns true if the contextName is deployed and false otherwise.
|
boolean |
WebServer.isDeployed(String webAppName,
String contextName,
String targetPath)
Returns true if the contextName is deployed and false otherwise.
|
boolean |
WebServer.isDeployed(String webAppName,
String contextName,
String targetPath)
Returns true if the contextName is deployed and false otherwise.
|
void |
SetServiceLocatorCallback.setServiceLocator(de.espirit.firstspirit.access.ServiceLocator value)
Sets a given locator to look up services.
|
void |
WebServer.undeploy(String webAppName,
String contextName,
String targetPath)
Undeploys the specified context
|
void |
WebServer.undeploy(String webAppName,
String contextName,
String targetPath)
Undeploys the specified context
|
void |
WebServer.undeploy(String webAppName,
String contextName,
String targetPath)
Undeploys the specified context
|
Modifier and Type | Method and Description |
---|---|
ComponentDescriptor[] |
ModuleDescriptor.getComponents()
Returns all components of this module.
|
EnumSet<WebAppDescriptor.WebAppScope> |
WebAppDescriptor.getWebAppScopes()
Returns a set of supported
WebAppDescriptor.WebAppScope s based on xml definition. |
Modifier and Type | Method and Description |
---|---|
void |
WebAppDescriptor.validate(ZipFile file)
Validate the given
ZipFile |
Modifier and Type | Method and Description |
---|---|
String |
OfficeImportService.getName()
Get the module name, same as in module.xml
|
Modifier and Type | Method and Description |
---|---|
ScheduleTaskExecutor<D> |
ScheduleTaskApplication.getExecutor()
Provides an executor providing the application logic.
|
String |
ScheduleTaskControl.getName()
Provides the name of the task.
|
String |
ScheduleTaskDefinition.getName()
Provides the name of the task.
|
String |
ScheduleTaskForm.ScheduleTaskConfiguration.getName()
Provides the name of the task.
|
String |
ScheduleTaskApplication.getName(Locale locale)
Provides a name for this application, preferably respecting the given locale.
|
RunState |
ScheduleTaskControl.getState()
Provides the current execution state of the task.
|
Modifier and Type | Method and Description |
---|---|
ScheduleTaskForm<D> |
ScheduleTaskFormFactory.createForm(SpecialistsBroker broker)
Create a form for configuring a schedule task.
|
void |
ScheduleTaskExecutor.execute(ScheduleTaskControl control,
D customData,
ScheduleTaskExecutionContext executionContext)
Execute with the given task information in the provided context.
|
void |
ScheduleTaskExecutor.execute(ScheduleTaskControl control,
D customData,
ScheduleTaskExecutionContext executionContext)
Execute with the given task information in the provided context.
|
<A> A |
ScheduleTaskControl.getAspect(ScheduleTaskAspectType<A> type)
Provides aspects of the underlying task.
|
String |
ScheduleTaskApplication.getDescription(Locale locale)
Provides a description for this application, preferably respecting the given locale.
|
String |
ScheduleTaskApplication.getName(Locale locale)
Provides a name for this application, preferably respecting the given locale.
|
boolean |
ScheduleTaskApplication.isApplicable(ScheduleTaskDefinitionContext context)
Indicates the applicability of this application's tasks wrt. the given task definition context.
|
void |
ScheduleTaskForm.load(ScheduleTaskForm.ScheduleTaskConfiguration<D> configuration)
Load this form from the given configuration container.
|
boolean |
ScheduleTaskForm.openAndWait(Window parent,
String title)
Opens the form in a modal way and waits for it to be closed.
|
boolean |
ScheduleTaskForm.openAndWait(Window parent,
String title)
Opens the form in a modal way and waits for it to be closed.
|
void |
ScheduleTaskForm.ScheduleTaskConfiguration.setName(String name)
Defines the name of the task.
|
void |
ScheduleTaskForm.store(ScheduleTaskForm.ScheduleTaskConfiguration<D> configuration)
Store this form to the given configuration container.
|
void |
ScheduleTaskExecutor.validate(ScheduleTaskControl control,
D customData,
ScheduleTaskExecutionContext executionContext)
Validate 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 |
---|---|
String |
FileEntry.getExtension()
Provides the extension of the file.
|
FileHandle |
JobAgent.getFolder()
Provides a handle to the job folder.
|
String |
JobAgent.getFolderPath()
Provides the absolute path to the job folder.
|
String |
FileEntry.getName()
Provides the name of the file.
|
String |
SettingsAgent.NoSuchSettingException.getName()
Provides the name of the requested setting.
|
Collection<FileEntry> |
GenerationAgent.getOutput()
Provides a collection containing information on the output of generation runs prior
to the invocation.
|
String |
FileEntry.getPath()
Provides the complete path sequence (including the file's name) relative to the
root of the generation.
|
Date |
JobAgent.getStartingTime()
Provides the starting time of the job.
|
Modifier and Type | Method and Description |
---|---|
Object |
JobAgent.getVariable(String name)
Gets the variable value stored by the given name.
|
Serializable |
SettingsAgent.load(String name)
Load some setting stored with the given name.
|
void |
SettingsAgent.remove(String name)
Remove a setting having the given name.
|
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 |
---|---|
static <A> ScheduleTaskAspectType<A> |
ScheduleTaskAspectType.create(Class<A> aspectType)
Creates an aspect type having the given type of instances.
|
Icon |
IconProviding.getIcon()
Provides an icon for this application.
|
Modifier and Type | Method and Description |
---|---|
<A,C extends A> |
ApplicationAspectMap.put(ApplicationAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
<A,C extends A> |
ApplicationAspectMap.put(ApplicationAspectType<A> type,
C aspect)
Put an aspect for specific type.
|
Modifier and Type | Method and Description |
---|---|
MaintenanceModeTask.ConcurrentTaskHandling |
MaintenanceModeInfo.getConcurrentTaskHandling()
Indicates if other tasks may be executed while the maintenance mode is active.
|
String |
MaintenanceModeInfo.getDescription()
The description of this maintenance mode.
|
MaintenanceModeTask.DisconnectMode |
MaintenanceModeInfo.getDisconnectMode()
Indicates the handling of existing sessions once the stage
MaintenanceModeTask.MaintenanceStage.MAINTENANCE_MODE_ACTIVE
begins. |
MaintenanceModeTask.MaintenanceScope |
MaintenanceModeInfo.getMaintenanceScope()
Indicates the scope of this maintenance task, i.e. if only certain
projects or the whole server is affected.
|
String |
MaintenanceModeInfo.getMessage()
The message which is displayed to all users once the task has
been started.
|
MaintenanceModeTask.MessageDisplayType |
MaintenanceModeInfo.getMessageDisplayType()
Indicates how the message is displayed to the users.
|
List<Long> |
MaintenanceModeInfo.getProjectIds()
All projects affected by the maintenance task.
|
ZonedDateTime |
MaintenanceModeInfo.getStartingTimeOfStage(MaintenanceModeTask.MaintenanceStage stage)
Each
MaintenanceModeTask.MaintenanceStage is started at a particular time if the task is not stopped prematurely. |
Date |
MaintenanceModeInfo.getStartingTimeOfStageAsDate(MaintenanceModeTask.MaintenanceStage stage)
Deprecated.
since 5.2.180703 - use
#getStartingTimeOfStage(MaintenanceStage) instead |
Modifier and Type | Method and Description |
---|---|
long |
MaintenanceModeInfo.getDurationOfStageInMillis(MaintenanceModeTask.MaintenanceStage stage)
Each stage has a duration after which the next stage is started.
|
ZonedDateTime |
MaintenanceModeInfo.getStartingTimeOfStage(MaintenanceModeTask.MaintenanceStage stage)
Each
MaintenanceModeTask.MaintenanceStage is started at a particular time if the task is not stopped prematurely. |
Date |
MaintenanceModeInfo.getStartingTimeOfStageAsDate(MaintenanceModeTask.MaintenanceStage stage)
Deprecated.
since 5.2.180703 - use
#getStartingTimeOfStage(MaintenanceStage) instead |
Modifier and Type | Method and Description |
---|---|
Image<?> |
ApplicationPlugin.getIcon(ApplicationPlugin.IconType type)
Returns the icon representing the application.
|
String |
ApplicationPlugin.getLabel()
The label to be displayed at the application icon.
|
String |
ApplicationPlugin.getUrl()
Returns the URL to be opened when starting the application on the webstart page.
|
Modifier and Type | Method and Description |
---|---|
Image<?> |
ApplicationPlugin.getIcon(ApplicationPlugin.IconType type)
Returns the icon representing the application.
|
Modifier and Type | Method and Description |
---|---|
static void |
ClusterHelper.clearProjectCaches(Connection connection,
long projectId)
Clear cached resources on a cluster node.
|
static void |
ClusterHelper.clearProjectCaches(Connection connection,
String clusterNodeName,
long projectId)
Clear cached resources on a cluster node.
|
static void |
ClusterHelper.clearProjectCaches(Connection connection,
String clusterNodeName,
long projectId)
Clear cached resources on a cluster node.
|
Modifier and Type | Method and Description |
---|---|
String |
ServerProperty.getName()
The name of the property as defined in the server configuration file, e.g.
|
Modifier and Type | Method and Description |
---|---|
void |
FileBasedUploadFilter.initUploadFilter(InputStream in,
String extension)
Creates a new tempfile with the given extension and copies the given inputstream to this tempfile.
|
void |
FileBasedUploadFilter.initUploadFilter(InputStream in,
String extension)
Creates a new tempfile with the given extension and copies the given inputstream to this tempfile.
|
void |
UploadFilter.initUploadFilter(InputStream in,
String extension)
Initialize the filter instance.
|
void |
UploadFilter.initUploadFilter(InputStream in,
String extension)
Initialize the filter instance.
|
int |
FileBasedUploadFilter.read(byte[] b,
int off,
int len)
Reads up to len bytes of data from the input stream into an array of bytes.
|
int |
UploadFilter.read(byte[] b,
int off,
int len)
Reads up to len bytes of data from the input stream into an array of bytes.
|
void |
FileBasedUploadFilter.setServiceLocator(de.espirit.firstspirit.access.ServiceLocator value)
Set a service locator which will be used to lookup a service.
|
Modifier and Type | Method and Description |
---|---|
int[] |
ExifValueFormatter.getSupportedTags()
The exif tags hex this formatter is registered for.
|
Modifier and Type | Method and Description |
---|---|
Collection<String> |
MimeType.getExtensions()
Get the possible associated filename extensions.
|
Constructor and Description |
---|
ModuleException(String message)
Creates a module exception with the given detail message.
|
ModuleException(String message,
Throwable cause)
Creates a module exception with the given detail message and cause.
|
Modifier and Type | Method and Description |
---|---|
DTO |
DeployTargetFactory.create()
Factory providing a new DTO.
|
T |
DeployTargetFactory.create(DeployTask deployTask,
DTO dto)
Factory to create a new target.
|
abstract ScheduleTaskDialog |
ScheduleTaskDialogFactory.createDialog(Host host)
Creates a dialog instance based on the given host.
|
abstract ScheduleTaskDialog |
DeployTargetDialogFactory.createDialog(Host host,
Window owner)
Creates a
ScheduleTaskDialog using the given host and parent window. |
ScheduleWizard |
ScheduleWizardFactory.createDialog(Host host,
Window parent,
ScheduleStorage scheduleStorage)
Create new schedule entry wirzard dialog
|
DTO |
ScheduleTaskFactory.createDto()
Create a new Task DTO to use with a task factory to create a new task.
|
T |
ScheduleTaskFactory.createTask(ScheduleEntry scheduleEntry,
DTO dto)
Create a new task.
|
de.espirit.firstspirit.server.scheduler.TaskExecutor |
ScheduleTaskFactory.createTaskExecutor()
Factory providing an executor object for performing a task.
|
Class<T> |
DeployTargetFactory.getApiType()
Provides the API type of this factory.
|
String |
DeployTargetFactory.getDescription()
Provides the description for a task based upon this factory.
|
String |
ScheduleTaskFactory.getDescription()
Provides a description of the created task's job.
|
String |
ScheduleWizardFactory.getDescription()
Provides a job description for created tasks.
|
String |
DeployTargetFactory.getDisplayName()
Provides the display name for task selection.
|
String |
ScheduleTaskFactory.getDisplayName()
Provides the display name for creating tasks from this factory.
|
String |
ScheduleWizardFactory.getDisplayName()
Provides a display name for task creation selection.
|
Class<DTO> |
DeployTargetFactory.getDtoType()
Provides the DTO type for the task at hand.
|
protected ScheduleTask |
ScheduleTaskDialogFactory.getTask()
Provides the task the dialog will be based upon.
|
Modifier and Type | Method and Description |
---|---|
T |
DeployTargetFactory.create(DeployTask deployTask,
DTO dto)
Factory to create a new target.
|
T |
DeployTargetFactory.create(DeployTask deployTask,
DTO dto)
Factory to create a new target.
|
abstract ScheduleTaskDialog |
ScheduleTaskDialogFactory.createDialog(Host host)
Creates a dialog instance based on the given host.
|
abstract ScheduleTaskDialog |
DeployTargetDialogFactory.createDialog(Host host,
Window owner)
Creates a
ScheduleTaskDialog using the given host and parent window. |
ScheduleWizard |
ScheduleWizardFactory.createDialog(Host host,
Window parent,
ScheduleStorage scheduleStorage)
Create new schedule entry wirzard dialog
|
ScheduleWizard |
ScheduleWizardFactory.createDialog(Host host,
Window parent,
ScheduleStorage scheduleStorage)
Create new schedule entry wirzard dialog
|
<E> E |
DeployTargetFactory.createEditorFactory(Class<E> type,
DeployTask deployTask,
T deployTarget)
Create a gui factory of a specified type.
|
<E> E |
DeployTargetFactory.createEditorFactory(Class<E> type,
DeployTask deployTask,
T deployTarget)
Create a gui factory of a specified type.
|
<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.
|
<E> E |
ScheduleTaskFactory.createEditorFactory(Class<E> type,
T task)
Create a gui factory of a specified type.
|
T |
ScheduleTaskFactory.createTask(ScheduleEntry scheduleEntry,
DTO dto)
Create a new task.
|
T |
ScheduleTaskFactory.createTask(ScheduleEntry scheduleEntry,
DTO dto)
Create a new task.
|
boolean |
ScheduleWizardFactory.isLicensed(Host host)
Is this wizard factory enabled by license?
|
boolean |
ScheduleTaskFactory.isLicensed(SpecialistsBroker broker)
Is this task type enabled by license?
|
void |
DeployTargetDialogFactory.setDeployTarget(DeployTarget deployTarget)
Sets the deploy target.
|
Constructor and Description |
---|
ScheduleTaskDialogFactory(ScheduleTask task)
Constructor based on a task.
|
Modifier and Type | Method and Description |
---|---|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
File file,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
File file,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
File file,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
Picture picture,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
Picture picture,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.postProcess(BaseContext baseContext,
Media media,
Picture picture,
long length)
Hook method will be called on media upload AFTER the uploaded file is transmitted into the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
File file,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
File file,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
File file,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
File file,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
Picture picture,
Resolution resolution,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
Picture picture,
Resolution resolution,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
Picture picture,
Resolution resolution,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.preProcess(BaseContext baseContext,
Media media,
Picture picture,
Resolution resolution,
InputStream inputStream,
long length)
Hook method will be called on media upload BEFORE the uploaded file will be transmitted to the FirstSpirit-Server-Repository.
|
void |
UploadHook.uploadAborted(BaseContext baseContext,
Media media,
MediaElement mediaElement)
This method will be called if an upload has been rejected by any upload-hook instance and this hook has been already executed.
|
void |
UploadHook.uploadAborted(BaseContext baseContext,
Media media,
MediaElement mediaElement)
This method will be called if an upload has been rejected by any upload-hook instance and this hook has been already executed.
|
void |
UploadHook.uploadAborted(BaseContext baseContext,
Media media,
MediaElement mediaElement)
This method will be called if an upload has been rejected by any upload-hook instance and this hook has been already executed.
|
Modifier and Type | Method and Description |
---|---|
List<Group> |
Group.getAllChildren()
Returns a list of all (recursive) group children of this group.
|
String[] |
User.getGroupsIds()
Returns an array of
group ids this user belongs to. |
Modifier and Type | Method and Description |
---|---|
Iterable<TNode<I>> |
TNode.getChildren()
Returns children.
|
I |
TNode.getId()
Returns the object id.
|
Class<? extends I> |
TNodeProvider.getIdClass()
Returns id class of this provider.
|
String |
TNode.getLabel(Locale locale)
Returns language specific label.
|
List<TNode<I>> |
TNodeProvider.getNodes(R request,
Collection<I> ids)
Returns objects for the given ids.
|
Iterable<TNode<I>> |
TNodeProvider.getPath(R request,
I id)
Returns path to root or
null for root nodes. |
Iterable<String> |
TNode.getPropertyNames()
Returns all property names.
|
Collection<String> |
TNodeService.getProviderNames()
Returns all provider names.
|
Map<String,String> |
TNodeService.getProviderProperties(String name)
Returns properties of the specified provider.
|
TNode<I> |
TNodeProvider.getRoot(R request)
Returns root object.
|
Iterable<TNode<I>> |
TNodeProvider.search(R request,
String text,
int flags)
Searches the given
text . |
Modifier and Type | Method and Description |
---|---|
void |
TNodeService.addProvider(String name,
String providerClass)
Adds a provider instance to the service.
|
void |
TNodeService.addProvider(String name,
String providerClass)
Adds a provider instance to the service.
|
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.
|
List<TNode<I>> |
TNodeProvider.getNodes(R request,
Collection<I> ids)
Returns objects for the given ids.
|
List<TNode<I>> |
TNodeProvider.getNodes(R request,
Collection<I> ids)
Returns objects for the given ids.
|
Iterable<TNode<I>> |
TNodeProvider.getPath(R request,
I id)
Returns path to root or
null for root nodes. |
Iterable<TNode<I>> |
TNodeProvider.getPath(R request,
I id)
Returns path to root or
null for root nodes. |
Object |
TNode.getProperty(String name)
Returns a user defined property;
null for unknown properties. |
TNodeProvider |
TNodeService.getProvider(String name)
Returns a provider proxy.
|
TNode<I> |
TNodeProvider.getRoot(R request)
Returns root object.
|
void |
TNodeService.removeProvider(String name)
Removes a provider instance from the service.
|
Iterable<TNode<I>> |
TNodeProvider.search(R request,
String text,
int flags)
Searches the given
text . |
Iterable<TNode<I>> |
TNodeProvider.search(R request,
String text,
int flags)
Searches the given
text . |
void |
TNodeService.setProviderProperties(String name,
Map<String,String> properties)
Sets properties of the specified provider.
|
void |
TNodeService.setProviderProperties(String name,
Map<String,String> properties)
Sets properties of the specified provider.
|
Modifier and Type | Method and Description |
---|---|
TNode |
TNodesEditorValue.getRoot()
Root node.
|
Modifier and Type | Method and Description |
---|---|
ElementProvider<Revision> |
HistoryProvider.asRevisionProvider()
Return an
ElementProvider on this HistoryProvider. |
String |
ReferencesChangeDetail.ContentReference.getEntityTypeName()
Get the name of the entity's type.
|
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.
|
Object[] |
ReferencesChangeDetail.ContentReference.getKeyValues()
Get the values of the unique key of the entity.
|
ReferencesChangeDetail.IdReference.Kind |
ReferencesChangeDetail.IdReference.getKind()
Get the kind of id reference.
|
ReferencesChangeDetail.Reference |
ReferencesChangeDetail.RemoteReference.getReference()
Get the foreign reference.
|
String |
ReferencesChangeDetail.ExternalReference.getReference()
Get the external reference.
|
String |
ReferencesChangeDetail.RemoteReference.getRemoteName()
Get the configuration name of the remote project.
|
String |
ReferencesChangeDetail.ContentReference.getSchemaUid()
Get the uid of the entity's schema
|
de.espirit.storage.Revision.State |
Revision.getState()
Returns the current state of this revision.
|
String |
ReferencesChangeDetail.NameReference.getUid()
Get the uid of the referenced element.
|
IDProvider.UidType |
ReferencesChangeDetail.NameReference.getUidType()
Get the type of the referenced element.
|
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.
|
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.requireMappedFolder(SiteStoreFolder folder)
Returns the pagestore folder mapped to given
folder . |
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). |
PageFolder |
WebeditStoreMappingPlugin.requireMappedFolder(SiteStoreFolder folder)
Returns the pagestore folder mapped to given
folder . |
Modifier and Type | Method and Description |
---|---|
FeatureError.Code |
FeatureError.getErrorCode()
The error code of this feature error.
|
FeatureError.Level |
FeatureError.getErrorLevel()
The error level of this feature error.
|
Modifier and Type | Method and Description |
---|---|
abstract String |
MediaConstraintsException.EXCEPTION_VARIANT.getDefaultMessage(Map<String,String> params)
The default error message for a variant.
|
Modifier and Type | Method and Description |
---|---|
abstract String |
MediaConstraintsException.EXCEPTION_VARIANT.getDefaultMessage(Map<String,String> params)
The default error message for a variant.
|
Modifier and Type | Method and Description |
---|---|
Set<ExportInfoFileHandle> |
ExportInfo.getCreatedFileHandles()
Get the detailed information on created file handles.
|
Set<ExportInfoFileHandle> |
ExportInfo.getDeletedFileHandles()
Get the detailed information on deleted file handles.
|
BasicElementInfo |
ElementExportInfo.getElementInfo()
Retrieves the
BasicElementInfo of this element. |
Collection<BasicEntityInfo> |
EntityTypeExportInfo.getEntities()
Return a collection of
BasicEntityInfos . |
Collection<Pair<ExportInfoFileHandle,ExportInfoFileHandle>> |
ExportInfo.getMovedFileHandles()
Get the detailed information on moved file handles.
|
BasicElementInfo |
EntityTypeExportInfo.getSchema()
Returns the corresponding schema as a
BasicElementInfo . |
ExportStatus |
ExportInfo.getStatus()
Retrieve the current
export status of this ExportInfo . |
ExportInfo.Type |
ExportInfo.getType()
Retrieve the current
type of this ExportInfo . |
Set<ExportInfoFileHandle> |
ExportInfo.getUpdatedFileHandles()
Get the detailed information on updated file handles.
|
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 |
---|---|
List<ImportElementInfo> |
ImportElementInfo.getChildren()
Provides the information containers for the element's children.
|
Collection<ExportInfo> |
ExportOperation.Result.getCreatedElements()
Get the detailed information on created elements.
|
Set<BasicElementInfo> |
ImportOperation.Result.getCreatedElements()
Provides the set of newly created elements.
|
Set<BasicEntityInfo> |
ImportOperation.Result.getCreatedEntities()
Provides the set of newly created entities.
|
Set<ExportInfoFileHandle> |
ExportOperation.Result.getCreatedFileHandles()
Get the detailed information on created file handles.
|
Set<FileHandle> |
ExportOperation.Result.getCreatedFiles()
Deprecated.
since 5.2.1403. Use
ExportOperation.Result.getCreatedFileHandles() ()} or ExportOperation.Result.getCreatedElements() ()} instead. |
Collection<ExportInfo> |
ExportOperation.Result.getDeletedElements()
Get the detailed information on deleted elements.
|
Set<BasicElementInfo> |
ImportOperation.Result.getDeletedElements()
Provides the set of deleted elements.
|
Set<ExportInfoFileHandle> |
ExportOperation.Result.getDeletedFileHandles()
Get the detailed information on deleted file handles.
|
Set<FileHandle> |
ExportOperation.Result.getDeletedFiles()
Deprecated.
since 5.2.1403. Use
ExportOperation.Result.getDeletedFileHandles() or ExportOperation.Result.getDeletedElements() instead. |
Set<BasicElementInfo> |
ImportOperation.Result.getLostAndFoundElements()
Provides the set of elements being moved to the lost and found folder instead of being deleted.
|
String |
ImportOperation.Problem.getMessage()
The problem description.
|
EnumSet<PropertiesTransportOptions.ProjectPropertyType> |
ImportOperation.Result.getModifiedProjectProperties()
Provides the
EnumSet of modified project properties. |
Collection<ExportInfo> |
ExportOperation.Result.getMovedElements()
Get the detailed information on moved elements.
|
Set<BasicElementInfo> |
ImportOperation.Result.getMovedElements()
Provides the set of moved elements.
|
Collection<Pair<ExportInfoFileHandle,ExportInfoFileHandle>> |
ExportOperation.Result.getMovedFileHandles()
Get the detailed information on moved file handles.
|
List<ImportOperation.Problem> |
ImportOperation.Result.getProblems()
Provide a list of problems which occurred during import.
|
Store.Type |
ImportOperation.Problem.getStoreType()
The store type of the problematic element.
|
Collection<ExportInfo> |
ExportOperation.Result.getUpdatedElements()
Get the detailed information on updated elements.
|
Set<BasicElementInfo> |
ImportOperation.Result.getUpdatedElements()
Provides the set of updated elements.
|
Set<BasicEntityInfo> |
ImportOperation.Result.getUpdatedEntities()
Provides the set of updated entities.
|
Set<ExportInfoFileHandle> |
ExportOperation.Result.getUpdatedFileHandles()
Get the detailed information on updated file handles.
|
Set<FileHandle> |
ExportOperation.Result.getUpdatedFiles()
Deprecated.
since 5.2.1403. Use
ExportOperation.Result.getUpdatedFileHandles() ()} or ExportOperation.Result.getUpdatedElements() ()} instead. |
Modifier and Type | Method and Description |
---|---|
ExportOperation.ChannelsProviderOptions |
ExportOperation.addChannelProvider(ChannelSourceProvider element)
Add a channels providing element for export.
|
void |
ExportOperation.addElement(IDProvider element)
Generically adds a FirstSpirit element to be exported.
|
void |
ExportOperation.SchemaOptions.addEntity(Entity entity)
Adds an entity to be exported.
|
ExportOperation.SchemaOptions |
ExportOperation.addSchema(Schema element)
Add a schema element for export.
|
static ImportOperation.DatabaseLayerMapper |
ImportOperation.MapDatabaseLayerMapper.from(Map<String,String> mapping)
Deprecated.
since 5.2.513 - use
LayerMapper instead |
String |
ImportOperation.DatabaseLayerMapper.getLayer(String layerNameFromFileSystem)
Deprecated.
since 5.2.513 - use
LayerMapper instead |
String |
ImportOperation.MapDatabaseLayerMapper.getLayer(String layerNameFromFileSystem)
Deprecated.
since 5.2.513 - use
LayerMapper instead |
void |
StepsListener.onProgressChange(String title,
int percentage)
Informs about the step's progress having changed.
|
void |
StepsListener.onStart(String title)
Informs about a step being started.
|
void |
StepsListener.onStateChange(String title,
String stateDescription)
Informs about the step's state having changed.
|
void |
StepsListener.onStateChange(String title,
String stateDescription)
Informs about the step's state having changed.
|
void |
StepsListener.onStop(String title)
Informs about a step being stopped.
|
ExportOperation.Result |
ExportOperation.perform(FileSystem<?> fileSystem)
Perform the export on the given
file system . |
ImportOperation.Result |
ImportOperation.perform(FileSystem<?> fileSystem)
Perform the import on the given
file system . |
void |
ImportOperation.setDatabaseLayerMapper(ImportOperation.DatabaseLayerMapper mapper)
Deprecated.
since 5.2.513 - use
ImportOperation.setLayerMapper(LayerMapper) instead |
void |
ImportOperation.setImportFilter(Filter<ImportElementInfo> filter)
Sets a filter being used to decide upon elements to be imported.
|
void |
ImportOperation.setLayerMapper(LayerMapper layerMapper)
Sets a mapper providing information to map imported schemes to a specific layer of the target project.
|
void |
ImportOperation.setRevisionComment(String comment)
Sets a comment for revisions created
during the update . |
void |
ExportOperation.setStepsListener(StepsListener listener)
Sets the listener that gets informed on steps being started.
|
void |
ImportOperation.setStepsListener(StepsListener listener)
Sets the listener that gets informed on steps being started.
|
void |
ExportOperation.ChannelsProviderOptions.useCustomExtension(TemplateSet templateSet,
String extension)
Defines to use custom extensions when exporting channels.
|
void |
ExportOperation.ChannelsProviderOptions.useCustomExtension(TemplateSet templateSet,
String extension)
Defines to use custom extensions when exporting channels.
|
Constructor and Description |
---|
MapDatabaseLayerMapper(Map<String,String> mapping)
Deprecated.
Constructor for sub-classing.
|
Modifier and Type | Method and Description |
---|---|
String |
RulesetContainer.getRulesetDefinition()
Deprecated.
Provide the textual definition of this container's rule set.
|
Modifier and Type | Method and Description |
---|---|
void |
RulesetContainer.setRulesetDefinition(String definition)
Deprecated.
Sets the given
definition of rule sets. |
Modifier and Type | Method and Description |
---|---|
ReleaseOperation |
ReleaseOperation.checkOnly(boolean checkOnly)
Defines if an release should actually be accomplished or only checked.
|
ReleaseOperation |
ReleaseOperation.dependentReleaseType(IDProvider.DependentReleaseType dependentReleaseType)
The dependent type specifying the behaviour for referenced elements of the given releaseStartNode (see
IDProvider.DependentReleaseType for details). |
ReleaseOperation |
ReleaseOperation.ensureAccessibility(boolean ensureAccessibility)
If
true each element on the parent path of each element (except for datasets) will be released. |
Set<BasicInfo> |
DeleteOperation.Result.getDeletedElements()
Returns a
Collection of BasicInfo of successfully deleted elements. |
Set<BasicInfo> |
DeleteOperation.Result.getDeleteFailedElements()
Returns a
Collection of all elements which couldn't be deleted because of unexpected errors during delete. |
Set<BasicInfo> |
DeleteOperation.Result.getLockFailedElements()
Returns a
Collection of all elements which couldn't be locked for deletion. |
Set<BasicInfo> |
DeleteOperation.Result.getMissingPermissionElements()
Returns a
Collection of all elements which couldn't be deleted because of missing delete permissions. |
Set<BasicInfo> |
DeleteOperation.Result.getNonChangeablePackagePoolElements()
Returns a
Collection of all elements which couldn't be deleted because they are package pool items
and belong to a non changeable subscription . |
EnumMap<ReleaseProblem,Set<BasicInfo>> |
ReleaseOperation.ReleaseResult.getProblematicElements()
Returns all problematic elements.
|
Set<BasicInfo> |
DeleteOperation.Result.getReferencedElements()
Returns a
Collection of all elements which couldn't be deleted because of existing incoming references. |
Set<BasicInfo> |
ReleaseOperation.ReleaseResult.getReleasedElements()
Returns all successfully released elements
|
Set<BasicInfo> |
ReleaseOperation.ReleaseResult.getReleaseFailedElements()
Returns all elements passed over to
ReleaseOperation.perform(IDProvider...) where release failed. |
DeleteOperation |
DeleteOperation.ignoreIncomingReferences(boolean ignoreIncomingReferences)
Sets whether incoming references should be ignored when deleting elements or not.
|
ReleaseOperation.ReleaseResult |
ReleaseOperation.perform(Collection<IDProvider> elements)
Performs the operation and releases the given
Collection of elements on the server. |
ReleaseOperation.ReleaseResult |
ReleaseOperation.perform(IDProvider... elements)
Performs the operation and releases the given
elements on the server. |
DeleteOperation.Result |
DeleteOperation.perform(IDProvider... elements)
Performs the operation and deletes the given elements on the server.
|
ReleaseOperation |
ReleaseOperation.recursive(boolean recursive)
If
true the subtree of each element (except for datasets) will be released recursive. |
ReleaseOperation |
ReleaseOperation.withComment(String comment)
The release comment, may be
null . |
Modifier and Type | Method and Description |
---|---|
ReleaseOperation.ReleaseResult |
ReleaseOperation.perform(Collection<IDProvider> elements)
Performs the operation and releases the given
Collection of elements on the server. |
ReleaseOperation.ReleaseResult |
ReleaseOperation.perform(IDProvider... elements)
Performs the operation and releases the given
elements on the server. |
DeleteOperation.Result |
DeleteOperation.perform(IDProvider... elements)
Performs the operation and deletes the given elements on the server.
|
void |
SaveOperation.perform(StoreElement element)
Performs this operation on the given element.
|
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.
|
Modifier and Type | Method and Description |
---|---|
String |
LayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
String |
LayerMapper.LayerNameBasedLayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
String |
LayerMapper.SchemaUidBasedLayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
Schema |
LayerMapper.MappingContext.getSchema()
Returns the transported schema as an instance of the target project.
|
Modifier and Type | Method and Description |
---|---|
static LayerMapper.LayerNameBasedLayerMapper |
LayerMapper.LayerNameBasedLayerMapper.from(Map<String,String> mapping)
Create an layer mapping instance from a given
Map based on layer names
(key=source layer name, value= target layer name). |
static LayerMapper.SchemaUidBasedLayerMapper |
LayerMapper.SchemaUidBasedLayerMapper.from(Map<String,String> mapping)
Create an layer mapping instance from a given
Map based on layer names
(key=schema uid, value= target layer name). |
String |
LayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
String |
LayerMapper.LayerNameBasedLayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
String |
LayerMapper.SchemaUidBasedLayerMapper.getLayer(LayerMapper.MappingContext mappingContext)
|
void |
PropertiesTransportOptions.setProjectPropertiesTransport(EnumSet<PropertiesTransportOptions.ProjectPropertyType> types)
Defines which properties types should be transported within related transport.
|
Modifier and Type | Method and Description |
---|---|
GadgetIdentifier |
GadgetIdentifierProvider.getIdentifier()
Returns the identifier of a targeted gadget.
|
Serializable |
GadgetIdentifier.getKey()
Get the key of the specific gadget component.
|
String |
GadgetIdentifier.getName()
Get the name of the gadget.
|
Modifier and Type | Method and Description |
---|---|
GadgetIdentifier |
GadgetIdentifier.envelop(String name,
Serializable key)
Envelop this identifier as inner node of a new identifier.
|
GadgetIdentifier |
GadgetIdentifier.envelop(String name,
Serializable key)
Envelop this identifier as inner node of a new identifier.
|
GadgetIdentifier |
GadgetIdentifier.forLanguage(Language language)
Get an identifier from this instance for a specific language.
|
static GadgetIdentifier |
GadgetIdentifier.from(GomFormElement form)
Get a default identifier for a given form element.
|
static GadgetIdentifier |
GadgetIdentifier.on(String name,
Serializable key)
Get an identifier based on the given name and key.
|
static GadgetIdentifier |
GadgetIdentifier.on(String name,
Serializable key)
Get an identifier based on the given name and key.
|
Modifier and Type | Method and Description |
---|---|
Color |
Mark.getBorderColor()
Provides the color to be used for markup.
|
Set<? extends IntegrityValidating.Problem> |
IntegrityValidating.validateIntegrity()
Validate the state wrt. data integrity.
|
Modifier and Type | Method and Description |
---|---|
void |
SwingFocusable.acceptFocus(SwingFocusable.Handler handler)
Hands a handler providing means to give focus.
|
Modifier and Type | Method and Description |
---|---|
ProjectOptions |
SelectStoreElementOperation.addProject(String remoteProjectName)
Adds the named project as selection source.
|
IDProvider |
SelectStoreElementOperation.Selection.getElement()
A selected element.
|
List<SelectStoreElementOperation.Selection> |
SelectStoreElementOperation.perform()
Performs the operation with the previously set configuration and returns the set of selections.
|
Modifier and Type | Method and Description |
---|---|
void |
ProjectOptions.StoreTypeOptions.addNavigatableFolders(String... uids)
Resricts navigation within a store type to the given folders.
|
void |
SelectStoreElementOperation.addProjectFromRestriction(ProjectRestriction projectRestriction)
Add a project from a clause representation.
|
ProjectOptions.StoreTypeOptions |
ProjectOptions.addStoreType(Store.Type type)
Add a store type to restrict navigation upon.
|
void |
ProjectOptions.StoreTypeOptions.addTopLevelFolders(IDProvider... folders)
Set the top level folders for this store type.
|
void |
SelectStoreElementOperation.selectUiType(SelectUiType uiType)
Set the type of user interface which is used to make a selection.
|
void |
SelectStoreElementOperation.setPreselection(String projectName,
IDProvider element,
Resolution resolution)
Sets a preselection.
|
Modifier and Type | Method and Description |
---|---|
<A> List<A> |
CommodityContainer.get(TransferType<A> type)
Get the correctly typed commodities for a type.
|
abstract DataFlavor |
TransferType.getDataFlavor()
Converts the transfer type into a data flavor representation.
|
abstract String |
TransferType.getDescriptor()
Provides access the descriptor of the transfer type, e.g. a MIME type.
|
abstract Class<T> |
TransferType.getType()
Provides access to the type of the transfer type.
|
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.
|
<T> void |
SupplierHost.register(Object source,
TransferType<T> type,
SupplierHost.Supplier<T> supplier)
Registers a supplier for the given component and type.
|
<T> void |
SupplierHost.register(Object source,
TransferType<T> type,
SupplierHost.Supplier<T> supplier)
Registers a supplier for the given component and type.
|
<T> void |
SupplierHost.register(Object source,
TransferType<T> type,
SupplierHost.Supplier<T> supplier)
Registers a supplier for the given component and type.
|
<T> void |
SupplierHost.register(TransferType<T> type,
SupplierHost.Supplier<T> supplier)
Registers a supplier for the hosted gadget itself.
|
<T> void |
SupplierHost.register(TransferType<T> type,
SupplierHost.Supplier<T> supplier)
Registers a supplier for the hosted gadget itself.
|
void |
ValidatorHost.register(ValidatorHost.Validator validator)
Registers a validator for the given component and type.
|
void |
HandlerHost.registerGadgetHandler(HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler to the gadget as drop target receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerGadgetHandler(HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler to the gadget as drop target receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
TransferType<?>... types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
TransferType<?>... types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
HandlerHost.registerHandler(Component dropTarget,
HandlerHost.Handler handler,
TransferType<?>... types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
TransferHandling.registerHandlers(HandlerHost host)
Register handler responsible for receiving commodities in a specific context.
|
void |
TransferSupplying.registerSuppliers(SupplierHost host)
Register suppliers responsible for providing commodities.
|
void |
TransferValidating.registerValidator(ValidatorHost host)
Register validators responsible for validating commodities in depth.
|
Modifier and Type | Method and Description |
---|---|
SwingGadget |
SwingGadgetFactory.create(SwingGadgetContext<E> context)
Creates a specific
SwingGadget . |
protected Language |
AbstractValueHoldingSwingGadget.getDisplayLanguage()
Convenience method to get the language to be used for displaying values.
|
RemoteFormData |
SwingGadgetContext.getElementFormData()
Provides remote access to the form data containing the gadget.
|
protected NotificationHost |
AbstractValueHoldingSwingGadget.getNotificationHost()
Access the notification host responsibly for this value holder.
|
NotificationHost |
SwingGadgetContext.getNotificationHost()
Gets the host to be used for notifications.
|
SwingFormViewMode |
SwingGadgetContext.getViewMode()
Returns the requested view mode for the gadget.
|
Modifier and Type | Method and Description |
---|---|
protected <A> void |
AbstractValueHoldingSwingGadget.addAspect(AspectType<A> type,
A aspect)
Add an aspect supported by this
Aspectable . |
protected <A> void |
AbstractValueHoldingSwingGadget.addAspect(AspectType<A> type,
A aspect)
Add an aspect supported by this
Aspectable . |
SwingGadget |
SwingGadgetFactory.create(SwingGadgetContext<E> context)
Creates a specific
SwingGadget . |
<A> A |
AbstractValueHoldingSwingGadget.getAspect(AspectType<A> type)
Request an aspect from the aspectable.
|
void |
NotificationHost.onModification(GadgetIdentifier identifier)
Notify about a modification in value.
|
void |
NotificationHost.onStateChange(GadgetIdentifier identifier)
Notify about a state change in value.
|
Modifier and Type | Method and Description |
---|---|
<C extends DisplayElementOperation.ClientSpecificConfigurator> |
DisplayElementOperation.getConfigurator(Class<C> configuratorType)
Provides an instance of a configurator as requested by the given type.
|
RemoteFormData |
OpenElementDataFormOperation.perform(DataProvider element)
Performs the operation on a data providing element.
|
RemoteFormData |
OpenElementMetaFormOperation.perform(IDProvider element)
Perform the operation on the given element.
|
Modifier and Type | Method and Description |
---|---|
void |
ShowReportOperation.perform(Class<?> pluginType)
Opens and refreshes the specified report plugin based on the configuration of this operation.
|
RemoteFormData |
OpenElementDataFormOperation.perform(DataProvider element)
Performs the operation on a data providing element.
|
FormData |
ShowFormDialogOperation.perform(Form form,
List<Language> languages)
Show a form based on the given structural definition and return the form's result.
|
FormData |
ShowFormDialogOperation.perform(Form form,
List<Language> languages)
Show a form based on the given structural definition and return the form's result.
|
void |
DisplayElementOperation.perform(IDProvider element)
Perform this operation wrt. the given element.
|
RequestOperation.Answer |
RequestOperation.perform(String question)
Asks the given question, returning the selected answer.
|
void |
OpenComparisonDialogOperation.perform(String originalText,
String modifiedText)
Opens a differential view on the original and modified texts.
|
void |
OpenComparisonDialogOperation.perform(String originalText,
String modifiedText)
Opens a differential view on the original and modified texts.
|
String |
OpenMergeDialogOperation.perform(String originalText,
String modifiedText)
Opens a differential view on the original and modified texts.
|
String |
OpenMergeDialogOperation.perform(String originalText,
String modifiedText)
Opens a differential view on the original and modified texts.
|
void |
OpenComparisonDialogOperation.setDialogTitle(String title)
Sets the title of the dialog.
|
void |
OpenMergeDialogOperation.setDialogTitle(String title)
Sets the title of the dialog.
|
void |
PreviewOperation.setElement(IDProvider element)
Ensure the preview being shown belongs to the element defined.
|
void |
RequestOperation.setKind(RequestOperation.Kind kind)
Set the kind of request to be answered.
|
void |
OpenComparisonDialogOperation.setModifiedHeader(String header)
Sets the header for the modified text section.
|
void |
OpenMergeDialogOperation.setModifiedHeader(String header)
Sets the header for the modified text section.
|
void |
OpenComparisonDialogOperation.setOriginalHeader(String header)
Sets the header for the original text section.
|
void |
OpenMergeDialogOperation.setOriginalHeader(String header)
Sets the header for the original text section.
|
<T> void |
ShowReportOperation.setParameter(Parameter<T> parameter,
T value)
Specifies a filter parameter value of the target report plugin.
|
void |
ShowFormDialogOperation.setRuleset(String rulesetDefinition)
Set the ruleset to be used by providing an XML-based definition.
|
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 |
---|---|
String |
WebeditUiAgent.getDisplayName(IDProvider element)
Provides the display name for the given store element.
|
String |
WebeditColor.getHEX()
Returns the HEX value representing the color in the sRGB color model (e.g.
|
String |
DataAssociationHandler.getId(A association)
Returns the identifier of the given association.
|
<T,A> String |
DataAssociationAgent.getId(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> token,
A association)
Returns the identifier of the specified data association.
|
String |
DataAssociationAgent.getId(String namespace,
Object association)
Returns the identifier of the specified data association.
|
Locale |
WebeditUiAgent.getLocale()
Provides the locale with which the webedit UI is localized.
|
String |
DataAssociationHandler.Type.getNamespace()
Returns the namespace of the assocation.
|
DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> |
DataAssociationHandler.getType()
Returns the type token of this handler.
|
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.
|
<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<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.
|
<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.
|
<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.
|
String |
DataAssociationHandler.getId(A association)
Returns the identifier of the given association.
|
<T,A> String |
DataAssociationAgent.getId(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> token,
A association)
Returns the identifier of the specified data association.
|
<T,A> String |
DataAssociationAgent.getId(DataAssociationHandler.Type<? extends DataAssociationHandler<T,A>> token,
A association)
Returns the identifier of the specified data association.
|
String |
DataAssociationAgent.getId(String namespace,
Object association)
Returns the identifier of the specified data association.
|
String |
DataAssociationAgent.getId(String namespace,
Object association)
Returns the identifier of the specified data association.
|
Constructor and Description |
---|
Type(String namespace)
Creates a new type token with a unique namespace.
|
Modifier and Type | Method and Description |
---|---|
ClientItem |
ClientItemContext.createItem(String iconUrl,
String title,
ClientItemPerformable handler)
Creates an action using the given parameters.
|
Modifier and Type | Method and Description |
---|---|
ClientItem |
ClientItemContext.createItem(String iconUrl,
String title,
ClientItemPerformable handler)
Creates an action using the given parameters.
|
ClientItem |
ClientItemContext.createItem(String iconUrl,
String title,
ClientItemPerformable handler)
Creates an action using the given parameters.
|
void |
Common.execute(String identifier,
JavaScriptObject params,
JavaScriptObject callback)
Executes a project script or an executable.
|
void |
ClientItemsPlugin.getItems(ClientItemContext context,
JavaScriptObject callback)
Requests action in the specified context.
|
void |
ClientItemsPlugin.getItems(ClientItemContext context,
JavaScriptObject callback)
Requests action in the specified context.
|
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 |
---|---|
ReportPluginProvider<T> |
WebeditReportPlugin.createProvider()
Deprecated.
Factory method to create an object provider instance for use with this report plug-in.
|
ReportPluginRenderer<T> |
WebeditReportPlugin.createRenderer()
Deprecated.
Factory method to create a renderer instance for use with this report plug-in.
|
Collection<? extends InlineEditItem> |
WebeditInlineEditItemsPlugin.getItems()
Get all items eligible for display in the plug-in's contextual setting.
|
Collection<? extends WebeditToolbarItem> |
WebeditToolbarActionsItemsPlugin.getItems()
Get all items eligible for display in the plug-in's contextual setting.
|
String |
ClientScriptProvidingItem.getLabel(C context)
Provides a label for this item wrt. the given context.
|
List<Parameter<?>> |
WebeditReportPlugin.getParameter()
Deprecated.
Returns a list of parameter definitions of this report plug-in, used to enable filter configuration by users within
the user interface.
|
List<String> |
ClientResourcePlugin.getScriptUrls()
Provides a list of relative or absolute javascript urls to be loaded in webedit.
|
List<String> |
ClientResourcePlugin.getStylesheetUrls()
Provides a list of relative or absolute stylesheet/css urls to be loaded in webedit.
|
Modifier and Type | Method and Description |
---|---|
String |
ClientScriptProvidingItem.getIconPath(C context)
Provides the resource path to this item's icon.
|
String |
ClientScriptProvidingItem.getLabel(C context)
Provides a label for this item wrt. the given context.
|
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. |
static FocusAreaBuilder |
FocusArea.builder()
Returns a builder for creating a new
FocusArea . |
FocusArea |
FocusAreaBuilder.create()
Creates the
FocusArea using the configured settings. |
Rectangle |
FocusArea.getBounds()
Bounds as pixels specifying the focus area in relation to the original image size,
where the top-left corner is represented by the coordinate
0x0 . |
List<FocusArea> |
FocusAreaProviderPlugin.getFocusAreas(FocusAreaProviderContext context)
Detects focus area presets available in the given image context.
|
Media |
FocusAreaProviderContext.getMedia()
The contextual
Media element the focus areas have been requested for. |
FocusAreaBuilder |
FocusAreaBuilder.orientationFromDegree(double degree)
Configures the orientation as degree, where right is
0° and top 90° |
FocusAreaBuilder |
FocusAreaBuilder.orientationFromEulerAngles(double pitch,
double roll,
double yaw)
Configures the orientation of the subject as determined by its Euler angles pitch, roll and yaw.
|
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 |
---|---|
List<FocusArea> |
FocusAreaProviderPlugin.getFocusAreas(FocusAreaProviderContext context)
Detects focus area presets available in the given image context.
|
Modifier and Type | Method and Description |
---|---|
String |
ClientScriptProvidingInlineEditItem.getLabel(InlineEditContext context)
Provides a label for this item.
|
String |
ExecutableInlineEditItem.getLabel(InlineEditContext context)
Provides a label for this item.
|
Language |
InlineEditContext.getLanguage()
Returns the language in which the inline editing items have been requested.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutableInlineEditItem.execute(InlineEditContext context)
Executes an operation associated with this item, taking into consideration the given context.
|
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.getLabel(InlineEditContext context)
Provides a label for this item.
|
String |
ExecutableInlineEditItem.getLabel(InlineEditContext context)
Provides a label for this item.
|
boolean |
InlineEditItem.isEnabled(InlineEditContext context)
Indicates, whether this item is enabled with respect to the given context.
|
boolean |
InlineEditItem.isVisible(InlineEditContext context)
Indicates the visibility of this item with respect to the given context.
|
Modifier and Type | Method and Description |
---|---|
Collection<? extends MediaManagementItem> |
MediaManagementItemsPlugin.getItems()
Get all items eligible for display in the plug-in's contextual setting.
|
Language |
MediaManagementContext.getLanguage()
Get the contextual language.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutableMediaManagementItem.execute(MediaManagementContext context)
Executes an operation associated with this item considering the given context.
|
String |
ClientScriptProvidingMediaManagementItem.getScript(MediaManagementContext context)
Returns script code, that will be executed on client-side.
|
boolean |
ClientScriptProvidingMediaManagementItem.isEnabled(MediaManagementContext context)
Indicates the visibility of this item wrt. the given context.
|
boolean |
ExecutableMediaManagementItem.isEnabled(MediaManagementContext context)
Indicates the visibility of this item wrt. the given context.
|
boolean |
MediaManagementItem.isEnabled(MediaManagementContext context)
Indicates the visibility of this item wrt. the given context.
|
boolean |
ClientScriptProvidingMediaManagementItem.isVisible(MediaManagementContext context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
ExecutableMediaManagementItem.isVisible(MediaManagementContext context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
MediaManagementItem.isVisible(MediaManagementContext context)
Indicates, whether this item is enabled wrt. the given context.
|
void |
MediaManagementContext.show(MediaFolder folder)
Requests to select and show the specified folder in the current media management dialog on the client.
|
Modifier and Type | Method and Description |
---|---|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.addItem(WebeditStatusNoteItem item)
Adds a item eligible for display in the status note's contextual setting.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.color(WebeditColor color)
Sets the color associated with the status note to create.
|
WebeditStatusNote |
WebeditStatusNoteBuilder.create()
Creates a new
WebeditStatusNote based on the previously configured settings. |
WebeditStatusNoteBuilder |
WebeditStatusNoteContext.createNote()
Creates a
WebeditStatusNoteBuilder for the creation of a WebeditStatusNote . |
IDProvider |
WebeditStatusNoteContext.getElement()
Provides the shown element.
|
Collection<? extends WebeditStatusNoteItem> |
WebeditStatusNote.getItems()
Get all items eligible for display in the status note's contextual setting.
|
List<WebeditStatusNote> |
WebeditStatusNotePlugin.getStatusNotes(WebeditStatusNoteContext context)
Get all items eligible for display as status information in webedit.
|
String |
WebeditStatusNote.getTitle()
Returns the title of this status information.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.icon(Image<?> icon)
Sets the icon associated with the status note to create.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.setItems(Collection<? extends WebeditStatusNoteItem> items)
Sets the items eligible for display in the status note's contextual setting.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.text(String text)
Sets the text of the status note to create.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.title(String title)
Sets the title of the status note to create.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.visibleOnLoad(boolean visibleOnLoad)
Sets the initial visibility of the status note after the preview has been loaded.
|
Modifier and Type | Method and Description |
---|---|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.addItem(WebeditStatusNoteItem item)
Adds a item eligible for display in the status note's contextual setting.
|
List<WebeditStatusNote> |
WebeditStatusNotePlugin.getStatusNotes(WebeditStatusNoteContext context)
Get all items eligible for display as status information in webedit.
|
boolean |
WebeditStatusNoteItem.isEnabled(WebeditStatusNoteContext context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
WebeditStatusNoteItem.isVisible(WebeditStatusNoteContext context)
Indicates the visibility of this item wrt. the given context.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.setItems(Collection<? extends WebeditStatusNoteItem> items)
Sets the items eligible for display in the status note's contextual setting.
|
WebeditStatusNoteBuilder |
WebeditStatusNoteBuilder.title(String title)
Sets the title of the status note to create.
|
Modifier and Type | Method and Description |
---|---|
String |
ClientScriptProvidingToolbarActionsItem.getLabel(ToolbarContext context)
Provides a label for this item wrt. the given context.
|
String |
ExecutableToolbarActionsItem.getLabel(ToolbarContext context)
Provides a label for this item.
|
Modifier and Type | Method and Description |
---|---|
void |
ExecutableToolbarActionsItem.execute(ToolbarContext context)
Executes an operation associated with this item, taking into consideration the given context.
|
String |
ClientScriptProvidingToolbarActionsItem.getIconPath(ToolbarContext context)
Returns a URL for the button item's icon graphic that will be shown in the WebClient.
|
String |
ExecutableToolbarActionsItem.getIconPath(ToolbarContext context)
Returns a URL for an icon graphic associated with this item.
|
String |
ClientScriptProvidingToolbarActionsItem.getLabel(ToolbarContext context)
Provides a label for this item wrt. the given context.
|
String |
ExecutableToolbarActionsItem.getLabel(ToolbarContext context)
Provides a label for this item.
|
boolean |
WebeditToolbarItem.isEnabled(ToolbarContext context)
Indicates, whether this item is enabled wrt. the given context.
|
boolean |
WebeditToolbarItem.isVisible(ToolbarContext context)
Indicates the visibility of this item wrt. the given context.
|
Modifier and Type | Method and Description |
---|---|
SpecialistsBroker |
TranslationContext.getBroker()
A request local specialists broker, providing access to client operations.
|
GomFormElement |
TranslationContext.getGomElement()
The definition of the editor the content should be translated for.
|
Language |
TranslationContext.getSourceLanguage()
The language of the content to translate.
|
Language |
TranslationContext.getTargetLanguage()
The target language the translation should be done for.
|
Modifier and Type | Method and Description |
---|---|
void |
TranslationPlugin.register(TranslationHost host)
Register handler responsible for translating content in a specific context.
|
<T> void |
TranslationHost.register(TranslationType<T> type,
TranslationHost.Translator<T> handler)
Register a handler translating contents of the specified type.
|
<T> void |
TranslationHost.register(TranslationType<T> type,
TranslationHost.Translator<T> handler)
Register a handler translating contents of the specified type.
|
T |
TranslationHost.Translator.translate(TranslationContext context,
T object)
Translates the given content object in the specified context.
|
T |
TranslationHost.Translator.translate(TranslationContext context,
T object)
Translates the given content object in the specified context.
|
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.
|
Modifier and Type | Method and Description |
---|---|
void |
SelectOptionOperation.addOption(String label,
String value)
Configures one of the options the user should select from.
|
void |
SelectOptionOperation.addOption(String label,
String value)
Configures one of the options the user should select from.
|
void |
ClientResourceOperation.addScriptUrl(String url)
Add a relative or absolute javascript url to load on
ClientResourceOperation.perform(boolean) . |
void |
ClientResourceOperation.addStylesheetUrl(String url)
Add a relative or absolute stylesheet url to load on
ClientResourceOperation.perform(boolean) . |
NewSectionOperation |
NewSectionOperation.body(Body body)
Body on which a new section should be created.
|
void |
ComparisonDialogOperation.perform(DataProvider element)
Opens the comparison dialog using the configured settings.
|
NewSectionOperation |
NewSectionOperation.preselectedLanguage(Language language)
Sets a preselected language in new-section dialogs.
|
NewSectionOperation |
NewSectionOperation.template(SectionTemplate template)
The
SectionTemplate on which the new section should be based on. |
Modifier and Type | Method and Description |
---|---|
WebPluginGadget<C> |
WebPluginGadgetFactory.create(GadgetContext<G> context)
Creates a specific pluggable gadget.
|
String |
WebPluginGadgetFactory.getControllerName()
Provides the name of the javascript controller constructor for this gadget, which should be defined as window property (e.g. window.ControllerConstructor = ...).
|
List<String> |
WebPluginGadgetFactory.getScriptUrls()
Provides a list of relative or absolute javascript urls for this webedit gadget.
|
List<String> |
WebPluginGadgetFactory.getStylesheetUrls()
Provides a list of relative or absolute stylesheet/css urls for this webedit gadget.
|
Modifier and Type | Method and Description |
---|---|
WebPluginGadget<C> |
WebPluginGadgetFactory.create(GadgetContext<G> context)
Creates a specific pluggable gadget.
|
Modifier and Type | Method and Description |
---|---|
boolean |
TransferHandling.HandlerHost.Handler.handle(SpecialistsBroker feededBroker,
CommodityContainer commodities)
Handle the given transfers.
|
boolean |
TransferHandling.HandlerHost.Handler.handle(SpecialistsBroker feededBroker,
CommodityContainer commodities)
Handle the given transfers.
|
void |
TransferHandling.HandlerHost.registerHandler(TransferHandling.HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
TransferHandling.HandlerHost.registerHandler(TransferHandling.HandlerHost.Handler handler,
Collection<TransferType<?>> types)
Registers a handler receiving all transfer type-mapped commodities.
|
void |
TransferHandling.registerHandlers(TransferHandling.HandlerHost host)
Register handler responsible for receiving commodities in a specific context.
|
Modifier and Type | Method and Description |
---|---|
String |
WorkflowGroup.getDisplayName()
Returns the display name of this group.
|
List<IDProvider> |
WorkflowGroup.getElements()
Returns all elements of this group.
|
WebeditElementStatusProviderPlugin.State |
WebeditElementStatusProviderPlugin.getReleaseState(IDProvider element)
Returns the release state of the given
element , consider depending objects like it's page or references media. |
List<WorkflowGroup> |
WebeditElementStatusProviderPlugin.getWorkflowGroups(IDProvider element)
Returns a list of
WorkflowGroup objects, each group should contain elements with common workflow
actions. |
WorkflowAgent.WorkflowProcessContext |
WorkflowAgent.startWorkflow(Workflow workflow)
Starts a new workflow process
without context . |
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 |
---|---|
WebeditElementStatusProviderPlugin.State |
WebeditElementStatusProviderPlugin.getReleaseState(IDProvider element)
Returns the release state of the given
element , consider depending objects like it's page or references media. |
List<WorkflowGroup> |
WebeditElementStatusProviderPlugin.getWorkflowGroups(IDProvider element)
Returns a list of
WorkflowGroup objects, each group should contain elements with common workflow
actions. |
default boolean |
WebeditElementStatusProviderPlugin.isSupported(IDProvider element)
Returns whether or not this plugin can provide status information for the given element.
|
WorkflowAgent.WorkflowProcessContext |
WorkflowAgent.process(Task task,
Transition transition)
Processes the next
activity of the given task specified by given transition, wherefore given transitionmust be one of the outgoing transitions of the current task state ( task . |
WorkflowAgent.WorkflowProcessContext |
WorkflowAgent.process(Task task,
Transition transition)
Processes the next
activity of the given task specified by given transition, wherefore given transitionmust be one of the outgoing transitions of the current task state ( task . |
WorkflowAgent.WorkflowProcessContext |
WorkflowAgent.startWorkflow(Workflow workflow)
Starts a new workflow process
without context . |
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 |
CaseMode.convertCase(String value)
Convert the given identifier to the
|
Entity |
Session.createEntity(String type)
Create a new entity of the given
type |
Select |
Session.createSelect(String name)
Create a select for the entity type with the provided
name . |
EntityList |
Session.executeQuery(Select select)
Execute the provided query and returns the matching entities.
|
Entity |
Session.find(Identifier identifier)
Return the entity with the given
identifier . |
Entity |
Session.findNotNull(KeyValue keyValue)
Returns an entity with the given
keyValue even if it doesn't exist. |
Entity |
Session.findNotNull(String entityTypeName,
Object... key)
Returns an entity of type
entityTypeName with the id key even if it doesn't exists.In that case the entity's state is NOT_EXISTS . |
CaseMode |
Layer.getCaseMode()
Provides the mode for letter case handling.
|
CaseMode |
Layer.getCaseModeForDbName()
Case mode for database name.
|
Comparator<String> |
CaseMode.getComparator()
CaseMode.UPPER_CASE .getComparator().compare("products", "PRODUCTS") will yield 0 . |
Layer.TransactionIsolationLevel |
Layer.getDefaultTransactionIsolationLevel()
Get the default isolation level of this layer.
|
List<Entity> |
Session.getDeletedEntities(String entityTypeName)
Get all deleted entities from type
entityTypeName . |
List<Entity> |
Session.getHistory(KeyValue keyValue)
Return the history of the entity with the given
keyValue . |
List<Entity> |
Session.getInvalidEntities(KeyValue keyValue)
Return a list of invalid entities of the given
keyValue . |
Set<KeyValue> |
Session.getReleasedDeleted(String entityTypeName)
Get the key values of all entities of the given entity type which are deleted but still released.
|
Schema |
Session.getSchema()
Return the schema assigned with this session.
|
Select |
Session.xml2Select(String queryXml)
Construct a select from the xml document
queryXml . |
Modifier and Type | Method and Description |
---|---|
void |
Session.addSessionListener(de.espirit.or.SessionListener listener)
Add the
listener to this session. |
String |
CaseMode.convertCase(String value)
Convert the given identifier to the
|
Entity |
Session.createEntity(String type)
Create a new entity of the given
type |
Select |
Session.createSelect(String name)
Create a select for the entity type with the provided
name . |
void |
Session.delete(Entity entity)
Mark the
entity as deleted. |
EntityList |
Session.executeQuery(Select select)
Execute the provided query and returns the matching entities.
|
IdentifierList<UUID,Entity> |
Session.fetchEntities(String entityTypeName,
Collection<UUID> entityGids)
Fetches all entities specified by given
gids . |
IdentifierList<UUID,Entity> |
Session.fetchEntities(String entityTypeName,
Collection<UUID> entityGids)
Fetches all entities specified by given
gids . |
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(Identifier identifier)
Return the entity with the given
identifier . |
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 . |
Entity |
Session.find(String entityTypeName,
Object... key)
Return the entity of type
entityTypeName with the id key . |
Entity |
Session.findNotNull(KeyValue keyValue)
Returns an entity with the given
keyValue even if it doesn't exist. |
Entity |
Session.findNotNull(String entityTypeName,
Object... key)
Returns an entity of type
entityTypeName with the id key even if it doesn't exists.In that case the entity's state is NOT_EXISTS . |
Entity |
Session.findNotNull(String entityTypeName,
Object... key)
Returns an entity of type
entityTypeName with the id key even if it doesn't exists.In that case the entity's state is NOT_EXISTS . |
Map<String,String> |
Layer.getDefaultParameters(String name)
Return a map of jdbc parameters to default values for this layer based on
name . |
List<Entity> |
Session.getDeletedEntities(String entityTypeName)
Get all deleted entities from type
entityTypeName . |
List<Entity> |
Session.getHistory(KeyValue keyValue)
Return the history of the entity with the given
keyValue . |
List<Entity> |
Session.getInvalidEntities(KeyValue keyValue)
Return a list of invalid entities of the given
keyValue . |
long |
Session.getLastChangeTime(Select select)
Get the timestamp of the last change of the result set of the specified select.
|
long |
Session.getLastChangeTime(Select select,
long after)
Get the timestamp of the last change of the result set of the specified select after the specified timestamp.
|
Set<KeyValue> |
Session.getReleasedDeleted(String entityTypeName)
Get the key values of all entities of the given entity type which are deleted but still released.
|
void |
Session.release(Entity entity)
Release the given
entity . |
void |
Session.removeSessionListener(de.espirit.or.SessionListener listener)
Remove the
listener from this session. |
void |
Session.restore(Identifier identifier)
Restore the deleted entity with the specified
identifier . |
Schema |
Session.syncSchemaWithDB(Schema schema,
boolean createKeys)
Update the database structure with the given
schema . |
Select |
Session.xml2Select(String queryXml)
Construct a select from the xml document
queryXml . |
Modifier and Type | Method and Description |
---|---|
String |
AbstractConstraint.getAttributeName()
Return the name of the attribute this constraint belongs to.
|
String |
AttributeConstraint.getAttributeName()
Return the name of the attribute this constraint belongs to.
|
List<Order> |
Select.getOrders()
Returns an unmodifiable list of defined
orders of this select. |
Modifier and Type | Method and Description |
---|---|
void |
ComposedConstraint.add(Constraint constraint)
Add a new sub constraint to this composed constraint.
|
void |
Select.add(Order order)
Appends the given order criteria to the list of defined
orders of this select. |
void |
Select.add(Parameter parameter)
Adds the given parameter to this select.
|
Select |
Select.applyLanguage(String languageAbbreviation)
Make a clone of this select and replace all place holders
%lang% contained in constaints with the given languageAbbreviation |
boolean |
Select.containsParameter(String identifier)
Indicates whether a parameter specified by the given identifier exists or not.
|
Parameter |
Select.getParameter(String identifier)
Return the parameter with the given
identifier . |
Object |
Select.getParameterValue(String identifier)
Returns the value of the parameter specified by given identifier or
null if no parameterexists with the given identifier. |
boolean |
Select.isOrdered(String attributeName)
Return true if an order of the attribute
attributeName is already defined in this select. |
void |
Select.setParameter(String identifier,
Object value)
Sets the value for the
parameter specified by the givenidentifier. |
Constructor and Description |
---|
And(Constraint constraint)
Creates an And with the given sub constraint.
|
And(Constraint constraint1,
Constraint constraint2)
Creates an And combining the given constraints.
|
And(Constraint constraint1,
Constraint constraint2)
Creates an And combining the given constraints.
|
Equal(String attributeName,
Object value)
Creates a new Equal constraint for the attribute specified by given attributeName and with the given value.
|
Equal(String attributeName,
Parameter parameter)
Creates a new Equal constraint for the attribute specified by given attributeName and parameter.
|
GreaterThan(String attributeName,
Object value)
Creates a new GreaterThan constraint for the given attributeName and the given value
|
GreaterThan(String attributeName,
Parameter parameter)
Creates a new GreaterThan constraint for the given attributeName and given parameter
|
GreaterThanEqual(String attributeName,
Object value)
Creates a new GreaterThanEqual constraint for the given attributeName and the given value
|
GreaterThanEqual(String attributeName,
Parameter parameter)
Creates a new GreaterThanEqual constraint for the given attributeName and given parameter
|
In(String attributeName,
Iterable<Object> values)
Creates a new In constraint for the attribute specified by given attributeName and with the given value.
|
In(String attributeName,
Iterable<Object> values)
Creates a new In constraint for the attribute specified by given attributeName and with the given value.
|
In(String attributeName,
Parameter parameter)
Creates a new In constraint for the attribute specified by given attributeName and parameter.
|
In(String attributeName,
Parameter parameter)
Creates a new In constraint for the attribute specified by given attributeName and parameter.
|
IsNotNull(String attributeName)
Creates a IsNotNull constraint for the given attribute.
|
IsNull(String attributeName)
Creates a IsNull constraint for the given attribute.
|
LessThan(String attributeName,
Object value)
Creates a new LessThan constraint for the given attributeName and the given value.
|
LessThan(String attributeName,
Parameter parameter)
Creates a new LessThan constraint for the given attributeName and given parameter.
|
LessThanEqual(String attributeName,
Object value)
Creates a new LessThanEqual constraint for the given attributeName and the given value.
|
LessThanEqual(String attributeName,
Parameter parameter)
Creates a new LessThanEqual constraint for the given attributeName and given parameter.
|
Like(String attributeName,
Object value)
Creates a new Like constraint for the attribute specified by given attributeName and with the given value.
|
Like(String attributeName,
Parameter parameter)
Creates a new Like constraint for the attribute specified by given attributeName and parameter.
|
NotEqual(String attributeName,
Object value)
Creates a new NotEqual constraint for the attribute specified by given attributeName and with the given value.
|
NotEqual(String attributeName,
Parameter parameter)
Creates a new NotEqual constraint for the attribute specified by given attributeName and parameter.
|
Order(String attribute)
Creates an order criteria based on the attribute specified by the given attribute name and with ascending ordering.
|
Order(String attribute,
boolean ascending)
Creates an order criteria based on the attribute specified by the given attribute name and with ordering specified by the given ascending parameter.
|
Modifier and Type | Method and Description |
---|---|
EntityType |
Schema.createEntityType(String name)
Create a new entity type with the given
name |
CaseMode |
Schema.getCaseMode()
Get the case mode of the underlying database: lower, upper, or mixed case.
|
Collection<? extends EntityType> |
Schema.getEntityTypes()
Return all entity types contained in this schema.
|
List<Entity> |
Entity.getList(String name)
Return the value of the specified list attribute ("to N relation").
|
List<String> |
Identifier.getNames()
Returns a list of all names representing the values of this identifier.
|
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. |
Modifier and Type | Method and Description |
---|---|
boolean |
EntityType.containsAttribute(String name)
Checks up whether this type contains an attribute with the given name.
|
void |
Entity.copyFrom(Entity entity)
Copy the values of the given
entity to this entity. |
ComposedAttribute |
EntityType.createComposedAttribute(String name,
EntityType targetType,
ComposedAttribute.Relation type,
String opposedName)
Create a composed attribute with the given
name . |
ComposedAttribute |
EntityType.createComposedAttribute(String name,
EntityType targetType,
ComposedAttribute.Relation type,
String opposedName)
Create a composed attribute with the given
name . |
<T> de.espirit.or.schema.SimpleAttribute<T> |
EntityType.createSimpleAttribute(String name,
Class<T> type)
Create a simple attribute with the given
name and type . |
<T> de.espirit.or.schema.SimpleAttribute<T> |
EntityType.createSimpleAttribute(String name,
Class<T> type)
Create a simple attribute with the given
name and type . |
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.
|
<T> Attribute<T> |
EntityType.getAttribute(String name,
Class<T> type)
Provides the attribute with the given name if it is of the requested type.
|
Object |
Entity.getValue(String name)
Return the value of the
attribute specified by the given name . |
void |
EntityType.setName(String name)
Set the name of this entity type to
name . |
<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