Interface UserServiceDeclaration<S extends EntitySelection,U extends ActivationContext<S>>
- Type Parameters:
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 service
- All Known Subinterfaces:
UserServiceDeclaration.OnAssociation
,UserServiceDeclaration.OnAssociationRecord
,UserServiceDeclaration.OnDataset
,UserServiceDeclaration.OnDataspace
,UserServiceDeclaration.OnHierarchy
,UserServiceDeclaration.OnHierarchyNode
,UserServiceDeclaration.OnRecord
,UserServiceDeclaration.OnTableView
A user service can be registered and declared either in the context of a data model or in the context of a module.
- Since:
- 5.8.0
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Declares a user service that works at an association element level.static interface
Declares a user service that works on a single associated record.static interface
Declares a user service that works at the global dataset level.static interface
Declares a user service that works at the global dataspace level.static interface
Declares a user service that works at the hierarchy level.static interface
Declares a user service that works on a single hierarchy node.static interface
Declares a user service that works on a single record.static interface
Declares a user service that works at the table level, tabular view level and/or record selection level. -
Method Summary
Modifier and TypeMethodDescriptiondefault UserService<S>
Creates a new user service implementation.void
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
Defines the properties of the user service, in particular its label and description.Returns the identifier of the user service.
-
Method Details
-
getServiceKey
ServiceKey getServiceKey()Returns the identifier of the user service.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.
-
createUserService
Creates a new user service implementation. It is strongly unadvised to return a user service with no parameter.This method is invoked every time the declared user service must be launched, once all activation controls have been performed.
-
defineActivation
Defines the activation scope and rules of the service, namely where and when it is available and can be executed.This method is invoked only once, when the user service is registered.
-
defineProperties
Defines the properties of the user service, in particular its label and description.This method is invoked only once, when the user service is registered.
-
declareWebComponent
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.This method is invoked only once, when the user service is registered.
-