Uses of Class
org.nuclos.api.exception.BusinessException
Packages that use BusinessException
Package
Description
-
Uses of BusinessException in org.nuclos.api.businessobject.facade
Methods in org.nuclos.api.businessobject.facade that throw BusinessExceptionModifier and TypeMethodDescriptionvoidModifiable.delete()Deletes this bo.static <PK> voidModifiable.delete(PK id) Deletes the bo with this id.voidLockable.lock()Lock this business object by setting the current user as owner.voidLock this business object by setting the given owner.voidSaves this bo.voidLockable.unlock()Unlock this business object by removing the owner.voidLockable.unlockAfterCommit()Unlock this business object after commit by removing the owner. -
Uses of BusinessException in org.nuclos.api.businessobject.facade.thin
Methods in org.nuclos.api.businessobject.facade.thin that throw BusinessException -
Uses of BusinessException in org.nuclos.api.communication
Methods in org.nuclos.api.communication that throw BusinessExceptionModifier and TypeMethodDescription<C extends RequestContext<?>>
voidCommunicationPort.handleRequest(C context) Nuclos calls this method only for the types your interface supports.CommunicationPortFactory.newInstance(CommunicationPortFactory.InstanceContext context) void -
Uses of BusinessException in org.nuclos.api.context
Methods in org.nuclos.api.context that throw BusinessExceptionModifier and TypeMethodDescription<T extends GenericBusinessObject>
TCustomContext.getGenericBusinessObject(Class<T> t) This method returns theGenericBusinessObjectcontaining the entry-data to edit during runtime.<T extends GenericBusinessObject>
TDeleteContext.getGenericBusinessObject(Class<T> t) This method returns theGenericBusinessObjectcontaining the entry-data that has to be deleted.<T extends GenericBusinessObject>
TInsertContext.getGenericBusinessObject(Class<T> t) This method returns theGenericBusinessObjectcontaining the entry-data that has to be saved.<T extends GenericBusinessObject>
TPrintContext.getGenericBusinessObject(Class<T> t) returnsGenericBusinessObjectis not persisted automatically<T extends GenericBusinessObject>
TPrintFinalContext.getGenericBusinessObject(Class<T> t) returnsGenericBusinessObjectis not persisted automatically<T extends GenericBusinessObject>
TStateChangeContext.getGenericBusinessObject(Class<T> t) This method returns theGenericBusinessObjectthat State should be changed<T extends GenericBusinessObject>
TUpdateContext.getGenericBusinessObject(Class<T> t) This method returns theGenericBusinessObjectcontaining the entry-data that has been changed during runtime.<T extends GenericBusinessObject>
TGenerateContext.getParameterGenericObject(Class<T> t) This method returns aGenericBusinessObjectthat represent the Parameter<T extends GenericBusinessObject>
TGenerateContext.getSourceGenericObject(Class<T> t) This method returns theGenericBusinessObjectthat represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead<T extends GenericBusinessObject>
Collection<T>GenerateContext.getSourceGenericObjects(Class<T> t) This method returns a list ofGenericBusinessObjects that represent the Sources<T extends BusinessObject>
TGenerateContext.getSourceObject(Class<T> t) This method returns aBusinessObjectthat represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead<T extends GenericBusinessObject>
TGenerateContext.getTargetGenericObject(Class<T> t) This method returns aGenericBusinessObjectthat represent the Target -
Uses of BusinessException in org.nuclos.api.exception
Subclasses of BusinessException in org.nuclos.api.exceptionModifier and TypeClassDescriptionclassPointerExceptionis an exception class used in rule programming.Methods in org.nuclos.api.exception that return BusinessExceptionModifier and TypeMethodDescriptionstatic BusinessExceptionBusinessException.doNotTranslate(String pMessage) Creates a new BusinessException with a message that is not translated.static BusinessExceptionBusinessException.doNotTranslate(String pMessage, Throwable pThrowable) Creates a new BusinessException with a message that is not translated and the specified cause.Adds message arguments to this exception that will be used for message formatting. -
Uses of BusinessException in org.nuclos.api.provider
Methods in org.nuclos.api.provider that throw BusinessExceptionModifier and TypeMethodDescriptionstatic <PK,T extends BusinessObject<PK>>
URLWebclientProvider.buildBusinessObjectUrl(Class<T> boClass) static <PK,T extends BusinessObject<PK>>
URLWebclientProvider.buildBusinessObjectUrl(Class<T> boClass, PK boId) static <T extends BusinessObject>
URLWebclientProvider.buildBusinessObjectUrl(T bo) static URLWebclientProvider.buildUrl(WebclientUrl webclientUrl) static <T extends Stateful>
voidStatemodelProvider.changeState(T t, State sState) Deprecated.static <T extends BusinessObject>
voidBusinessObjectProvider.delete(T type) Deprecated.UseModifiable.delete()or UseModifiable.delete(Object)static voidUserProvider.delete(NuclosUser user) This method allows to delete a specific user account.static <T extends BusinessObject>
voidBusinessObjectProvider.deleteAll(Collection<T> type) This method deletes all BusinessObjects of then given collection from the database.static <PK,T extends LogicalDeletable>
voidBusinessObjectProvider.deleteLogical(T type) This method deletes all BusinessObjects logical without removing data from the database.static <PK,T extends LogicalDeletable>
voidBusinessObjectProvider.deleteLogicalAll(Collection<T> type) This method deletes all BusinessObjects logical without removing data from the database.static <S extends BusinessObject,T extends BusinessObject>
List<T>GenerationProvider.execute(List<S> s, Class<? extends Generation<S, T>> genClass) Using the source objects this method runs the given generation and returns the new created target objects.static <S extends BusinessObject,T extends BusinessObject>
TGenerationProvider.execute(S s, Class<? extends Generation<S, T>> genClass) Using the source object this method runs the given generation and returns the new created target object.static voidCommunicationProvider.executeRequest(RequestContext<?> context) static <PK,T extends BusinessObject<PK>>
TQueryProvider.executeSingleResult(Query<T> query, Attribute<?>... attributes) This methods executes aQueryand returns a single resultBusinessObjectof the type determined by theQuerytype.static voidUserProvider.expire(NuclosUser user, Date date) This method allows to define a date on which to expire a specific user account.QueryProvider.getByProcess(Process<T> process, Process<T>... additionalProcesses) This method returns allBusinessObjects that contain one of the given processes;
AProcessis always assigned to one entity, so the type of the BusinessObject does not have to be mentioned explicitly;
There must be at least one processQueryProvider.getByState(Class<T> type, State state, State... additionalStates) This method returns allBusinessObjects that contain one of the given states;
AStateis always assigned to one statemodel, that can be used by several entities.static List<NuclosLocale>DataLocaleProvider.getDataLocales()This method returns all activeNuclosLocale.static StringParameterProvider.getNucletParameter(NucletParameter parameter) This method returns the value of the givenNucletParameteras Stringstatic <T> TWebServiceProvider.getStub(Class<T> stubClass, WebServiceObject webServiceUID) This method creates a new instance of the given stub class and provides it with all settings (e.g.static StringParameterProvider.getSystemParameter(SystemParameter parameter) This method returns the value of the givenSystemParameteras Stringstatic UIDUserProvider.grantMandator(NuclosMandator mandator, NuclosUser user) This method assigns a mandator to a given user.static UIDUserProvider.grantRole(Class<? extends NuclosRole> role, NuclosUser user) This method assigns a role to a given user.static UIDUserProvider.grantRole(NuclosRole role, NuclosUser user) This method assigns a role to a given user.static voidCommunicationProvider.handleNotification(NotificationContext context) static voidCommunicationProvider.handleResponse(RequestContext<?> context) static <PK,T extends BusinessObject<PK>>
PKBusinessObjectProvider.insert(T type) Deprecated.static UIDThis method creates a Mandator and returns the id of the new object.static UIDMandatorProvider.insert(String name, NuclosMandator parentMandator) This method creates a Mandator and returns the id of the new object.static UIDUserProvider.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired) Deprecated.static UIDUserProvider.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired) Deprecated.static UIDUserProvider.insert(NuclosUser user) This method creates a Nuclos User and returns the id of the new object.
A password will be generated and a default notification Email with the password will be send.
A new user does not have any roles and therefore does not have any rights in Nuclos.static UIDUserProvider.insert(NuclosUser user, String password) This method creates a Nuclos User and returns the id of the new object.
Sends a default notification Email with the password.
A new user does not have any roles and therefore does not have any rights in Nuclos.static UIDUserProvider.insert(NuclosUser user, String password, boolean sendNotification) This method creates a Nuclos User and returns the id of the new object.
A new user does not have any roles and therefore does not have any rights in Nuclos.static <PK,T extends BusinessObject<PK>>
Collection<PK>BusinessObjectProvider.insertAll(Collection<T> type) This method receives a collection of new BusinessObjects and stores them in the database.static booleanUserProvider.isMandatorGranted(NuclosMandator mandator, NuclosUser user) This method checks if a mandator is granted to a given user.static <T extends InstantiableContext>
TCommunicationProvider.newContextInstance(CommunicationPortKey portKey, Class<T> contextClass) For use in rules.static <T extends InstantiableContext>
TCommunicationProvider.newContextInstance(CommunicationPort port, Class<T> contextClass) For internal use in ports.static NuclosFileThis method creates a newNuclosFileusing the given contentstatic NuclosFileOpens and reads the data from the given file and returns a newNuclosFilewith the same filename and content.static NuclosFileOpens and reads the data from the file the given filename points to and returns a newNuclosFilewith the same filename and content.static NuclosFileReturns a newNuclosFilewith the given filename and content.static NuclosImageThis method creates a newNuclosImageusing the given content; a thumbnail will be created automaticallystatic voidFileProvider.print(NuclosFile file) This method sends aNuclosFileto the default printerstatic voidFileProvider.print(NuclosFile file, String printername) This method sends aNuclosFileto the given printerstatic voidFileProvider.print(NuclosFile file, PrintProperties printProperties) This method prints aNuclosFilewith the givenPrintPropertiesstatic List<NuclosMail>MailProvider.receive(boolean bDeleteMails) This method retrieves allNuclosMails that can be found in the Inbox of the account mentioned in the system parameters.static List<NuclosMail>This method retrieves allNuclosMails that can be found in the specified folder of the account mentioned in the system parameters.static List<NuclosMail>This method retrieves allNuclosMails that can be found in the folder specified in a specific incoming email server configuration.static List<NuclosMail>This method retrieves allNuclosMails that can be found in the specified folder in a specific incoming email server configuration.static voidUserProvider.resetPassword(NuclosUser user, String password, boolean sendNotification) This method resets the password for the given Nuclos User.static voidUserProvider.revokeMandator(NuclosMandator mandator, NuclosUser user) This method revokes a mandator from a given user.static voidUserProvider.revokeRole(Class<? extends NuclosRole> role, NuclosUser user) This method dispossesses a user of the given role.static voidUserProvider.revokeRole(NuclosRole role, NuclosUser user) This method dispossesses a user of the given role.static DatasourceResultDatasourceProvider.run(Class<? extends Datasource> datasourceClass) This methods executes a query for a givenDatasource-Object.static DatasourceResultThis methods executes a query for a givenDatasource-Object.static ImportResultImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses) This method executes an import process by which the content of aNuclosFileis parsed using the given structure definitions and stored in the database afterwards.static NuclosFilePrintoutProvider.run(OutputFormat format, Long boId) This method runs thePrintoutthat belongs to the givenOutputFormatand returns the generatedNuclosFilestatic NuclosFileProviding the parameters this method runs thePrintoutthat belongs to the givenOutputFormatand returns the generatedNuclosFilestatic NuclosFilePrintoutProvider.run(OutputFormat format, Long boId, Map<String, Object> params, NuclosLocale locale) Providing the parameters this method runs thePrintoutthat belongs to the givenOutputFormatand returns the generatedNuclosFilecontaining all localized data in the given locale languagestatic NuclosFilePrintoutProvider.run(OutputFormat format, Long boId, NuclosLocale locale) This method runs thePrintoutthat belongs to the givenOutputFormatand returns the generatedNuclosFilecontaining all localized data in the given locale languagestatic NuclosFileReportProvider.run(OutputFormat format) This method runs theReportthat belongs to the givenOutputFormatand returns the generatedNuclosFilestatic NuclosFileReportProvider.run(OutputFormat format, Map<String, Object> params) Providing the parameters this method runs theReportthat belongs to the givenOutputFormatand returns the generatedNuclosFilestatic NuclosFileReportProvider.run(OutputFormat format, Map<String, Object> params, NuclosLocale locale) Providing the parameters this method runs theReportthat belongs to the givenOutputFormatand returns the generatedNuclosFilecontaining all localized data in the given locale languagestatic NuclosFileReportProvider.run(OutputFormat format, NuclosLocale locale) This method runs theReportthat belongs to the givenOutputFormatand returns the generatedNuclosFilecontaining all localized data in the given locale languagestatic NuclosFilestatic ImportResultXmlImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses) This method executes an import process by which the content of aNuclosFileis parsed using the given structure definitions and stored in the database afterwards.static voidFileProvider.save(NuclosFile file, String directory) This method saves aNuclosFilein the given directorystatic voidMailProvider.send(InputStream is) Takes an email as an .eml from an input stream and sends it.static voidMailProvider.send(NuclosMail mail) This method sends aNuclosMailAll connection settings like POP3/SMTP must be set in Nuclos as system parametersstatic voidMailProvider.send(UID outgoingServer, InputStream is) Takes an email as an .eml from an input stream and sends it via a specific outgoing server.static voidMailProvider.send(UID outgoingServer, NuclosMail mail) This method sends aNuclosMailvia a specific outgoing serverstatic NuclosFileFileProvider.toPdf(NuclosFile file) Transforms the given file to PDF.static voidMailProvider.transformToEml(NuclosMail nuclosMail, OutputStream outputStream) Transforms aNuclosMailto the EML format and writes it to the specifiedOutputStream.static <T extends BusinessObject>
voidDeprecated.static voidUserProvider.update(NuclosUser user) This method updates the given Nuclos User.static <T extends BusinessObject>
voidBusinessObjectProvider.updateAll(Collection<T> type) This method updates all BusinessObjects in the given collection. -
Uses of BusinessException in org.nuclos.api.rule
Methods in org.nuclos.api.rule that throw BusinessExceptionModifier and TypeMethodDescriptionAuthenticationRule.authenticate(AuthenticationContext context) voidStateChangeRule.changeState(StateChangeContext context) StateChangeContextis the context providing all attributes and methods that are relevant for StateChange-operations.voidStateChangeFinalRule.changeStateFinal(StateChangeContext context) StateChangeContextis the context providing all attributes and methods that are relevant for StateChange-operations.voidCommunicationRule.communicate(C context) CommunicationContextis the context providing all custom - relevant attributes and methods.voidCustomRule.custom(CustomContext context) CustomContextis the context providing all custom - relevant attributes and methods.voidDeleteRule.delete(DeleteContext context) DeleteContextis the context providing all deleting - relevant attributes and methods.voidDeleteFinalRule.deleteFinal(DeleteContext context) DeleteContextis the context providing all deleting - relevant attributes and methods.voidJobRule.execute(JobContext context) JobContextis the context providing all attributes and methods that are relevant for Job-operations.voidGenerateRule.generate(GenerateContext context) GenerateContextis the context providing all generation - relevant attributes and methods like TargetObjects, SourceObjects and ParameterObjectsvoidGenerateFinalRule.generateFinal(GenerateContext context) GenerateContextis the context providing all generation - relevant attributes and methods like TargetObjects, SourceObjects and ParameterObjectsvoidInsertRule.insert(InsertContext context) InsertContextis the context providing all insert - relevant attributes and methods.voidInsertFinalRule.insertFinal(InsertContext context) InsertContextis the context providing all insert - relevant attributes and methods.voidPrintRule.print(PrintContext context) PrintContextis the context providing all print - relevant attributes and methods.voidPrintFinalRule.printFinal(PrintFinalContext context) PrintContextis the context providing all print - relevant attributes and methods.default booleanAuthenticationRule.refreshAuthentication(RefreshAuthenticationContext context) A session with login whose lifetime has expired will call this method next time a request starts.voidUpdateRule.update(UpdateContext context) UpdateContextis the context providing all update - relevant attributes and methods.voidUpdateFinalRule.updateFinal(UpdateContext context) UpdateContextis the context providing all updateFinal - relevant attributes and methods.default booleanAuthenticationRule.validateUserInfo(ValidateUserInfoContext context) Directly with the Sso authentication, the Sso server returns information about the user. -
Uses of BusinessException in org.nuclos.api.service
Methods in org.nuclos.api.service that throw BusinessExceptionModifier and TypeMethodDescriptionWebclientService.buildUrl(WebclientUrl webclientUrl) <T extends Stateful>
voidStatemodelService.changeState(T t, State sState) Method changes the state of the BusinessObject t.<T extends BusinessObject>
voidBusinessObjectService.delete(T type) voidUserService.delete(NuclosUser user) This method allows to delete a specific user account.<T extends BusinessObject>
voidBusinessObjectService.deleteAll(Collection<T> type) <PK,T extends LogicalDeletable>
voidBusinessObjectService.deleteLogical(T type) <PK,T extends LogicalDeletable>
voidBusinessObjectService.deleteLogicalAll(Collection<T> type) <S extends BusinessObject,T extends BusinessObject>
List<T>GenerationService.execute(List<S> s, Class<? extends Generation<S, T>> genClass) <S extends BusinessObject,T extends BusinessObject>
TGenerationService.execute(S s, Class<? extends Generation<S, T>> genClass) <PK,T extends BusinessObject<PK>>
TQueryService.executeQuerySingleResult(Query<T> query, Attribute<?>... attributes) voidCommunicationService.executeRequest(RequestContext<?> context) voidUserService.expire(NuclosUser user, Date date) This method allows to define a date on which to expire a specific user account.QueryService.getByProcess(Process<T> process, Process<T>... additionalProcesses) QueryService.getByState(Class<T> type, State state, State... additionalStates) ParameterService.getNucletParameter(NucletParameter parameter) <T> TWebService.getStub(Class<T> stubClass, WebServiceObject webService) This method creates a new instance of the given stub class and provides it with all settings (e.g.ParameterService.getSystemParameter(SystemParameter parameter) UserService.grantMandator(NuclosMandator mandator, NuclosUser user) This method assigns a mandator to a given user.UserService.grantRole(Class<? extends NuclosRole> role, NuclosUser user) This method assigns a role to a given user.UserService.grantRole(NuclosRole role, NuclosUser user) This method assigns a role to a given user.voidCommunicationService.handleNotification(NotificationContext context) voidCommunicationService.handleResponse(RequestContext<?> context) <PK,T extends BusinessObject<PK>>
PKBusinessObjectService.insert(T type) MandatorService.insert(String name, NuclosMandator parentMandator) UserService.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired) Deprecated.UserService.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired) Deprecated.UserService.insert(NuclosUser user) This method creates a Nuclos User and returns the id of the new object.
A password will be generated and a default notification Email with the password will be send.
A new user does not have any roles and therefore does not have any rights in Nuclos.UserService.insert(NuclosUser user, String password) This method creates a Nuclos User and returns the id of the new object.
Sends a default notification Email with the password.
A new user does not have any roles and therefore does not have any rights in Nuclos.UserService.insert(NuclosUser user, String password, boolean sendNotification) This method creates a Nuclos User and returns the id of the new object.
A new user does not have any roles and therefore does not have any rights in Nuclos.<PK,T extends BusinessObject<PK>>
Collection<PK>BusinessObjectService.insertAll(Collection<T> type) booleanUserService.isMandatorGranted(NuclosMandator mandator, NuclosUser user) This method checks if a mandator is granted to a given user.<T extends InstantiableContext>
TCommunicationService.newContextInstance(CommunicationPortKey portKey, Class<T> contextClass) For use in rules.<T extends InstantiableContext>
TCommunicationService.newContextInstance(CommunicationPort port, Class<T> contextClass) For internal use in ports.voidFileService.print(NuclosFile file) voidFileService.print(NuclosFile file, String printerName) voidFileService.print(NuclosFile file, PrintProperties printProperties) MailService.receive(boolean bDeleteMails) default List<NuclosMail>default List<NuclosMail>voidUserService.resetPassword(NuclosUser user, String password, boolean sendNotification) This method resets the password for the given Nuclos User.voidUserService.revokeMandator(NuclosMandator mandator, NuclosUser user) This method revokes a mandator from a given user.voidUserService.revokeRole(Class<? extends NuclosRole> role, NuclosUser user) This method dispossesses a user of the given role.voidUserService.revokeRole(NuclosRole role, NuclosUser user) This method dispossesses a user of the given role.DatasourceService.run(Class<? extends Datasource> datasourceClass) ImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses) This method executes an import process by which the content of aNuclosFileis parsed using the given structure definitions and stored in the database afterwards.PrintoutService.run(OutputFormat format, Long iBusinessObjectId) PrintoutService.run(OutputFormat format, Long iBusinessObjectId, Map<String, Object> params, NuclosLocale locale) PrintoutService.run(OutputFormat format, Long iBusinessObjectId, NuclosLocale locale) ReportService.run(OutputFormat format) ReportService.run(OutputFormat format, Map<String, Object> params) ReportService.run(OutputFormat format, Map<String, Object> params, NuclosLocale locale) ReportService.run(OutputFormat format, NuclosLocale locale) XmlImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses) This method executes an XML import process by which the content of aNuclosFileis parsed using the given XML structure definitions and stored in the database afterwards.voidFileService.save(NuclosFile file, String directory) voidMailService.send(InputStream is) voidMailService.send(NuclosMail mail) default voidMailService.send(UID outgoingEmailServer, InputStream is) default voidMailService.send(UID outgoingEmailServer, NuclosMail mail) FileService.toPdf(NuclosFile file) voidMailService.transformToEml(NuclosMail mail, OutputStream outputStream) <T extends BusinessObject>
voidvoidUserService.update(NuclosUser user) This method updates the given Nuclos User.<T extends BusinessObject>
voidBusinessObjectService.updateAll(Collection<T> type)
Stateful.changeStatus(State)