org.broadleafcommerce.openadmin.server.service

Interface DynamicEntityService

All Known Implementing Classes:

DynamicEntityRemoteService

public interface DynamicEntityService

Rather than using this clas directly, it might be more appropraite to utilize AdminEntityService instead. The methods in this class will not attempt to recover from things like validation problems whereas AdminEntityService will.

Author:

jfischer

Method Summary

Methods

Modifier and Type	Method and Description
PersistenceResponse	add(PersistencePackage persistencePackage) This will throw a ValidationException and not attempt to swallow them and wrap any other exceptions within a ServiceException that might have resulted in adding the given package.
PersistenceResponse	fetch(PersistencePackage persistencePackage, CriteriaTransferObject cto)
PersistenceResponse	inspect(PersistencePackage persistencePackage) Builds all of the metadata associated with a particular request for an entity.
PersistenceResponse	nonTransactionalAdd(PersistencePackage persistencePackage) The exact same as add(PersistencePackage) except this is not bound to a transaction.
PersistenceResponse	nonTransactionalRemove(PersistencePackage persistencePackage) The exact same as remove(PersistencePackage) except this is not bound to a transaction.
PersistenceResponse	nonTransactionalUpdate(PersistencePackage persistencePackage) The exact same as update(PersistencePackage) except this is not bound to a transaction.
PersistenceResponse	remove(PersistencePackage persistencePackage)
PersistenceResponse	update(PersistencePackage persistencePackage)

Method Detail

inspect

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse inspect(PersistencePackage persistencePackage)
                            throws ServiceException

Builds all of the metadata associated with a particular request for an entity. The resulting PersistenceResponse that is returned will not have the PersistenceResponse.getEntity() property set and this will return null. Instead, this will populate PersistenceResponse.getDynamicResultSet().

Parameters:

persistencePackage - the package that should be passed through the admin pipeline to build the metadata

Returns:

a PersistenceResponse with the PersistenceResponse.getDynamicResultSet() set with the metadata of the built properties for this particular entity

Throws:

ServiceException - wraps whatever internal exception that might have occurred as a result of the inspect

fetch

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse fetch(PersistencePackage persistencePackage,
                                CriteriaTransferObject cto)
                          throws ServiceException

Throws:

ServiceException

add

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse add(PersistencePackage persistencePackage)
                        throws ServiceException

This will throw a ValidationException and not attempt to swallow them and wrap any other exceptions within a ServiceException that might have resulted in adding the given package.

Parameters:

persistencePackage -

Returns:

Throws:

ServiceException

See Also:

AdminEntityService#add(org.broadleafcommerce.openadmin.server.domain.PersistencePackageRequest)}

nonTransactionalAdd

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse nonTransactionalAdd(PersistencePackage persistencePackage)
                                        throws ServiceException

The exact same as add(PersistencePackage) except this is not bound to a transaction. This is useful when transactions are handled by the caller that has its own rollback logic (like when batching multiple adds).

Parameters:

persistencePackage -

Returns:

Throws:

ServiceException

update

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse update(PersistencePackage persistencePackage)
                           throws ServiceException

Throws:

ServiceException

nonTransactionalUpdate

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse nonTransactionalUpdate(PersistencePackage persistencePackage)
                                           throws ServiceException

The exact same as update(PersistencePackage) except this is not bound to a transaction. This is useful when transactions are handled by the caller that has its own rollback logic (like when batching multiple updates).

Parameters:

persistencePackage -

Returns:

Throws:

ServiceException

remove

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse remove(PersistencePackage persistencePackage)
                           throws ServiceException

Throws:

ServiceException

nonTransactionalRemove

@Secured(value="PERMISSION_OTHER_DEFAULT")
PersistenceResponse nonTransactionalRemove(PersistencePackage persistencePackage)
                                           throws ServiceException

The exact same as remove(PersistencePackage) except this is not bound to a transaction. This is useful when transactions are handled by the caller that has its own rollback logic (like when batching multiple removes).

Parameters:

persistencePackage -

Returns:

Throws:

ServiceException