All Classes and Interfaces
Class
Description
Marker for a custom rest rule method.
Represents an Attribute of a
BusinessObject.AuthenticationContext represents the context used in an
AuthenticationRule.authenticate(AuthenticationContext).This class is passed to Nuclos as the result of a rule-based authentication.
A builder for
AuthenticationResultAn
AuthenticationRule can authorize any request against our RESTful service.BusinessException is a general exception class for checked
exceptions in (user provided) business rules.
BusinessObject represents an entry of a configured entity.BusinessObjectProvider provides methods for creating, updating and deleting new or existing BusinessObjectsCommands the client to close the current window/tab.
Represents a command the server sends to the client, e.g.
A custom communication port must implement this interface.
This class represents a communication port that has been configured in Nuclos; It is usually not used
by rule programmers directly, but it is part of a CommunicationService-System and created during
runtime.
CommunicationProvider provides methods for communication with portsCommunicationRule is the interface that should be used to make an rule
applicable for Communication-Events.CurrentTransaction provides methods for disabling Nuclos core featuresCustomContext represents the context used in a Custom-RuleCustomRestContext represents the context used in CustomRestRuleresponse of custom REST service containing additional header information
CustomRule is the interface that should be used to make an rule
applicable for Custom-Events.The
Datasource interface is used by concrete implementations of nuclos-datasources
generated at runtime when creating/modifiyng datasources.Represents a column of a
DatasourceResult received by
DatasourceProvider after executing a
datasource-queryDatasourceProvider provides methods for executing datasource-queriesRepresents a resultset received by DatasourceProvider after executing a
datasource-query
DeleteContext represents the context used in Deletion-RuleDeleteRule is the interface that should be used to make an rule
applicable for Afterwards-Deletion-Events.DeleteRule is the interface that should be used to make an rule
applicable for Deletion-Events.This class represents a dependent relation in
BusinessObjectTODO: Javadoc
TODO: Move this class to org.nuclos.api.command (see NUCLOS-5221)
DropContext
drop context information
DropHandler
handle custom drop actions
DropHandlerProvider
provider for custom drop handler
DropTarget
potential drop areas in nuclos
FileProvider consists various methods for file-operationThis class represents the flag of a
BusinessObject.Flavor
data flavor
ForeignKeyAttribute is used if the attribute references to an other entity.GenerateContext represents the context used in Generation-RuleGenerateRule is the interface that should be used to make an rule
applicable for Afterward-Generation-Events.GenerateRule is the interface that should be used to make an rule
applicable for Generation-Events.Generation is the main interface of all Nuclos generations.GenerationProvider provides methods for executing nuclos generationsGenericBusinessObject defines similarities between multiple BOs.ImportProvider provides methods to import data into NuclosThis class represents the return value of an import process.
This class represents a structure definition that is use in rule programming to manually import data into Nuclos
InputContext adds support for requesting input from the user.Interface for creating input delegate views.
Specification of a client-side delegate class to produce a customized input panel.
Exception to request additional input user.
Specification of input dialog.
Exception to be thrown by
InputDelegate if user input is incomplete orInsertContext represents the context used in Insert-Rule, Insert and InsertFinalInsertFinalRule is the interface that should be used to make an rule
applicable for Afterwards-Insert-Events.InsertRule is the interface that should be used to make an rule
applicable for Insert-Events.InstallContext
context information for @link{DropHandler} installation
JobContext represents the context used in Job-RuleJobRule is the interface that should be used to make an rule
applicable for Job-Events.layout component type
Layout Component Adapter
LayoutComponentContext represents the base context that carries
environmental informations for layout componentsLayout Component Listener
listener for events thrown by the user interface
Lockable is the interface a
BusinessObject must implement to be used for locking.LogContext represents a context with basic logging functionality.LogicalDeletable is the interface a
BusinessObject must implement to be deleted logically
via org.nuclos.api.provider.BusinessObjectProvider .This class is used in rule programming and provides methods for sending and receiving
E-mails.
The
MandatorProvider provides several methods to create mandators and manipulate mandator role dataThe
MandatorService provides several methods to create MandatorsTODO: Javadoc
TODO: Move this class to org.nuclos.api.command (see NUCLOS-5221)
MessageContext adds support for sending commands to the client.TODO: This does not only send simple messages but also other client commands and should therefore be renamed.
Modifiable is the interface a
BusinessObject must implement to be used in modifying
rules, UpdateRule, InsertRule, UpdateFinalRule, InsertFinalRuleNew Context
This class represents a nuclet parameter that has been created in Nuclos; It is usually not used
by rule programmers directly, but it is part of a NucletParameters-Class (e.g.
Class representing a file with its name and contents.
Marker interface for NuclosFile and NuclosFileLink
Class representing a file link with an UID.
All classes generated by Nuclos get this annotation.
Class representing an image used in Nuclos
NuclosLocale contains all locales Nuclos works with.
Elements of this class are usually used in rule programming,
e.g.
Elements of this class are usually used in rule programming,
e.g.
class representing an email-object
org.nuclos.api.provider.MailProvider
Class that represents the type of a
NuclosMail.NumericAttribute is used if the attribute type provides general numeric comparison operationsPointerException is an exception class used in rule programming.PrimaryKeyAttribute is the id of an objectPrintContext represents the context used in PrintRulePrintFinalContext represents the context used in PrintFinalRulePrintFinalRule is the interface that should be used to make an rule
applicable for PrintFinal-Events.Class representing a printout object used in rule programming
printout list declares squence of
PrintoutsPrintoutProvider provides methods for executing printoutsclass used in
OutputFormat and FileProvider
setup properties to control the printing processPrintResult provides the results of printout process
to the rule execution
PrintFinalContextPrintRule is the interface that should be used to make an rule
applicable for Print-Events.The
Priority class is used to specify the importance of a Nuclos notification message.The process class represents a process in nuclos;
It is assigned to an entity that uses a statemodel and is used in rule-programming.
It is assigned to an entity that uses a statemodel and is used in rule-programming.
Query bases on a
BusinessObjectQueryOperation is a base enum including all operators used in
QueryQueryProvider provides methods for creating and executing
Query for data access and methods to read
single BusinessObject.AuthenticationContext represents the context used in an
AuthenticationRule.refreshAuthentication(RefreshAuthenticationContext).Interface representing a report object used in rule programming
ReportProvider provides methods for executing reportsRuleContext represents the base context that supports elementary functions like
caching that enables to pass objects throw a list of rules that are executed during one event.Created by Oliver Brausch on 27.04.24.
Context for scripting expressions.
Search Context
SearchExpression represents a search expression for a Query.SearchExpressionPair represents a pair of search expression and operation qualifierSpringInputContext adds support for requesting input from the user.Represents a state of a nuclos statemodel.
StateChangeContext represents the context used in StateChange-Rule, StateChange and StateChangeFinalStateChangeFinalRule is the interface that should be used to make an rule
applicable for Afterwards-StateChange-Events.StateChangeRule is the interface that should be used to make an rule
applicable for StateChange-Events.May be deprecated in future release.
Stateful is the interface a
BusinessObject must implement to be
used in StateChangeRule and StateChangeFinalRule rulesStatemodelProvider provides methods for reading, setting or changing state information
for BusinessObjects.StringAttribute is used if the attribute type provides comparison operations based on StringsThis class represents a system parameter that has been created in Nuclos; It is usually not used
by rule programmers directly, but it is part of the class NuclosSystemParameter that is created during
runtime containing all parameters as SystemParameter-instances.
TransactionalJobRule is the interface that should be used to make an rule
transactional.Classes implementing this interface can be mentioned in the new remoting as JSON Type.
Interface used for identifying nuclos entities;
for internal use only
UpdateContext represents the context used in an Update-Rule, Update and UpdateFinalUpdateFinalRule is the interface that should be used to make an rule
applicable for Afterward-Update-Events.UpdateRule is the interface that should be used to make an rule
applicable for Update-Events.The
UserProvider provides several methods to create users and manipulate user role dataThe
UserService provides several methods to create users and manipulate user role dataInterface for specifying the visibility of several components
WebclientProvider provides support for handling the Nuclos webclientA builder for
WebclientUrlThe
WebService provides methods to create and initialize stub clients
for calling web-services.Represents a Nuclos-WebService for calling external services as a client.
For rule programming the file org.nuclet.webservice.WebServices contains instances of it that are passed to the WebServiceProvider for creating and initializing a client stub
For rule programming the file org.nuclet.webservice.WebServices contains instances of it that are passed to the WebServiceProvider for creating and initializing a client stub
The
UserService provides several methods to create users and manipulate user role dataXmlImportProvider provides methods to import XML data into Nuclos.This class represents a XML structure definition that is use in rule programming to manually import data into Nuclos.