Uses of Class
com.onwbp.base.text.UserMessage

Packages that use UserMessage

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.businessObjects
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.ui.view
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.

Uses of UserMessage in com.onwbp.adaptation

Methods in com.onwbp.adaptation that return UserMessage

Modifier and Type	Method	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()

Constructors in com.onwbp.adaptation with parameters of type UserMessage

Modifier	Constructor	Description
	MalformedXPathExpressionException(UserMessage userMessage)
	MalformedXPathExpressionException(UserMessage userMessage, Throwable aThrowable)

Uses of UserMessage in com.onwbp.base.text

Subclasses of UserMessage in com.onwbp.base.text

Modifier and Type	Class	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).

Methods in com.onwbp.base.text that return UserMessage

Modifier and Type	Method	Description
UserMessage	ConversionException.getConversionMessage()
UserMessage	UserMessageString.setString(Locale aLocale, String aRawString)
UserMessage	UserMessageString.setStringForDefault(String aRawString)

Methods in com.onwbp.base.text that return types with arguments of type UserMessage

Modifier and Type	Method	Description
static Map<Severity,UserMessage>	Severity.getAllSeveritiesWithLabel()	Returns a map from the available severities to their corresponding user message.

Methods in com.onwbp.base.text with parameters of type UserMessage

Modifier and Type	Method	Description
Nomenclature<T>	Nomenclature.addItemWithMessage(T aValue, UserMessage aMessage)	Adds a NomenclatureItemWithMessage with the specified content to this instance.

Uses of UserMessage in com.orchestranetworks.d3

Methods in com.orchestranetworks.d3 that return UserMessage

Modifier and Type	Method	Description
UserMessage	D3Slave.State.getLabel()	Returns the state's label.

Uses of UserMessage in com.orchestranetworks.instance

Methods in com.orchestranetworks.instance that return UserMessage

Modifier and Type	Method	Description
UserMessage	HomeCreationSpec.getDescription()
UserMessage	HomeCreationSpec.getLabel()
UserMessage	RepositoryStatus.State.getLabel()	Returns the label for the end-user.
UserMessage	ValueAccessException.getUserMessage()	Returns the user message associated with this exception.

Methods in com.orchestranetworks.instance with parameters of type UserMessage

Modifier and Type	Method	Description
void	ValueContextForValidation.addMessage(UserMessage msg)	Adds the specified validation message.
void	ValueContextForValidationOnRecord.addMessage(UserMessage aMessage)	Adds the specified validation message to the current validation context.
void	ValueContextForValidationOnRecord.addMessage(SchemaNode aNode, UserMessage aMessage)	Adds the specified validation message concerning a node in the current record.
void	ValueContextForValidationOnTable.addMessage(Adaptation aRecord, UserMessage aMessage)	Adds the specified validation message concerning a single record.
void	ValueContextForValidationOnTable.addMessage(Adaptation aRecord, SchemaNode aNode, UserMessage aMessage)	Adds the specified validation message concerning a node in a single record.
void	ValueContextForValidationOnTable.addMessage(UserMessage aMessage)	This method creates a new validation item whose subject is the table that is currently being validated.
void	ValueContextForValidationOnTable.addMessage(String xpathPredicateOfRecords, UserMessage aMessage)	Adds the specified validation message concerning the result of an XPath predicate.
void	ValueContextForValidationOnTable.addMessage(List<Adaptation> records, UserMessage aMessage)	Adds the specified validation message concerning a set of records.
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.

Uses of UserMessage in com.orchestranetworks.interactions

Methods in com.orchestranetworks.interactions that return UserMessage

Modifier and Type	Method	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()

Methods in com.orchestranetworks.interactions that return types with arguments of type UserMessage

Modifier and Type	Method	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.

Constructors in com.orchestranetworks.interactions with parameters of type UserMessage

Modifier	Constructor	Description
	IllegalInteractionStateException(UserMessage userMessage)
	InteractionException(UserMessage userMessage)
	InteractionException(UserMessage userMessage, Throwable t)

Uses of UserMessage in com.orchestranetworks.module

Methods in com.orchestranetworks.module with parameters of type UserMessage

Modifier and Type	Method	Description
void	ModuleServiceRegistrationContext.registerServiceGroup(ServiceGroupKey aServiceGroupKey, UserMessage aLabel, UserMessage aDescription)	Registers a new user service group in EBX®.

Uses of UserMessage in com.orchestranetworks.rest

Methods in com.orchestranetworks.rest that return UserMessage

Modifier and Type	Method	Description
final UserMessage	LocalizedException.getUserMessage()	Returns the user message that may be displayed to the end user as an error message.

Constructors in com.orchestranetworks.rest with parameters of type UserMessage

Modifier	Constructor	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.

Uses of UserMessage in com.orchestranetworks.rest.security

Methods in com.orchestranetworks.rest.security that return UserMessage

Modifier and Type	Method	Description
UserMessage	AuthorizationOutcome.getMessage()	Returns a UserMessage that must be added to the HTTP response in case of forbidden state.

Methods in com.orchestranetworks.rest.security with parameters of type UserMessage

Modifier and Type	Method	Description
static AuthorizationOutcome	AuthorizationOutcome.createForbidden(UserMessage anUserMessage)	Creates a "forbidden" outcome with a localized message.

Uses of UserMessage in com.orchestranetworks.schema

Methods in com.orchestranetworks.schema that return UserMessage

Modifier and Type	Method	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	ConstraintViolationException.getUserMessage()	Returns the user message associated with this exception.
UserMessage	InvalidSchemaException.getUserMessage()
UserMessage	PathAccessException.getUserMessage()	Returns either the user message specified in the constructor, or null.
default UserMessage	TableRefFilter.getValidationMessage(Adaptation aRecord, ValueContext currentContext)	Returns a validation message according to the specified context.

Methods in com.orchestranetworks.schema with parameters of type UserMessage

Modifier and Type	Method	Description
void	SchemaNodeContext.addMessage(UserMessage aMessage)	Attaches the specified message to the current component.
void	SchemaExtensionsContext.setAccessRuleForCreateOnNode(Path aPath, AccessRuleForCreate aRule, UserMessage aDescription)	Declares that the access to a record node may be restricted by the specified rule while in a record creation context.
void	SchemaExtensionsContext.setAccessRuleForCreateOnNodeAndAllDescendants(Path aSubTreePath, boolean includeRoot, AccessRuleForCreate aRule, UserMessage aDescription)	Declares that the access to an element's subtree may be restricted in a record creation context by the specified AccessRuleForCreate.
void	SchemaExtensionsContext.setAccessRuleOnInstance(AccessRule aRule, UserMessage aDescription)	Declares that global access to a dataset may be restricted by the specified rule.
void	SchemaExtensionsContext.setAccessRuleOnNode(Path aPath, AccessRule aRule, UserMessage aDescription)	Declares that the access to an element may be restricted by the specified rule.
void	SchemaExtensionsContext.setAccessRuleOnNodeAndAllDescendants(Path aSubTreePath, boolean includeRoot, AccessRule aRule, UserMessage aDescription)	Declares that the access to an element's subtree may be restricted by the specified rule.
void	SchemaExtensionsContext.setAccessRuleOnOccurrence(Path aTablePath, AccessRule aRule, UserMessage aDescription)	Declares that global access to a table record in the data model may be restricted by the specified rule.
void	SchemaExtensionsContext.setServicePermissionRuleOnNode(Path aPathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule, UserMessage aDescription)	Declares that the display and execution of the specified service is conditioned by the specified rule, when invoked on the element referred by the specified path.
void	SchemaExtensionsContext.setServicePermissionRuleOnNodeAndAllDescendants(Path aSubTreePathInSchema, ServiceKey aServiceKey, ServicePermissionRule<? extends EntitySelection> aRule, UserMessage aDescription)	Declares that the display and execution of the specified service is conditioned by the specified rule, for all elements matching the rule's type of EntitySelection under the specified data model element.

Constructors in com.orchestranetworks.schema with parameters of type UserMessage

Modifier	Constructor	Description
	ConstraintViolationException(UserMessage aMessage)
	ConstraintViolationException(UserMessage aMessage, SchemaFacet aFacet)
	ConstraintViolationException(UserMessage aMessage, SchemaNode aNode, SchemaFacet aFacet)
	ConstraintViolationException(String XPathExpression, UserMessage message, SchemaNode node, SchemaFacet facet)
	InvalidSchemaException(UserMessage aMessage)
	PathAccessException(Path path, UserMessage errorMessage)

Uses of UserMessage in com.orchestranetworks.schema.businessObjects

Methods in com.orchestranetworks.schema.businessObjects that return UserMessage

Modifier and Type	Method	Description
UserMessage	BusinessObjectModel.getDescription()	Returns the localized description of this business object model.
UserMessage	BusinessObjectModel.getLabel()	Returns the localized label of this business object model.

Uses of UserMessage in com.orchestranetworks.schema.dynamic

Methods in com.orchestranetworks.schema.dynamic with parameters of type UserMessage

Modifier and Type	Method	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.

Uses of UserMessage in com.orchestranetworks.schema.types.dataset

Methods in com.orchestranetworks.schema.types.dataset that return UserMessage

Modifier and Type	Method	Description
UserMessage	DatasetSet.DatasetChildrenPolicy.getLabel()	Returns the policy label.

Uses of UserMessage in com.orchestranetworks.schema.types.dataspace

Methods in com.orchestranetworks.schema.types.dataspace that return UserMessage

Modifier and Type	Method	Description
UserMessage	DataspaceSet.DataspaceChildrenPolicy.getLabel()	Returns the policy label.
UserMessage	DataspaceSet.DataspaceType.getLabel()	Returns the type label.

Uses of UserMessage in com.orchestranetworks.search.strategy

Methods in com.orchestranetworks.search.strategy that return UserMessage

Modifier and Type	Method	Description
UserMessage	StopWordsDeclaration.getUserDescription()	Returns the description for this list of stop words.
UserMessage	SynonymDeclaration.getUserDescription()	Returns the description of this synonym list.
UserMessage	StopWordsDeclaration.getUserLabel()	Returns the label of the stop words list.
UserMessage	SynonymDeclaration.getUserLabel()	Returns the label of the synonym list.

Methods in com.orchestranetworks.search.strategy with parameters of type UserMessage

Modifier and Type	Method	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.

Uses of UserMessage in com.orchestranetworks.search.template

Methods in com.orchestranetworks.search.template that return UserMessage

Modifier and Type	Method	Description
UserMessage	SearchTemplate.getUserDescription()	Returns the description of this template.
UserMessage	SearchTemplate.getUserLabel()	Returns the label of this template.

Uses of UserMessage in com.orchestranetworks.service

Methods in com.orchestranetworks.service that return UserMessage

Modifier and Type	Method	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.

Methods in com.orchestranetworks.service with parameters of type UserMessage

Modifier and Type	Method	Description
abstract void	ServiceContext.addMessage(UserMessage aMessage)	Deprecated. Adds a message regarding the validation of the form in the page.
static final OperationException	OperationException.createError(UserMessage aMessage)
static final 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 AccessPermission	AccessPermission.getHidden(UserMessage aReason)	Factory method specifying that a resource can not be modified and is not displayed.
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.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.
final 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.

Uses of UserMessage in com.orchestranetworks.service.comparison

Methods in com.orchestranetworks.service.comparison that return UserMessage

Modifier and Type	Method	Description
UserMessage	CompareFilter.getLabel()

Uses of UserMessage in com.orchestranetworks.service.directory

Methods in com.orchestranetworks.service.directory that return UserMessage

Modifier and Type	Method	Description
UserMessage	DirectoryDefault.RoleEntity.getDescription()
UserMessage	DirectoryDefault.RoleEntity.getLabel()

Methods in com.orchestranetworks.service.directory with parameters of type UserMessage

Modifier and Type	Method	Description
void	DirectoryDefault.RoleEntity.setDescription(UserMessage description)
void	DirectoryDefault.RoleEntity.setLabel(UserMessage label)

Constructors in com.orchestranetworks.service.directory with parameters of type UserMessage

Modifier	Constructor	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.

Uses of UserMessage in com.orchestranetworks.service.extensions

Methods in com.orchestranetworks.service.extensions that return UserMessage

Modifier and Type	Method	Description
UserMessage	LockSpec.getDescription()

Methods in com.orchestranetworks.service.extensions with parameters of type UserMessage

Modifier and Type	Method	Description
void	LockSpec.setDescription(UserMessage description)	Specifies a message describing the the context or reason for the lock.

Uses of UserMessage in com.orchestranetworks.ui

Methods in com.orchestranetworks.ui that return UserMessage

Modifier and Type	Method	Description
final UserMessage	UIButtonSpec.getConfirmationMessage()	Returns the confirmation message of the button, null if it was not set.
final UserMessage	UIButtonSpecJSActionToggle.getConfirmationMessageOff()
final UserMessage	UIButtonSpec.getLabel()	Returns the label of the button.
UserMessage	UITableFilter.getLabel()	Returns the label of this filter.
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.
final UserMessage	UIButtonSpec.getTooltip()	Returns the tooltip of the button, null if it is not set.

Methods in com.orchestranetworks.ui with parameters of type UserMessage

Modifier and Type	Method	Description
UIBodyWriter	UIBodyWriter.add(UserMessage aUserMessage)	Adds a user message in the current session's locale to the body stream.
void	UIFormLabelSpec.DocumentationPane.addBlock(UserMessage aText)	Specifies an additional paragraph in an open section.
void	UIFormLabelSpec.DocumentationPane.addBlock(UserMessage aTitle, UserMessage aText)	Specifies an additional paragraph in an open section, consisting of a title and a text.
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(String 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:
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.
final void	UIButtonSpec.setConfirmationMessage(UserMessage confirmationMessage)	Sets a message to confirm the button action.
final 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.
final void	UIButtonSpec.setLabel(UserMessage aLabel)	Sets a label for the button.
void	UITableFilter.setLabel(UserMessage aUserMessage)
void	UIFormLabelSpec.DocumentationPane.setTitle(UserMessage aTitle)	Specifies the title of the documentation pane.
final 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.

Constructors in com.orchestranetworks.ui with parameters of type UserMessage

Modifier	Constructor	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(UserMessage aLabelMessage)	Creates a simple label with a UserMessage.
	UIFormLabelSpec(UIFormLabelSpec.DocumentationPane aDocumentationPane, UserMessage aLabelMessage)	Creates a simple label with a UserMessage and a documentation pane that is displayed in a pop-up.

Uses of UserMessage in com.orchestranetworks.ui.form

Methods in com.orchestranetworks.ui.form that return UserMessage

Modifier and Type	Method	Description
UserMessage	UIExpandCollapseBlock.getLabel()	Returns the previously defined label, or an empty one if none was defined.

Methods in com.orchestranetworks.ui.form with parameters of type UserMessage

Modifier and Type	Method	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").

Uses of UserMessage in com.orchestranetworks.ui.perspective

Methods in com.orchestranetworks.ui.perspective that return UserMessage

Modifier and Type	Method	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.

Uses of UserMessage in com.orchestranetworks.ui.toolbar

Methods in com.orchestranetworks.ui.toolbar with parameters of type UserMessage

Modifier and Type	Method	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	ToolbarButton.setDescription(UserMessage aDescription)	Sets the description of the button.
void	ToolbarMenuGroup.setDescription(UserMessage aDescription)	Sets the description of this menu item.
void	ToolbarMenuItem.setDescription(UserMessage aDescription)	Sets the description of this menu item

Uses of UserMessage in com.orchestranetworks.ui.view

Methods in com.orchestranetworks.ui.view that return UserMessage

Modifier and Type	Method	Description
UserMessage	UIView.getLabel()	Returns Localized label and description associated with the view.
UserMessage	UIHierarchicalView.getRootNodeLabel()	Localized label of the hierarchy root node.

Uses of UserMessage in com.orchestranetworks.userservice

Methods in com.orchestranetworks.userservice with parameters of type UserMessage

Modifier and Type	Method	Description
void	UserServiceAjaxResponse.addMessage(UserMessage aMessage)	Adds a message to the message box according to its severity.
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	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().
UIButtonSpecNavigation	UserServiceDisplayConfigurator.newActionButton(UserMessage aLabel, UserServiceEvent aCallback)	Creates a specification for a localized action button.
UIButtonSpecNavigation	UserServiceWriter.newActionButton(UserMessage aLabel, UserServiceEvent aCallback)	Creates a specification for a localized action button.
UIButtonSpecSubmit	UserServiceDisplayConfigurator.newSubmitButton(UserMessage aLabel, UserServiceEvent aCallback)	Creates a localized specification for a submit button.
UIButtonSpecSubmit	UserServicePaneWriter.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	UserServiceDisplayConfigurator.setTitle(UserMessage aTitle)	Sets the localized title of the service.
void	UserServiceTab.setTitle(UserMessage aTitle)	Sets the tab's localized title.

Uses of UserMessage in com.orchestranetworks.userservice.declaration

Methods in com.orchestranetworks.userservice.declaration that return UserMessage

Modifier and Type	Method	Description
UserMessage	WebComponentParameter.getDescription()	Returns the description of the parameter.
UserMessage	WebComponentParameter.getLabel()	Returns the label of the parameter.

Methods in com.orchestranetworks.userservice.declaration with parameters of type UserMessage

Modifier and Type	Method	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	UserServicePropertiesDefinitionContext.setDescription(UserMessage aDescription)	Defines the service's default description.
void	WebComponentParameter.setDescription(UserMessage description)	Sets the description of the parameter.
void	UserServicePropertiesDefinitionContext.setDescriptionForConfiguration(UserMessage aDescription)	Defines the service description to be displayed in a configuration context.
void	UserServicePropertiesDefinitionContext.setLabel(UserMessage aLabel)	Defines the service's default title.
void	WebComponentParameter.setLabel(UserMessage label)	Sets the label of the parameter.
void	UserServicePropertiesDefinitionContext.setLabelForConfiguration(UserMessage aLabel)	Defines the service label to be displayed in a configuration context.

Uses of UserMessage in com.orchestranetworks.userservice.permission

Methods in com.orchestranetworks.userservice.permission that return UserMessage

Modifier and Type	Method	Description
UserMessage	UserServicePermission.getDisabledReason()	Only defined if this state is set to 'disabled' and a specific reason is provided.

Methods in com.orchestranetworks.userservice.permission with parameters of type UserMessage

Modifier and Type	Method	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.

Uses of UserMessage in com.orchestranetworks.workflow

Methods in com.orchestranetworks.workflow that return UserMessage

Modifier and Type	Method	Description
UserMessage	ProcessInstance.getDescription()	Returns the description of this workflow.
UserMessage	ProcessInstanceStep.getDescription()	Returns the description of this step.
UserMessage	PublishedProcess.getDescription()	Returns the description of the workflow publication.
UserMessage	UserTask.WorkItem.getDescription()	Returns description of the associated node.
UserMessage	ProcessInstance.getLabel()	Returns the label of this workflow.
UserMessage	ProcessInstanceStep.getLabel()	Returns the label of this step.
UserMessage	ProcessInstanceStep.WaitTaskState.getLabel()	Returns the label of the wait task state.
UserMessage	PublishedProcess.getLabel()	Returns the label of the workflow publication.
UserMessage	UserTask.CompletionStrategy.getLabel()	Returns the label associated with the task termination criteria.
UserMessage	UserTask.WorkItem.getLabel()	Returns label of the associated node.
UserMessage	UserTask.WorkItem.State.getLabel()
UserMessage	CreationWorkItemSpec.getSpecificLabel()
UserMessage	UserTask.WorkItem.getSpecificLabel()	Returns the specific label of the work item.
UserMessage	WorkflowPublisher.getVersionDescription()	Gets the description of the version associated with the publication.
UserMessage	WorkflowPublisher.getVersionLabel()	Gets the label of the version associated with the publication.

Methods in com.orchestranetworks.workflow with parameters of type UserMessage

Modifier and Type	Method	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.
void	WorkflowPublisher.setVersionDescription(UserMessage aVersionDescription)	Sets the description of the version associated with the publication.
void	WorkflowPublisher.setVersionLabel(UserMessage aVersionLabel)	Sets the label of the version associated with the publication.