| Package | Description |
|---|---|
| com.onwbp.adaptation |
Provides core classes and interfaces for accessing datasets, tables, and their records.
|
| com.onwbp.base.text |
Provides classes for creating user messages and nomenclatures.
|
| com.orchestranetworks.d3 |
Provides classes for distributed data delivery (D3) functionalities.
|
| com.orchestranetworks.instance |
Provides interfaces for accessing data sets.
|
| com.orchestranetworks.interactions |
Provides classes for UI interactions.
|
| com.orchestranetworks.module |
This package allows to handle module registration.
|
| com.orchestranetworks.rest |
Provides classes for the REST toolkit Java Framework functionalities.
|
| com.orchestranetworks.rest.security | |
| com.orchestranetworks.schema |
Represents XML Schema concepts and provides schema extensions capabilities.
|
| com.orchestranetworks.schema.dynamic |
A public API for defining a dynamic schema.
|
| com.orchestranetworks.schema.types.dataset |
Interfaces to define sets of data set references.
|
| com.orchestranetworks.schema.types.dataspace |
Interfaces to define sets of data space keys.
|
| com.orchestranetworks.search.strategy | |
| com.orchestranetworks.search.template | |
| com.orchestranetworks.service |
Provides classes and interfaces for implementing specific services and access rules on EBX®.
|
| com.orchestranetworks.service.comparison |
Provides classes and interfaces for to compute differences between
adaptations, homes and examine the results.
|
| com.orchestranetworks.service.directory |
Provides classes for Directory handling.
|
| com.orchestranetworks.service.extensions |
Provides classes and interfaces for specific extensions such as batch
and adaptation tree optimizer.
|
| com.orchestranetworks.ui |
This package provides the capability to create custom user interface components
that are integrated within EBX®.
|
| com.orchestranetworks.ui.form |
This package allows customizing forms.
|
| com.orchestranetworks.ui.perspective | |
| com.orchestranetworks.ui.toolbar |
This package allows customizing toolbars.
|
| com.orchestranetworks.userservice |
A public API for user services.
|
| com.orchestranetworks.userservice.declaration |
A public API for declaring user services.
|
| com.orchestranetworks.userservice.permission |
Allows the definition of activation rules and permission rules on user services.
|
| com.orchestranetworks.workflow |
Provides classes and interfaces for implementing workflow processes and
invoking them.
|
| Modifier and Type | Method and Description |
|---|---|
abstract UserMessage |
AdaptationHome.getDescription()
Returns the internationalized description of this dataspace or snapshot.
|
abstract UserMessage |
AdaptationHome.getLabel()
Returns the internationalized label of this dataspace or snapshot.
|
abstract UserMessage |
AdaptationHome.getLabelOrNameAsUserMessage()
Returns the internationalized label of this dataspace or snapshot.
|
UserMessage |
MalformedXPathExpressionException.getUserMessage() |
| Constructor and Description |
|---|
MalformedXPathExpressionException(UserMessage userMessage) |
MalformedXPathExpressionException(UserMessage userMessage,
Throwable aThrowable) |
| Modifier and Type | Class and Description |
|---|---|
class |
UserMessageLocalized
Provides a localized message based on strings directly set from Java code (not
externalized).
|
class |
UserMessageRef
Holds a user message that is persisted in a Java resource bundle.
|
class |
UserMessageString
Provides a message based on strings directly set from Java code (not
externalized).
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
ConversionException.getConversionMessage() |
UserMessage |
UserMessageString.setString(Locale aLocale,
String aRawString) |
UserMessage |
UserMessageString.setStringForDefault(String aRawString) |
| Modifier and Type | Method and Description |
|---|---|
static Map<Severity,UserMessage> |
Severity.getAllSeveritiesWithLabel()
Returns a map from the available severities to their corresponding user message.
|
| Modifier and Type | Method and Description |
|---|---|
Nomenclature<T> |
Nomenclature.addItemWithMessage(T aValue,
UserMessage aMessage)
Adds a
NomenclatureItemWithMessage with the specified content to this instance. |
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
D3Slave.State.getLabel()
Returns the state's label.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
HomeCreationSpec.getDescription() |
UserMessage |
RepositoryStatus.State.getLabel()
Returns the label for the end-user.
|
UserMessage |
HomeCreationSpec.getLabel() |
UserMessage |
ValueAccessException.getUserMessage()
Returns the user message associated with this exception.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ValueContextForValidationOnTable.addMessage(Adaptation aRecord,
SchemaNode aNode,
UserMessage aMessage)
Adds the specified validation message concerning a node in a single record.
|
void |
ValueContextForValidationOnTable.addMessage(Adaptation aRecord,
UserMessage aMessage)
Adds the specified validation message concerning a single record.
|
void |
ValueContextForValidationOnTable.addMessage(List<Adaptation> records,
UserMessage aMessage)
Adds the specified validation message concerning a set of records.
|
void |
ValueContextForValidationOnRecord.addMessage(SchemaNode aNode,
UserMessage aMessage)
Adds the specified validation message concerning a node in the current record.
|
void |
ValueContextForValidationOnTable.addMessage(String xpathPredicateOfRecords,
UserMessage aMessage)
Adds the specified validation message concerning the result of an XPath predicate.
|
void |
ValueContextForValidationOnTable.addMessage(UserMessage aMessage)
This method creates a new
validation item
whose subject is the table that is currently being validated. |
void |
ValueContextForValidationOnRecord.addMessage(UserMessage aMessage)
Adds the specified validation message to the current validation context.
|
void |
ValueContextForValidation.addMessage(UserMessage msg)
Adds the specified validation message.
|
static ValueAccessException |
ValueAccessException.createError(UserMessage aMessage)
Creates an exception associated with the specified user message.
|
abstract AdaptationHome |
Repository.createHome(AdaptationHome parentDataSpace,
HomeKey aKey,
Profile owner,
Session aSession,
UserMessage aLabel,
UserMessage aDescription)
Creates the specified dataspace or snapshot.
|
void |
HomeCreationSpec.setDescription(UserMessage description)
Specifies a description for the dataspace or snapshot to be created.
|
void |
HomeCreationSpec.setLabel(UserMessage label)
Specifies the label of the dataspace or snapshot to create.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
SessionInteraction.Specification.getAcceptButtonLabel()
Returns the label associated with the Accept button.
|
UserMessage |
SessionInteraction.Specification.getAcceptConfirmationMessage()
Returns the confirmation message associated with the Accept button.
|
UserMessage |
SessionInteraction.Specification.getRejectButtonLabel()
Returns the label associated with the Reject button.
|
UserMessage |
SessionInteraction.Specification.getRejectConfirmationMessage()
Returns the confirmation message associated with the Reject button.
|
UserMessage |
InteractionException.getUserMessage() |
| Modifier and Type | Method and Description |
|---|---|
List<UserMessage> |
SessionInteraction.DecisionResult.getErrorMessages()
Returns error messages if the comment is specified as mandatory but is currently empty,
and/or if a specific constraint is not valid.
|
| Constructor and Description |
|---|
IllegalInteractionStateException(UserMessage userMessage) |
InteractionException(UserMessage userMessage) |
InteractionException(UserMessage userMessage,
Throwable t) |
| Modifier and Type | Method and Description |
|---|---|
void |
ModuleServiceRegistrationContext.registerServiceGroup(ServiceGroupKey aServiceGroupKey,
UserMessage aLabel,
UserMessage aDescription)
Registers a new user service group in EBX®.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
LocalizedException.getUserMessage()
Returns the user message that may be displayed to the
end user as an error message.
|
| Constructor and Description |
|---|
LocalizedException(int aStatus,
UserMessage aUserMessage) |
LocalizedException(int aStatus,
UserMessage aUserMessage,
Integer anErrorCode) |
LocalizedException(int aStatus,
UserMessage aUserMessage,
Integer anErrorCode,
Throwable aCause)
Constructs a new instance with the provided data.
|
LocalizedException(int aStatus,
UserMessage aUserMessage,
Throwable aCause)
Constructs a new instance with the provided data,
without functional error code.
|
UnprocessableEntityException(UserMessage aUserMessage)
Creates an unprocessable entity exception.
|
UnprocessableEntityException(UserMessage aUserMessage,
Integer anErrorCode)
Creates an unprocessable entity exception.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
AuthorizationOutcome.getMessage()
Returns a
UserMessage that must be added to the HTTP response
in case of forbidden state. |
| Modifier and Type | Method and Description |
|---|---|
static AuthorizationOutcome |
AuthorizationOutcome.createForbidden(UserMessage anUserMessage)
Creates a "forbidden" outcome with a localized message.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
SchemaTypeName.getBuiltInTypeLabel()
Returns the internationalized label of this type name if it refers to one of built-in XSD or EBX®
data types.
|
UserMessage |
SchemaNode.getMandatoryUserMessage()
Returns the mandatory error message
(defined by the data model element
osd:mandatoryErrorMessage). |
UserMessage |
SchemaDocumentationContext.getStaticDescription()
Returns the description that is statically defined in the data model.
|
UserMessage |
SchemaDocumentationContext.getStaticLabel()
Returns the label that is statically defined in the data model.
|
UserMessage |
PathAccessException.getUserMessage()
Returns either the user message specified in the constructor, or
null. |
UserMessage |
InvalidSchemaException.getUserMessage() |
UserMessage |
ConstraintViolationException.getUserMessage()
Returns the user message associated with this exception.
|
default UserMessage |
TableRefFilter.getValidationMessage(Adaptation aRecord,
ValueContext currentContext)
Returns a validation message according to the specified context.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SchemaNodeContext.addMessage(UserMessage aMessage)
Attaches the specified message to the current component.
|
| Constructor and Description |
|---|
ConstraintViolationException(String XPathExpression,
UserMessage message,
SchemaNode node,
SchemaFacet facet) |
ConstraintViolationException(UserMessage aMessage) |
ConstraintViolationException(UserMessage aMessage,
SchemaFacet aFacet) |
ConstraintViolationException(UserMessage aMessage,
SchemaNode aNode,
SchemaFacet aFacet) |
InvalidSchemaException(UserMessage aMessage) |
PathAccessException(Path path,
UserMessage errorMessage) |
| Modifier and Type | Method and Description |
|---|---|
void |
BeanElement.setDescription(UserMessage aDescription)
Sets the localized description for this element.
|
void |
BeanFacetTableRef.setDisplayPattern(UserMessage aPattern)
Sets a custom display pattern for presenting the selected foreign key in the current record
and the sorted list of possible keys.
|
void |
BeanFacetTableRef.setFilterPredicate(String aPredicate,
UserMessage aValidationMessage)
Sets an XPath predicate filter.
|
void |
BeanElement.setLabel(UserMessage aLabel)
Sets the localized label for this element.
|
void |
BeanFacet.setMessage(UserMessage aMessage)
Sets the localized error message to display when the constraint check fails.
|
void |
BeanElement.setMinOccursErrorMessage(UserMessage anErrorMessage)
Sets the localized error message to display when the minimum number of occurrences
check failed.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
DatasetSet.DatasetChildrenPolicy.getLabel()
Returns the policy label.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
DataspaceSet.DataspaceType.getLabel()
Returns the type label.
|
UserMessage |
DataspaceSet.DataspaceChildrenPolicy.getLabel()
Returns the policy label.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
SynonymDeclaration.getUserDescription()
Returns the description of this synonym list.
|
UserMessage |
StopWordsDeclaration.getUserDescription()
Returns the description for this list of stop words.
|
UserMessage |
SynonymDeclaration.getUserLabel()
Returns the label of the synonym list.
|
UserMessage |
StopWordsDeclaration.getUserLabel()
Returns the label of the stop words list.
|
| Modifier and Type | Method and Description |
|---|---|
static StopWordsDeclaration |
StopWordsDeclaration.of(StopWordsKey aKey,
UserMessage aUserLabel,
UserMessage aUserDescription)
Returns an instance of a declaration for a list of stop words.
|
static SynonymDeclaration |
SynonymDeclaration.of(SynonymsKey aKey,
UserMessage aUserLabel,
UserMessage aUserDescription)
Returns an instance of synonym declaration.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
SearchTemplate.getUserDescription()
Returns the description of this template.
|
UserMessage |
SearchTemplate.getUserLabel()
Returns the label of this template.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
ActionPermission.getDisabledReason()
Only defined if this state is set to 'disabled' and a specific reason is provided.
|
UserMessage |
ValidationReportItem.getMessage()
Returns a user-friendly message.
|
UserMessage |
AccessPermission.getReadOnlyReason()
Optionally defined if this state is set as 'readOnly' or as 'hidden' and a specific reason is provided.
|
| Modifier and Type | Method and Description |
|---|---|
abstract void |
ServiceContext.addMessage(UserMessage aMessage)
Deprecated.
Adds a message regarding the validation of the form in the page.
|
static OperationException |
OperationException.createError(UserMessage aMessage) |
static OperationException |
OperationException.createError(UserMessage aMessage,
Throwable ex) |
abstract void |
LoggingCategory.debug(UserMessage aMessage)
Logs the specified message with priority 'debug',
using the
en_US locale. |
abstract void |
LoggingCategory.error(UserMessage aMessage)
Logs the specified message with priority 'error'
using the locale
en_US. |
abstract void |
LoggingCategory.error(UserMessage aMessage,
Throwable t)
Logs the specified message and the stack trace of the exception
with priority 'error' using the locale
en_US. |
static ActionPermission |
ActionPermission.getDisabled(UserMessage aReason)
Factory method that specifies that an action is neither displayed to the user
nor can be executed by the user in the current session context.
|
static ActionPermission |
ActionPermission.getHidden(UserMessage aReason)
Factory method that specifies that an action is neither displayed to the user
nor can be executed by the user in the current session context.
|
static AccessPermission |
AccessPermission.getHidden(UserMessage aReason)
Factory method specifying that a resource can not be modified
and is not displayed.
|
static AccessPermission |
AccessPermission.getReadOnly(UserMessage aReason)
Factory method specifying that a resource can be displayed but it cannot modified.
|
abstract void |
LoggingCategory.info(UserMessage aMessage)
Logs the specified message with priority 'info',
using the
en_US locale. |
void |
ProcedureContext.setInstanceDescription(Adaptation aDataSet,
UserMessage aDescription)
Specifies a description for the specified dataset.
|
void |
ProcedureContext.setInstanceLabel(Adaptation aDataSet,
UserMessage aLabel)
Specifies a label for the specified dataset.
|
void |
ServiceContext.setTitle(UserMessage aMessage)
Deprecated.
Replaces the default title of the user service in the header of the workspace.
|
abstract void |
LoggingCategory.warn(UserMessage aMessage)
Logs the specified message with priority 'warn',
using the
en_US locale. |
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
CompareFilter.getLabel() |
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
DirectoryDefault.RoleEntity.getDescription() |
UserMessage |
DirectoryDefault.RoleEntity.getLabel() |
| Modifier and Type | Method and Description |
|---|---|
void |
DirectoryDefault.RoleEntity.setDescription(UserMessage description) |
void |
DirectoryDefault.RoleEntity.setLabel(UserMessage label) |
| Constructor and Description |
|---|
AuthenticationException(UserMessage aMessage)
Note: message severity is not taken into account.
|
AuthenticationException(UserMessage aMessage,
Throwable cause)
Note: message severity is not taken into account.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
LockSpec.getDescription() |
| Modifier and Type | Method and Description |
|---|---|
void |
LockSpec.setDescription(UserMessage description)
Specifies a message describing the the context or reason for the lock.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
UIButtonSpec.getConfirmationMessage()
Returns the confirmation message of the button,
null if it was not set. |
UserMessage |
UIButtonSpecJSActionToggle.getConfirmationMessageOff() |
UserMessage |
UITableFilter.getLabel()
Returns the label of this filter.
|
UserMessage |
UIButtonSpec.getLabel()
Returns the label of the button.
|
UserMessage |
UIBeanEditor.getMessageForSettingNull(UIResponseContext aResponse)
Deprecated.
Returns the message to display in the user interface
when setting the value of the associated element to
null . |
UserMessage |
UIBeanEditor.getMessageForSettingValue(UIResponseContext aResponse)
Deprecated.
Returns the message to display in the user interface
when editing a value of the associated element;
the action is available when the current value is undefined (
null)
in the user interface. |
UserMessage |
UIButtonSpec.getTooltip()
Returns the tooltip of the button,
null if it is not set. |
| Modifier and Type | Method and Description |
|---|---|
UIBodyWriter |
UIBodyWriter.add(UserMessage aUserMessage)
Adds a user message in the current session's locale to the body stream.
|
void |
UIFormLabelSpec.DocumentationPane.addBlock(String aTitle,
UserMessage aText)
Specifies an additional paragraph in an open section, consisting
of a title and a text.
|
void |
UIFormLabelSpec.DocumentationPane.addBlock(UserMessage aText)
Specifies an additional paragraph in an open section.
|
void |
UIFormLabelSpec.DocumentationPane.addBlock(UserMessage aTitle,
String aText)
Specifies an additional paragraph in an open section, consisting
of a title and text.
|
void |
UIFormLabelSpec.DocumentationPane.addBlock(UserMessage aTitle,
UserMessage aText)
Specifies an additional paragraph in an open section, consisting
of a title and a text.
|
void |
UITableFilterRequestContext.addMessage(UserMessage aMessage)
Adds a message, which will be displayed in the standard message box of the user interface.
|
UIBodyWriter |
UIBodyWriter.addSafeAttribute(String aName,
UserMessage aValue)
Adds an HTML attribute to the body stream, following the pattern:
aName="aValue"
If the given attribute value contains double quotes, the quotes will be escaped.
|
UIBodyWriter |
UIBodyWriter.addSafeInnerHTML(UserMessage aUserMessage) |
void |
UIServiceComponentWriter.addSubSubtitle(UserMessage aMessage)
Deprecated.
Adds a title under
subtitle level. |
void |
UIServiceComponentWriter.addSubtitle(UserMessage aMessage)
Deprecated.
Adds a subtitle in the page.
|
void |
UIAjaxContext.addUserMessage(UserMessage aMessage)
Add a user message to the message box according to its severity.
|
UIButtonSpecJSAction |
UIComponentWriter.buildButtonPreview(String aURL,
UserMessage aLabel)
Builds a preview button with the specified label.
|
void |
UIButtonSpec.setConfirmationMessage(UserMessage confirmationMessage)
Sets a message to confirm the button action.
|
void |
UIButtonSpecJSActionToggle.setConfirmationMessageOff(UserMessage confirmationMessageOff)
Sets a message to confirm the action performed when the button is deactivated.
|
void |
UIFormLabelSpec.DocumentationPane.setDescription(UserMessage description)
Specifies the description of the documentation pane.
|
void |
UIFormLabelSpec.DocumentationPane.setError(UserMessage error)
Optional, specifies an error message associated with the current node.
|
void |
UITableFilter.setLabel(UserMessage aUserMessage) |
void |
UIButtonSpec.setLabel(UserMessage aLabel)
Sets a label for the button.
|
void |
UIFormLabelSpec.DocumentationPane.setTitle(UserMessage aTitle)
Specifies the title of the documentation pane.
|
void |
UIButtonSpec.setTooltip(UserMessage tooltip)
Sets a tooltip for the button.
|
void |
UIFormLabelSpec.DocumentationPane.setValidationMessage(UserMessage aValidationMessage)
Optional, specifies a validation message associated with the current node.
|
void |
UIComponentWriter.startBorder(boolean isColored,
UserMessage aCaption)
Starts a border with a caption.
|
String |
UIComponentWriter.startExpandCollapseBlock(UserMessage aCaption,
boolean collapsed)
Starts an expand/collapse block with a caption.
|
| Constructor and Description |
|---|
DocumentationPane(UserMessage aTitle)
Class constructor for specific documentation.
|
UIButtonSpecJSAction(UserMessage aLabel,
String aJavaScriptCommand) |
UIButtonSpecJSActionToggle(UserMessage aLabel,
String aJSCmdOn,
String aJSCmdOff) |
UIButtonSpecSubmit(UserMessage aLabel,
String aName,
String aValue) |
UIButtonSpecURL(UserMessage label,
String url)
The constructor.
|
UIFormLabelSpec(UIFormLabelSpec.DocumentationPane aDocumentationPane,
UserMessage aLabelMessage)
Creates a simple label with a
UserMessage and a
documentation pane that is displayed in a pop-up. |
UIFormLabelSpec(UserMessage aLabelMessage)
Creates a simple label with a
UserMessage. |
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
UIExpandCollapseBlock.getLabel()
Returns the previously defined label, or an empty one if none was defined.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UIFormPaneWithTabs.addTab(UserMessage aTitle,
UIFormPane aPane)
Adds a new tab to the layout.
|
void |
UIFormBottomBar.setCloseButtonLabel(UserMessage aButtonLabel)
Sets a custom label for the Close button.
|
void |
UIExpandCollapseBlock.setLabel(UserMessage aLabel)
Sets the label of the expand/collapse block.
|
void |
UIFormBottomBar.setRevertButtonLabel(UserMessage aButtonLabel)
Sets a custom label for the Revert button.
|
void |
UIFormBottomBar.setSubmitAndCloseButtonLabel(UserMessage aButtonLabel)
Sets a custom label for the Save & Close button
(previously called "Submit & Close").
|
void |
UIFormBottomBar.setSubmitButtonLabel(UserMessage aButtonLabel)
Sets a custom label for the Save button
(previously called "Submit").
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
PerspectiveItem.getDescription()
Returns the description of this item.
|
UserMessage |
DisplayDensity.getLabel()
Returns the display density label.
|
UserMessage |
PerspectiveItem.getLabel(Locale aLocale)
Returns the label of this item.
|
| Modifier and Type | Method and Description |
|---|---|
ToolbarActionButton |
Toolbar.addActionButton(UserMessage aLabel)
Creates a new instance of an action button and adds it directly in this toolbar.
|
ToolbarActionMenuItem |
ToolbarMenuGroup.addActionItem(UserMessage actionLabel)
Adds a new action item to the given group with the specified label.
|
ToolbarMenuGroup |
ToolbarMenu.addGroup(UserMessage aLabel)
Creates a new instance of a group with label,
and adds it directly in this menu button.
|
ToolbarMenuButton |
Toolbar.addMenuButton(UserMessage aLabel)
Creates a new instance of a menu button and adds it directly in this toolbar.
|
ToolbarSubMenuItem |
ToolbarMenuGroup.addSubMenu(UserMessage aLabel)
Creates a new instance of a sub-menu and adds it directly to this group.
|
void |
ToolbarMenuItem.setDescription(UserMessage aDescription)
Sets the description of this menu item
|
void |
ToolbarMenuGroup.setDescription(UserMessage aDescription)
Sets the description of this menu item.
|
void |
ToolbarButton.setDescription(UserMessage aDescription)
Sets the description of the button.
|
| Modifier and Type | Method and Description |
|---|---|
void |
UserServiceObjectContextForInputValidation.addMessage(UserMessage aMessage)
Adds a message that will be displayed in the standard message pane of the user
interface using same severity as
aMessage.getSeverity(). |
void |
UserServiceInitializeContext.addMessage(UserMessage aMessage)
Adds a message that will be displayed in the standard message pane of the user
interface using same severity as
aMessage.getSeverity(). |
void |
UserServiceAjaxResponse.addMessage(UserMessage aMessage)
Adds a message to the message box according to its severity.
|
UIButtonSpecNavigation |
UserServiceWriter.newActionButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a specification for a localized action button.
|
UIButtonSpecNavigation |
UserServiceDisplayConfigurator.newActionButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a specification for a localized action button.
|
UIButtonSpecSubmit |
UserServicePaneWriter.newSubmitButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a localized specification for a submit button.
|
UIButtonSpecSubmit |
UserServiceDisplayConfigurator.newSubmitButton(UserMessage aLabel,
UserServiceEvent aCallback)
Creates a localized specification for a submit button.
|
UserServiceTab |
UserServiceTabbedPane.newTab(UserMessage aTitle,
UserServicePane aPane)
Create a new tab.
|
void |
UserServiceTab.setTitle(UserMessage aTitle)
Sets the tab's localized title.
|
void |
UserServiceDisplayConfigurator.setTitle(UserMessage aTitle)
Sets the localized title of the service.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
WebComponentParameter.getDescription()
Returns the description of the parameter.
|
UserMessage |
WebComponentParameter.getLabel()
Returns the label of the parameter.
|
| Modifier and Type | Method and Description |
|---|---|
WebComponentParameter |
WebComponentDeclarationContext.addInputOutputParameter(String aName,
UserMessage aLabel,
UserMessage aDescription)
Adds the specified input-output parameter.
|
WebComponentParameter |
WebComponentDeclarationContext.addInputParameter(String aName,
UserMessage aLabel,
UserMessage aDescription)
Adds the specified input-only parameter.
|
WebComponentParameter |
WebComponentDeclarationContext.addOutputParameter(String aName,
UserMessage aLabel,
UserMessage aDescription)
Adds the specified output-only parameter.
|
WebComponentParameter |
WebComponentDeclarationContext.addParameter(String aName,
boolean isInput,
boolean isOutput,
UserMessage aLabel,
UserMessage aDescription)
Adds the specified parameter.
|
void |
UserServicePropertiesDefinitionContext.setConfirmationMessageBeforeLaunch(UserMessage aConfirmationMessage)
Defines a localized confirmation message to be displayed when the service is launched
as an action from a toolbar.
|
void |
WebComponentParameter.setDescription(UserMessage description)
Sets the description of the parameter.
|
void |
UserServicePropertiesDefinitionContext.setDescription(UserMessage aDescription)
Defines the service's default description.
|
void |
WebComponentParameter.setLabel(UserMessage label)
Sets the label of the parameter.
|
void |
UserServicePropertiesDefinitionContext.setLabel(UserMessage aLabel)
Defines the service's default title.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
UserServicePermission.getDisabledReason()
Only defined if this state is set to 'disabled' and a specific reason is provided.
|
| Modifier and Type | Method and Description |
|---|---|
static UserServicePermission |
UserServicePermission.getDisabled(UserMessage aReason)
Factory method that specifies that a user service can not be displayed or executed
in the current session context.
|
| Modifier and Type | Method and Description |
|---|---|
UserMessage |
UserTask.WorkItem.getDescription()
Returns description of the associated node.
|
UserMessage |
PublishedProcess.getDescription()
Returns the description of the workflow publication.
|
UserMessage |
ProcessInstanceStep.getDescription()
Returns the description of this step.
|
UserMessage |
ProcessInstance.getDescription()
Returns the description of this workflow.
|
UserMessage |
UserTask.WorkItem.getLabel()
Returns label of the associated node.
|
UserMessage |
UserTask.WorkItem.State.getLabel() |
UserMessage |
UserTask.CompletionStrategy.getLabel()
Returns the label associated with the task termination criteria.
|
UserMessage |
PublishedProcess.getLabel()
Returns the label of the workflow publication.
|
UserMessage |
ProcessInstanceStep.getLabel()
Returns the label of this step.
|
UserMessage |
ProcessInstanceStep.WaitTaskState.getLabel()
Returns the label of the wait task state.
|
UserMessage |
ProcessInstance.getLabel()
Returns the label of this workflow.
|
UserMessage |
UserTask.WorkItem.getSpecificLabel()
Returns the specific label of the work item.
|
UserMessage |
CreationWorkItemSpec.getSpecificLabel() |
| Modifier and Type | Method and Description |
|---|---|
void |
UserTaskBeforeWorkItemCompletionContext.reportMessage(UserMessage anErrorMessage)
Blocks the 'accept' or the 'reject' action of the end user and reports
the specified error message.
|
void |
ProcessLauncher.setDescription(UserMessage description)
Specifies the description of the new workflow instance to be launched.
|
void |
ProcessLauncher.setLabel(UserMessage label)
Specifies the label of the new workflow instance to be launched.
|
void |
CreationWorkItemSpec.setSpecificLabel(UserMessage specificLabel)
Sets the label of the work item.
|
Documentation