org.nuclos.api.provider

Class BusinessObjectProvider

java.lang.Object

org.nuclos.api.provider.BusinessObjectProvider

public class BusinessObjectProvider
extends java.lang.Object

BusinessObjectProvider provides methods for creating, updating and deleting new or existing BusinessObjects

This Class is usually used in Rule-classes and allows API access only

Author:

Matthias Reichart

Constructor Summary

Constructors

Constructor and Description
BusinessObjectProvider()

Method Summary

Modifier and Type	Method and Description
static <T extends BusinessObject> void	delete(T type) Deprecated. Use Modifiable.delete() or Use Modifiable.delete(Object)
static <T extends BusinessObject> void	deleteAll(java.util.Collection<T> type) This method deletes all BusinessObjects of then given collection from the database.
static <PK,T extends LogicalDeletable> void	deleteLogical(T type) This method deletes all BusinessObjects logical without removing data from the database.
static <PK,T extends LogicalDeletable> void	deleteLogicalAll(java.util.Collection<T> type) This method deletes all BusinessObjects logical without removing data from the database.
static java.util.Set<java.lang.String>	getAllModifiableBusinessObjectClassNames() This method returns a set containing the names of all modifiable business object classes.
static <PK,T extends BusinessObject<PK>> PK	insert(T type) Deprecated. Use Modifiable.save(SaveFlag...)
static <PK,T extends BusinessObject<PK>> java.util.Collection<PK>	insertAll(java.util.Collection<T> type) This method receives a collection of new BusinessObjects and stores them in the database.
static NuclosFile	newFile(java.lang.String name, byte[] content) This method creates a new NuclosFile using the given content
static NuclosImage	newImage(java.lang.String name, byte[] content) This method creates a new NuclosImage using the given content; a thumbnail will be created automatically
void	setBusinessObjectService(BusinessObjectService service)
static <T extends BusinessObject> void	update(T type, SaveFlag... saveFlags) Deprecated. Use Modifiable.save(SaveFlag...)
static <T extends BusinessObject> void	updateAll(java.util.Collection<T> type) This method updates all BusinessObjects in the given collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BusinessObjectProvider

BusinessObjectProvider()

Method Detail

setBusinessObjectService

public void setBusinessObjectService(BusinessObjectService service)

insert

@Deprecated
public static <PK,T extends BusinessObject<PK>> PK insert(T type)
                                                               throws BusinessException

Deprecated. Use Modifiable.save(SaveFlag...)

This method receives a new BusinessObject and stores it in the database. If the BusinessObject is not flagged 'new' a BusinessException is thrown.

Parameters:

type -

Throws:

BusinessException

insertAll

public static <PK,T extends BusinessObject<PK>> java.util.Collection<PK> insertAll(java.util.Collection<T> type)
                                                                            throws BusinessException

This method receives a collection of new BusinessObjects and stores them in the database. If one BusinessObject is not flagged 'new' a BusinessException is thrown.

Parameters:

type -

Throws:

BusinessException

update

@Deprecated
public static <T extends BusinessObject> void update(T type,
                                                                 SaveFlag... saveFlags)
                                                          throws BusinessException

Deprecated. Use Modifiable.save(SaveFlag...)

This method updates a BusinessObjects in the database. If the BusinessObject is not flagged 'update' a BusinessException is thrown.

Parameters:

type -

Throws:

BusinessException

updateAll

public static <T extends BusinessObject> void updateAll(java.util.Collection<T> type)
                                                 throws BusinessException

This method updates all BusinessObjects in the given collection. If one BusinessObject is not flagged 'update' a BusinessException is thrown.

Parameters:

type -

Throws:

BusinessException

delete

@Deprecated
public static <T extends BusinessObject> void delete(T type)
                                                          throws BusinessException

Deprecated. Use Modifiable.delete() or Use Modifiable.delete(Object)

This method deletes the given BusinessObject from the database

Parameters:

type -

Throws:

BusinessException

deleteAll

public static <T extends BusinessObject> void deleteAll(java.util.Collection<T> type)
                                                 throws BusinessException

This method deletes all BusinessObjects of then given collection from the database.

Parameters:

type -

Throws:

BusinessException

deleteLogical

public static <PK,T extends LogicalDeletable> void deleteLogical(T type)
                                                          throws BusinessException

This method deletes all BusinessObjects logical without removing data from the database.

Parameters:

type -

Throws:

BusinessException

deleteLogicalAll

public static <PK,T extends LogicalDeletable> void deleteLogicalAll(java.util.Collection<T> type)
                                                             throws BusinessException

This method deletes all BusinessObjects logical without removing data from the database.

Parameters:

type -

Throws:

BusinessException

newFile

public static NuclosFile newFile(java.lang.String name,
                                 byte[] content)
                          throws BusinessException

This method creates a new NuclosFile using the given content

Parameters:

name -

content -

Returns:

NuclosFile

Throws:

BusinessException

newImage

public static NuclosImage newImage(java.lang.String name,
                                   byte[] content)
                            throws BusinessException

This method creates a new NuclosImage using the given content; a thumbnail will be created automatically

Parameters:

name -

content -

Returns:

NuclosImage

Throws:

BusinessException

getAllModifiableBusinessObjectClassNames

public static java.util.Set<java.lang.String> getAllModifiableBusinessObjectClassNames()

This method returns a set containing the names of all modifiable business object classes. Readonly business objects (such as datasource based), Integration points and generic business objects are NOT included. Helpful for a generic implementation of a GDPR requirement, for example.