Package com.orchestranetworks.userservice
A public API for user services.
-
Interface Summary Interface Description UserService<S extends EntitySelection> Main interface to be implemented for a user service.UserServiceAjaxContext This interface provides information and utility methods useful when processing an Ajax request.UserServiceAjaxRequest Interface that an Ajax request callback must implement.UserServiceAjaxResponse This interface provides methods to generate a response when processing an Ajax request.UserServiceDisplayConfigurator This interface provides methods to set up a user service display.UserServiceEvent Interface that an event callback must implement.UserServiceEventContext This interface provides information and utility methods useful when processing an event.UserServiceEventOutcome An object returned by an event callback should implement this interface.UserServiceExtended<S extends EntitySelection> Extended interface that can be implemented by a user service.UserServiceForCreate<S extends EntitySelection> Extended interface that can be implemented by a user service replacing a creation form.UserServiceGetContext This interface provides information and utility methods useful when processing a GET request.UserServiceGetCreatedRecordContext<S extends EntitySelection> This interface defines methods to get contextual information about the user service being invoked.UserServiceGetRequest Interface that a GET request callback must implement.UserServiceGetResponse This interface provides methods to generate a response when processing an GET request.UserServiceInitializeContext<S extends EntitySelection> This interface provides information and utility methods useful when initializing a user service.UserServiceInvocationContext<S extends EntitySelection> This interface defines methods to get contextual information about the user service being invoked.UserServiceObjectContext This interface provides methods to access objects registered for the user service.UserServiceObjectContextBuilder This interface provides methods to register or remove objects managed by the user service.UserServiceObjectContextForInputValidation This interface provides methods to access or update objects registered for the user service.UserServicePane Interface that a user service pane must implement.UserServicePaneContext This interface provides information and utility methods useful when defining a user service pane.UserServicePaneWriter This interface provides useful methods for rendering a user service pane.UserServiceProcessEventOutcomeContext<S extends EntitySelection> This interface provides information and utility methods useful when processing an event outcome.UserServiceRawPane This interface allows to define a user service raw pane.UserServiceRawPaneContext This interface provides information and utility methods useful when defining a user service raw pane.UserServiceRawPaneWriter This interface provides useful methods for rendering a user service pane.UserServiceRequest Defines an interface to provide information about a request for a user service.UserServiceResourceLocator This interface defines methods to build URLs that are useful for a user service.UserServiceRootTabbedPane Deprecated. From 6.0.0,UserServiceDisplayConfigurator.newTabbedPane()
now returns aUserServiceTabbedPane
.UserServiceSetupDisplayContext<S extends EntitySelection> This interface provides information and utility methods useful when setting up a user service display.UserServiceSetupObjectContext<S extends EntitySelection> This interface provides information and utility methods useful when defining objects managed by the user service.UserServiceTab A tab in a tabbed pane.UserServiceTabbedPane This layout divides the pane into a set oftabs
.UserServiceTransaction This interface offers the possibility to mix in a single transaction and in any specified order: Record creations, Record or dataset updates, Custom procedure executions.UserServiceTransactionManager This class provides methods to execute transactions from a user service.UserServiceValidateContext<S extends EntitySelection> This interface provides information and utility methods useful when performing custom validation.UserServiceWriter This interface provides methods for rendering a user service content. -
Class Summary Class Description ObjectKey Identifies an object from a given context.UserServiceNext This class provides static methods to create standard outcome values specifying what to do next. -
Enum Summary Enum Description UserServiceTransaction.DeletedObjectOutcome Enumeration for specifying the outcome of a transaction when the underlying data, of the object being updated, was deleted by another thread. -
Exception Summary Exception Description UserServiceException This runtime exception is thrown by some methods related to user services.