de.hybris.platform.catalog.impl

Class DefaultCatalogVersionService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.catalog.impl.DefaultCatalogVersionService

All Implemented Interfaces:

CatalogVersionService, java.io.Serializable

public class DefaultCatalogVersionService
extends AbstractBusinessService
implements CatalogVersionService

Service provides basic catalog version oriented functionality. Allows fetching catalog version information, managing session catalog versions and determining whether user is eligible for read/write operations within the given catalog version.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor and Description
DefaultCatalogVersionService()

Method Summary

Modifier and Type	Method and Description
void	addSessionCatalogVersion(CatalogVersionModel catalogVersion) Adds the CatalogVersionModel specified by catalogId and catalogVersionName to the current active Session CatalogVersions.
boolean	canRead(CatalogVersionModel catalogVersion, UserModel user) Determines whether user can read from given catalogVersion.
boolean	canWrite(CatalogVersionModel catalogVersion, UserModel user) Determines whether user can write to given catalogVersion.
java.util.Collection<DuplicatedItemIdentifier>	findDuplicatedIds(CatalogVersionModel catalogVersionModel) Returs collection of duplicated items in given catalog.
java.util.Collection<CatalogVersionModel>	getAllCatalogVersions() Returns all catalog versions defined in the system.
<T extends CatalogVersionModel> java.util.Collection<T>	getAllCatalogVersionsOfType(java.lang.Class<T> versionType) Returns for the given T (upper bound CatalogVersionModel) all catalog versions of T defined in the system
java.util.Collection<CatalogVersionModel>	getAllReadableCatalogVersions(PrincipalModel principal) Returns all readable CatalogVersionModels for the given principal.
java.util.Collection<CatalogVersionModel>	getAllWritableCatalogVersions(PrincipalModel principal) Returns all writable CatalogVersionModels for the given principal.
CatalogVersionModel	getCatalogVersion(java.lang.String catalogId, java.lang.String catalogVersionName) Returns the CatalogVersionModel with the specified catalogId and catalogVersionName.
CatalogVersionModel	getSessionCatalogVersionForCatalog(java.lang.String catalogId) Returns the CatalogVersionModel in the session with the specified catalogId.
java.util.Collection<CatalogVersionModel>	getSessionCatalogVersions() Returns a collection of the CatalogVersionModels which are activated for the current session.
java.util.Collection<CatalogVersionModel>	getSessionCatalogVersionsForCatalog(java.lang.String catalogId) Returns the CatalogVersionModels in the session of the CatalogModel matching the specified catalogId.
void	setCatalogVersionDao(CatalogVersionDao catalogVersionDao)
void	setSearchRestrictionService(SearchRestrictionService searchRestrictionService)
void	setSessionCatalogVersion(java.lang.String catalogId, java.lang.String catalogVersionName) Sets the CatalogVersionModel specified by catalogId and catalogVersionName as the active CatalogVersion of the current session.
void	setSessionCatalogVersions(java.util.Collection<CatalogVersionModel> catalogVersions) Sets the specified collection of CatalogVersionModels as the active CatalogVersions of the current session.
void	setUserService(UserService userService)

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCatalogVersionService

public DefaultCatalogVersionService()

Method Detail

setSessionCatalogVersion

public void setSessionCatalogVersion(java.lang.String catalogId,
                                     java.lang.String catalogVersionName)

Description copied from interface: CatalogVersionService

Sets the CatalogVersionModel specified by catalogId and catalogVersionName as the active CatalogVersion of the current session. Previously set active CatalogVersions are replaced.

Specified by:

setSessionCatalogVersion in interface CatalogVersionService

Parameters:

catalogId - the id of the Catalog the CatalogVersion belongs to

catalogVersionName - the name of the Catalog version

setSessionCatalogVersions

public void setSessionCatalogVersions(java.util.Collection<CatalogVersionModel> catalogVersions)

Description copied from interface: CatalogVersionService

Sets the specified collection of CatalogVersionModels as the active CatalogVersions of the current session. The previous active session catalog versions are replaced.

Specified by:

setSessionCatalogVersions in interface CatalogVersionService

Parameters:

catalogVersions - the catalogVersions to be set as active session CatalogVersions

getSessionCatalogVersions

public java.util.Collection<CatalogVersionModel> getSessionCatalogVersions()

Description copied from interface: CatalogVersionService

Returns a collection of the CatalogVersionModels which are activated for the current session.

Specified by:

getSessionCatalogVersions in interface CatalogVersionService

Returns:

an empty collection if no active catalog versions for the current session were found.

addSessionCatalogVersion

public void addSessionCatalogVersion(CatalogVersionModel catalogVersion)

Description copied from interface: CatalogVersionService

Adds the CatalogVersionModel specified by catalogId and catalogVersionName to the current active Session CatalogVersions.

Specified by:

addSessionCatalogVersion in interface CatalogVersionService

Parameters:

catalogVersion - CatalogVersion to add

getCatalogVersion

public CatalogVersionModel getCatalogVersion(java.lang.String catalogId,
                                             java.lang.String catalogVersionName)

Description copied from interface: CatalogVersionService

Returns the CatalogVersionModel with the specified catalogId and catalogVersionName.

Specified by:

getCatalogVersion in interface CatalogVersionService

Parameters:

catalogId - the id for the catalog

catalogVersionName - the version string for the catalog version

Returns:

the CatalogVersion with the specified catalog id and version

getSessionCatalogVersionForCatalog

public CatalogVersionModel getSessionCatalogVersionForCatalog(java.lang.String catalogId)

Description copied from interface: CatalogVersionService

Returns the CatalogVersionModel in the session with the specified catalogId. This method expects only one catalog version per catalog in the session, which is true for majority of cases. If this is not the case, the AmbiguousIdentifierException will be thrown.

Specified by:

getSessionCatalogVersionForCatalog in interface CatalogVersionService

Parameters:

catalogId - the Catalog id the CatalogVersion belongs to

Returns:

the catalog version in the session with the specified catalogId, or null if no such catalog version was found.

getSessionCatalogVersionsForCatalog

public java.util.Collection<CatalogVersionModel> getSessionCatalogVersionsForCatalog(java.lang.String catalogId)

Description copied from interface: CatalogVersionService

Returns the CatalogVersionModels in the session of the CatalogModel matching the specified catalogId.

Specified by:

getSessionCatalogVersionsForCatalog in interface CatalogVersionService

Parameters:

catalogId - the Catalog id the CatalogVersion belongs to

Returns:

the collection of CatalogVersionModels or empty collection if no matching catalog versions were found in the session.

canRead

public boolean canRead(CatalogVersionModel catalogVersion,
                       UserModel user)

Description copied from interface: CatalogVersionService

Determines whether user can read from given catalogVersion.

Specified by:

canRead in interface CatalogVersionService

Parameters:

catalogVersion - target CatalogVersionModel

user - target UserModel

canWrite

public boolean canWrite(CatalogVersionModel catalogVersion,
                        UserModel user)

Description copied from interface: CatalogVersionService

Determines whether user can write to given catalogVersion.

Specified by:

canWrite in interface CatalogVersionService

Parameters:

catalogVersion - target CatalogVersionModel

user - target UserModel

getAllReadableCatalogVersions

public java.util.Collection<CatalogVersionModel> getAllReadableCatalogVersions(PrincipalModel principal)

Description copied from interface: CatalogVersionService

Returns all readable CatalogVersionModels for the given principal.

Specified by:

getAllReadableCatalogVersions in interface CatalogVersionService

Parameters:

principal - target principal

getAllWritableCatalogVersions

public java.util.Collection<CatalogVersionModel> getAllWritableCatalogVersions(PrincipalModel principal)

Description copied from interface: CatalogVersionService

Returns all writable CatalogVersionModels for the given principal.

Specified by:

getAllWritableCatalogVersions in interface CatalogVersionService

Parameters:

principal - target principal

getAllCatalogVersions

public java.util.Collection<CatalogVersionModel> getAllCatalogVersions()

Description copied from interface: CatalogVersionService

Returns all catalog versions defined in the system. Return empty collection if none was found.

Specified by:

getAllCatalogVersions in interface CatalogVersionService

setCatalogVersionDao

public void setCatalogVersionDao(CatalogVersionDao catalogVersionDao)

getAllCatalogVersionsOfType

public <T extends CatalogVersionModel> java.util.Collection<T> getAllCatalogVersionsOfType(java.lang.Class<T> versionType)

Description copied from interface: CatalogVersionService

Returns for the given T (upper bound CatalogVersionModel) all catalog versions of T defined in the system

Specified by:

getAllCatalogVersionsOfType in interface CatalogVersionService

Type Parameters:

T - This could be a ClassificationSystemVersionModel or a CatalogVersionModel

Returns:

an empty collection if no CatalogVersionModels or ClassificationSystemVersionModel were found.

findDuplicatedIds

public java.util.Collection<DuplicatedItemIdentifier> findDuplicatedIds(CatalogVersionModel catalogVersionModel)

Description copied from interface: CatalogVersionService

Returs collection of duplicated items in given catalog.

Specified by:

findDuplicatedIds in interface CatalogVersionService

Returns:

setUserService

public void setUserService(UserService userService)

setSearchRestrictionService

public void setSearchRestrictionService(SearchRestrictionService searchRestrictionService)