S
- the nature of the service, namely the type of the selection on which the service worksU
- the activation context corresponding to the nature of the servicepublic interface UserServiceDeclaration<S extends EntitySelection,U extends ActivationContext<S>>
A user service can be registered and declared either in the context of a data model or in the context of a module.
Modifier and Type | Interface and Description |
---|---|
static interface |
UserServiceDeclaration.OnAssociation
Declares a user service that works at an
association element level.
|
static interface |
UserServiceDeclaration.OnAssociationRecord
Declares a user service that works on a
single associated record.
|
static interface |
UserServiceDeclaration.OnDataset
Declares a user service that works at the global dataset level.
|
static interface |
UserServiceDeclaration.OnDataspace
Declares a user service that works at the global dataspace level.
|
static interface |
UserServiceDeclaration.OnHierarchy
Declares a user service that works at the
hierarchy level.
|
static interface |
UserServiceDeclaration.OnHierarchyNode
Declares a user service that works on a
single hierarchy node.
|
static interface |
UserServiceDeclaration.OnRecord
Declares a user service
that works on a single record.
|
static interface |
UserServiceDeclaration.OnTableView
Declares a user service that works at the
table level, tabular view level and/or record selection level.
|
Modifier and Type | Method and Description |
---|---|
default UserService<S> |
createUserService()
Creates a new user service implementation.
|
void |
declareWebComponent(WebComponentDeclarationContext aContext)
Defines the web component properties of the user service, in particular
its input and output parameters, and whether it can be available as a perspective
action and/or workflow user task.
|
void |
defineActivation(U aContext)
Defines the activation scope and rules of the service, namely where and when
it is available and can be executed.
|
void |
defineProperties(UserServicePropertiesDefinitionContext aContext)
Defines the properties of the user service, in particular
its label and description.
|
ServiceKey |
getServiceKey()
Returns the identifier of the user service.
|
ServiceKey getServiceKey()
The returned ServiceKey
must conform
to the current declaration context; for example,
if the service is being declared in the context of a module
its key must contain the current
module name.
This method is invoked only once, when the user service is registered.
It is generally recommended to define a public Java constant holding the service key.
default UserService<S> createUserService()
This method is invoked every time the declared user service must be launched, once all activation controls have been performed.
void defineActivation(U aContext)
This method is invoked only once, when the user service is registered.
void defineProperties(UserServicePropertiesDefinitionContext aContext)
This method is invoked only once, when the user service is registered.
void declareWebComponent(WebComponentDeclarationContext aContext)
This method is invoked only once, when the user service is registered.