Uses of Class
org.nuclos.api.exception.BusinessException

Packages that use BusinessException

Package	Description
org.nuclos.api.businessobject.facade
org.nuclos.api.businessobject.facade.thin
org.nuclos.api.communication
org.nuclos.api.context
org.nuclos.api.exception
org.nuclos.api.provider
org.nuclos.api.rule
org.nuclos.api.service

Uses of BusinessException in org.nuclos.api.businessobject.facade

Methods in org.nuclos.api.businessobject.facade that throw BusinessException

Modifier and Type	Method	Description
void	Modifiable.delete()	Deletes this bo.
static <PK> void	Modifiable.delete(PK id)	Deletes the bo with this id.
void	Lockable.lock()	Lock this business object by setting the current user as owner.
void	Lockable.lock(UID ownerId)	Lock this business object by setting the given owner.
void	Modifiable.save(SaveFlag... saveFlags)	Saves this bo.
void	Lockable.unlock()	Unlock this business object by removing the owner.
void	Lockable.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

Modifier and Type	Method	Description
void	Stateful.changeStatus(State status)	Changes Status.

Uses of BusinessException in org.nuclos.api.communication

Methods in org.nuclos.api.communication that throw BusinessException

Modifier and Type	Method	Description
<C extends RequestContext<?>> void	CommunicationPort.handleRequest(C context)	Nuclos calls this method only for the types your interface supports.
P	CommunicationPortFactory.newInstance(CommunicationPortFactory.InstanceContext context)
void	CommunicationPortFactory.shutdown(P port)

Uses of BusinessException in org.nuclos.api.context

Methods in org.nuclos.api.context that throw BusinessException

Modifier and Type	Method	Description
<T extends GenericBusinessObject> T	CustomContext.getGenericBusinessObject(Class<T> t)	This method returns the GenericBusinessObject containing the entry-data to edit during runtime.
<T extends GenericBusinessObject> T	DeleteContext.getGenericBusinessObject(Class<T> t)	This method returns the GenericBusinessObject containing the entry-data that has to be deleted.
<T extends GenericBusinessObject> T	InsertContext.getGenericBusinessObject(Class<T> t)	This method returns the GenericBusinessObject containing the entry-data that has to be saved.
<T extends GenericBusinessObject> T	PrintContext.getGenericBusinessObject(Class<T> t)	returns GenericBusinessObject is not persisted automatically
<T extends GenericBusinessObject> T	PrintFinalContext.getGenericBusinessObject(Class<T> t)	returns GenericBusinessObject is not persisted automatically
<T extends GenericBusinessObject> T	StateChangeContext.getGenericBusinessObject(Class<T> t)	This method returns the GenericBusinessObject that State should be changed
<T extends GenericBusinessObject> T	UpdateContext.getGenericBusinessObject(Class<T> t)	This method returns the GenericBusinessObject containing the entry-data that has been changed during runtime.
<T extends GenericBusinessObject> T	GenerateContext.getParameterGenericObject(Class<T> t)	This method returns a GenericBusinessObject that represent the Parameter
<T extends GenericBusinessObject> T	GenerateContext.getSourceGenericObject(Class<T> t)	This method returns the GenericBusinessObject that 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 of GenericBusinessObjects that represent the Sources
<T extends BusinessObject> T	GenerateContext.getSourceObject(Class<T> t)	This method returns a BusinessObject that 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> T	GenerateContext.getTargetGenericObject(Class<T> t)	This method returns a GenericBusinessObject that represent the Target

Uses of BusinessException in org.nuclos.api.exception

Subclasses of BusinessException in org.nuclos.api.exception

Modifier and Type	Class	Description
class	PointerException	PointerException is an exception class used in rule programming.

Uses of BusinessException in org.nuclos.api.provider

Methods in org.nuclos.api.provider that throw BusinessException

Modifier and Type	Method	Description
static <PK, T extends BusinessObject<PK>> URL	WebclientProvider.buildBusinessObjectUrl(Class<T> boClass)
static <PK, T extends BusinessObject<PK>> URL	WebclientProvider.buildBusinessObjectUrl(Class<T> boClass, PK boId)
static <T extends BusinessObject> URL	WebclientProvider.buildBusinessObjectUrl(T bo)
static URL	WebclientProvider.buildUrl(WebclientUrl webclientUrl)
static <T extends Stateful> void	StatemodelProvider.changeState(T t, State sState)	Deprecated. - Use Stateful.changeStatus(State)
static <T extends BusinessObject> void	BusinessObjectProvider.delete(T type)	Deprecated. Use Modifiable.delete() or Use Modifiable.delete(Object)
static void	UserProvider.delete(NuclosUser user)	This method allows to delete a specific user account.
static <T extends BusinessObject> void	BusinessObjectProvider.deleteAll(Collection<T> type)	This method deletes all BusinessObjects of then given collection from the database.
static <PK, T extends LogicalDeletable> void	BusinessObjectProvider.deleteLogical(T type)	This method deletes all BusinessObjects logical without removing data from the database.
static <PK, T extends LogicalDeletable> void	BusinessObjectProvider.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> T	GenerationProvider.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 void	CommunicationProvider.executeRequest(RequestContext<?> context)
static <PK, T extends BusinessObject<PK>> T	QueryProvider.executeSingleResult(Query<T> query, Attribute<?>... attributes)	This methods executes a Query and returns a single result BusinessObject of the type determined by the Query type.
static void	UserProvider.expire(NuclosUser user, Date date)	This method allows to define a date on which to expire a specific user account.
static <PK, T extends Stateful & BusinessObject<PK>> List<T>	QueryProvider.getByProcess(Process<T> process, Process<T>... additionalProcesses)	This method returns all BusinessObjects that contain one of the given processes; A Process is always assigned to one entity, so the type of the BusinessObject does not have to be mentioned explicitly; There must be at least one process
static <PK, T extends Stateful & BusinessObject<PK>> List<T>	QueryProvider.getByState(Class<T> type, State state, State... additionalStates)	This method returns all BusinessObjects that contain one of the given states; A State is always assigned to one statemodel, that can be used by several entities.
static List<NuclosLocale>	DataLocaleProvider.getDataLocales()	This method returns all active NuclosLocale.
static String	ParameterProvider.getNucletParameter(NucletParameter parameter)	This method returns the value of the given NucletParameter as String
static <T> T	WebServiceProvider.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 String	ParameterProvider.getSystemParameter(SystemParameter parameter)	This method returns the value of the given SystemParameter as String
static UID	UserProvider.grantMandator(NuclosMandator mandator, NuclosUser user)	This method assigns a mandator to a given user.
static UID	UserProvider.grantRole(Class<? extends NuclosRole> role, NuclosUser user)	This method assigns a role to a given user.
static UID	UserProvider.grantRole(NuclosRole role, NuclosUser user)	This method assigns a role to a given user.
static void	CommunicationProvider.handleNotification(NotificationContext context)
static void	CommunicationProvider.handleResponse(RequestContext<?> context)
static <PK, T extends BusinessObject<PK>> PK	BusinessObjectProvider.insert(T type)	Deprecated. Use Modifiable.save(SaveFlag...)
static UID	MandatorProvider.insert(String name)	This method creates a Mandator and returns the id of the new object.
static UID	MandatorProvider.insert(String name, NuclosMandator parentMandator)	This method creates a Mandator and returns the id of the new object.
static UID	UserProvider.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired)	Deprecated.
static UID	UserProvider.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired)	Deprecated.
static UID	UserProvider.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 UID	UserProvider.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 UID	UserProvider.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 boolean	UserProvider.isMandatorGranted(NuclosMandator mandator, NuclosUser user)	This method checks if a mandator is granted to a given user.
static <T extends InstantiableContext> T	CommunicationProvider.newContextInstance(CommunicationPortKey portKey, Class<T> contextClass)	For use in rules.
static <T extends InstantiableContext> T	CommunicationProvider.newContextInstance(CommunicationPort port, Class<T> contextClass)	For internal use in ports.
static NuclosFile	BusinessObjectProvider.newFile(String name, byte[] content)	This method creates a new NuclosFile using the given content
static NuclosFile	FileProvider.newFile(File file)	Opens and reads the data from the given file and returns a new NuclosFile with the same filename and content.
static NuclosFile	FileProvider.newFile(String completeFilename)	Opens and reads the data from the file the given filename points to and returns a new NuclosFile with the same filename and content.
static NuclosFile	FileProvider.newFile(String fileName, byte[] content)	Returns a new NuclosFile with the given filename and content.
static NuclosImage	BusinessObjectProvider.newImage(String name, byte[] content)	This method creates a new NuclosImage using the given content; a thumbnail will be created automatically
static void	FileProvider.print(NuclosFile file)	This method sends a NuclosFile to the default printer
static void	FileProvider.print(NuclosFile file, String printername)	This method sends a NuclosFile to the given printer
static void	FileProvider.print(NuclosFile file, PrintProperties printProperties)	This method prints a NuclosFile with the given PrintProperties
static List<NuclosMail>	MailProvider.receive(boolean bDeleteMails)	This method retrieves all NuclosMails that can be found in the Inbox of the account mentioned in the system parameters.
static List<NuclosMail>	MailProvider.receive(String folderFrom, boolean bDeleteMails)	This method retrieves all NuclosMails that can be found in the specified folder of the account mentioned in the system parameters.
static void	UserProvider.resetPassword(NuclosUser user, String password, boolean sendNotification)	This method resets the password for the given Nuclos User.
static void	UserProvider.revokeMandator(NuclosMandator mandator, NuclosUser user)	This method revokes a mandator from a given user.
static void	UserProvider.revokeRole(Class<? extends NuclosRole> role, NuclosUser user)	This method dispossesses a user of the given role.
static void	UserProvider.revokeRole(NuclosRole role, NuclosUser user)	This method dispossesses a user of the given role.
static DatasourceResult	DatasourceProvider.run(Class<? extends Datasource> datasourceClass)	This methods executes a query for a given Datasource-Object.
static DatasourceResult	DatasourceProvider.run(Class<? extends Datasource> datasourceClass, Map<String,Object> params)	This methods executes a query for a given Datasource-Object.
static ImportResult	ImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, Map<String,Object> params)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	PrintoutProvider.run(OutputFormat format, Long boId, NuclosLocale locale)	This method runs the Printout that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(OutputFormat format)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	ReportProvider.run(OutputFormat format, Map<String,Object> params)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile
static NuclosFile	ReportProvider.run(OutputFormat format, Map<String,Object> params, NuclosLocale locale)	Providing the parameters this method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(OutputFormat format, NuclosLocale locale)	This method runs the Report that belongs to the given OutputFormat and returns the generated NuclosFile containing all localized data in the given locale language
static NuclosFile	ReportProvider.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
static ImportResult	XmlImportProvider.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
static void	FileProvider.save(NuclosFile file, String directory)	This method saves a NuclosFile in the given directory
static void	MailProvider.send(InputStream is)	Takes an email as an .eml from an input stream and sends it.
static void	MailProvider.send(NuclosMail mail)	This method sends a NuclosMail All connection settings like POP3/SMTP must be set in Nuclos as system parameters
static NuclosFile	FileProvider.toPdf(NuclosFile file)	Transforms the given file to PDF.
static void	MailProvider.transformToEml(NuclosMail nuclosMail, OutputStream outputStream)	Transforms a NuclosMail to the EML format and writes it to the specified OutputStream.
static <T extends BusinessObject> void	BusinessObjectProvider.update(T type, SaveFlag... saveFlags)	Deprecated. Use Modifiable.save(SaveFlag...)
static void	UserProvider.update(NuclosUser user)	This method updates the given Nuclos User.
static <T extends BusinessObject> void	BusinessObjectProvider.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 BusinessException

Modifier and Type	Method	Description
AuthenticationResult	AuthenticationRule.authenticate(AuthenticationContext context)
void	StateChangeRule.changeState(StateChangeContext context)	StateChangeContext is the context providing all attributes and methods that are relevant for StateChange-operations.
void	StateChangeFinalRule.changeStateFinal(StateChangeContext context)	StateChangeContext is the context providing all attributes and methods that are relevant for StateChange-operations.
void	CommunicationRule.communicate(C context)	CommunicationContext is the context providing all custom - relevant attributes and methods.
void	CustomRule.custom(CustomContext context)	CustomContext is the context providing all custom - relevant attributes and methods.
void	DeleteRule.delete(DeleteContext context)	DeleteContext is the context providing all deleting - relevant attributes and methods.
void	DeleteFinalRule.deleteFinal(DeleteContext context)	DeleteContext is the context providing all deleting - relevant attributes and methods.
void	JobRule.execute(JobContext context)	JobContext is the context providing all attributes and methods that are relevant for Job-operations.
void	GenerateRule.generate(GenerateContext context)	GenerateContext is the context providing all generation - relevant attributes and methods like TargetObjects, SourceObjects and ParameterObjects
void	GenerateFinalRule.generateFinal(GenerateContext context)	GenerateContext is the context providing all generation - relevant attributes and methods like TargetObjects, SourceObjects and ParameterObjects
void	InsertRule.insert(InsertContext context)	InsertContext is the context providing all insert - relevant attributes and methods.
void	InsertFinalRule.insertFinal(InsertContext context)	InsertContext is the context providing all insert - relevant attributes and methods.
void	PrintRule.print(PrintContext context)	PrintContext is the context providing all print - relevant attributes and methods.
void	PrintFinalRule.printFinal(PrintFinalContext context)	PrintContext is the context providing all print - relevant attributes and methods.
default boolean	AuthenticationRule.refreshAuthentication(RefreshAuthenticationContext context)	A session with login whose lifetime has expired will call this method next time a request starts.
void	UpdateRule.update(UpdateContext context)	UpdateContext is the context providing all update - relevant attributes and methods.
void	UpdateFinalRule.updateFinal(UpdateContext context)	UpdateContext is the context providing all updateFinal - relevant attributes and methods.

Uses of BusinessException in org.nuclos.api.service

Methods in org.nuclos.api.service that throw BusinessException

Modifier and Type	Method	Description
URL	WebclientService.buildUrl(WebclientUrl webclientUrl)
<T extends Stateful> void	StatemodelService.changeState(T t, State sState)	Method changes the state of the BusinessObject t.
<T extends BusinessObject> void	BusinessObjectService.delete(T type)
void	UserService.delete(NuclosUser user)	This method allows to delete a specific user account.
<T extends BusinessObject> void	BusinessObjectService.deleteAll(Collection<T> type)
<PK, T extends LogicalDeletable> void	BusinessObjectService.deleteLogical(T type)
<PK, T extends LogicalDeletable> void	BusinessObjectService.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> T	GenerationService.execute(S s, Class<? extends Generation<S,T>> genClass)
<PK, T extends BusinessObject<PK>> T	QueryService.executeQuerySingleResult(Query<T> query, Attribute<?>... attributes)
void	CommunicationService.executeRequest(RequestContext<?> context)
void	UserService.expire(NuclosUser user, Date date)	This method allows to define a date on which to expire a specific user account.
<PK, T extends Stateful & BusinessObject<PK>> List<T>	QueryService.getByProcess(Process<T> process, Process<T>... additionalProcesses)
<PK, T extends Stateful & BusinessObject<PK>> List<T>	QueryService.getByState(Class<T> type, State state, State... additionalStates)
String	ParameterService.getNucletParameter(NucletParameter parameter)
<T> T	WebService.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.
String	ParameterService.getSystemParameter(SystemParameter parameter)
UID	UserService.grantMandator(NuclosMandator mandator, NuclosUser user)	This method assigns a mandator to a given user.
UID	UserService.grantRole(Class<? extends NuclosRole> role, NuclosUser user)	This method assigns a role to a given user.
UID	UserService.grantRole(NuclosRole role, NuclosUser user)	This method assigns a role to a given user.
void	CommunicationService.handleNotification(NotificationContext context)
void	CommunicationService.handleResponse(RequestContext<?> context)
<PK, T extends BusinessObject<PK>> PK	BusinessObjectService.insert(T type)
UID	MandatorService.insert(String name)
UID	MandatorService.insert(String name, NuclosMandator parentMandator)
UID	UserService.insert(String username, String firstname, String lastname, String email, Boolean passwordChangeRequired)	Deprecated.
UID	UserService.insert(String username, String firstname, String lastname, String email, String password, Boolean passwordChangeRequired)	Deprecated.
UID	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.
UID	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.
UID	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)
boolean	UserService.isMandatorGranted(NuclosMandator mandator, NuclosUser user)	This method checks if a mandator is granted to a given user.
<T extends InstantiableContext> T	CommunicationService.newContextInstance(CommunicationPortKey portKey, Class<T> contextClass)	For use in rules.
<T extends InstantiableContext> T	CommunicationService.newContextInstance(CommunicationPort port, Class<T> contextClass)	For internal use in ports.
NuclosFile	BusinessObjectService.newFile(String name, byte[] content)
NuclosFile	FileService.newFile(File file)
NuclosFile	FileService.newFile(String completeFilePath)
NuclosFile	FileService.newFile(String fileName, byte[] content)
NuclosImage	BusinessObjectService.newImage(String name, byte[] content)
void	FileService.print(NuclosFile file)
void	FileService.print(NuclosFile file, String printerName)
void	FileService.print(NuclosFile file, PrintProperties printProperties)
List<NuclosMail>	MailService.receive(boolean bDeleteMails)
List<NuclosMail>	MailService.receive(String folderFrom, boolean bDeleteMails)
void	UserService.resetPassword(NuclosUser user, String password, boolean sendNotification)	This method resets the password for the given Nuclos User.
void	UserService.revokeMandator(NuclosMandator mandator, NuclosUser user)	This method revokes a mandator from a given user.
void	UserService.revokeRole(Class<? extends NuclosRole> role, NuclosUser user)	This method dispossesses a user of the given role.
void	UserService.revokeRole(NuclosRole role, NuclosUser user)	This method dispossesses a user of the given role.
DatasourceResult	DatasourceService.run(Class<? extends Datasource> datasourceClass)
DatasourceResult	DatasourceService.run(Class<? extends Datasource> datasourceClass, Map<String,Object> params)
ImportResult	ImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends ImportStructureDefinition>... structureDefClasses)	This method executes an import process by which the content of a NuclosFile is parsed using the given structure definitions and stored in the database afterwards.
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, Map<String,Object> params)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, Map<String,Object> params, NuclosLocale locale)
NuclosFile	PrintoutService.run(OutputFormat format, Long iBusinessObjectId, NuclosLocale locale)
NuclosFile	ReportService.run(OutputFormat format)
NuclosFile	ReportService.run(OutputFormat format, Map<String,Object> params)
NuclosFile	ReportService.run(OutputFormat format, Map<String,Object> params, NuclosLocale locale)
NuclosFile	ReportService.run(OutputFormat format, NuclosLocale locale)
NuclosFile	ReportService.run(UID outputFormatId, Map<String,Object> params, NuclosLocale locale)
ImportResult	XmlImportService.run(NuclosFile importFile, boolean isTransactional, Class<? extends XmlImportStructureDefinition>... structureDefClasses)	This method executes an XML import process by which the content of a NuclosFile is parsed using the given XML structure definitions and stored in the database afterwards.
void	FileService.save(NuclosFile file, String directory)
void	MailService.send(InputStream is)
void	MailService.send(NuclosMail mail)
NuclosFile	FileService.toPdf(NuclosFile file)
void	MailService.transformToEml(NuclosMail mail, OutputStream outputStream)
<T extends BusinessObject> void	BusinessObjectService.update(T type, SaveFlag... saveFlags)
void	UserService.update(NuclosUser user)	This method updates the given Nuclos User.
<T extends BusinessObject> void	BusinessObjectService.updateAll(Collection<T> type)