de.hybris.platform.catalog

Interface CatalogService

All Known Implementing Classes:

DefaultCatalogService

public interface CatalogService

Provides access to Catalogs, CatalogVersions and Session CatalogVersions

Spring Bean ID:

catalogService

Method Summary

Modifier and Type	Method and Description
void	addSessionCatalogVersion(java.lang.String catalogId, java.lang.String catalogVersionName) Deprecated. since ages - UseCatalogVersionService.addSessionCatalogVersion(CatalogVersionModel)
java.util.Collection<CatalogModel>	getAllCatalogs() Returns all CatalogModels.
<T extends CatalogModel> java.util.Collection<T>	getAllCatalogsOfType(java.lang.Class<T> catalogType) Returns for the given T (upper bound CatalogModel) all catalogs of T defined in the system
CatalogModel	getCatalog(java.lang.String id) Deprecated. since ages - UsegetCatalogForId(String) instead.
CatalogModel	getCatalogForId(java.lang.String id) Returns the catalog with the specified id.
CatalogVersionModel	getCatalogVersion(java.lang.String catalogId, java.lang.String catalogVersionName) Deprecated. since ages - UseCatalogVersionService.getCatalogVersion(String, String)
CatalogModel	getDefaultCatalog() Returns the default catalog basing on CatalogModel.DEFAULTCATALOG property.
CatalogVersionModel	getSessionCatalogVersion(java.lang.String catalogId) Deprecated. since ages - UseCatalogVersionService.getSessionCatalogVersionForCatalog(String)
java.util.Set<CatalogVersionModel>	getSessionCatalogVersions() Deprecated. since ages - UseCatalogVersionService.getSessionCatalogVersions()
void	setSessionCatalogVersion(java.lang.String catalogId, java.lang.String catalogVersionName) Deprecated. since ages - useCatalogVersionService.setSessionCatalogVersion(String, String) instead.
void	setSessionCatalogVersions(java.util.Set<CatalogVersionModel> catalogVersions) Deprecated. since ages - UseCatalogVersionService.setSessionCatalogVersions(Collection)

Method Detail

setSessionCatalogVersion

@Deprecated
void setSessionCatalogVersion(java.lang.String catalogId,
                                          java.lang.String catalogVersionName)

Deprecated. since ages - useCatalogVersionService.setSessionCatalogVersion(String, String) instead.

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

Parameters:

catalogId - the id of the Catalog the CatalogVersion belongs to

catalogVersionName - the version of the Catalog version

Throws:

UnknownIdentifierException - if no CatalogVersion with the specified catalog id and version exists

AmbiguousIdentifierException - if more than one CatalogVersion is found with the specified catalog id and version

java.lang.IllegalArgumentException - if catalogId or catalogVersionName is null

setSessionCatalogVersions

@Deprecated
void setSessionCatalogVersions(java.util.Set<CatalogVersionModel> catalogVersions)

Deprecated. since ages - UseCatalogVersionService.setSessionCatalogVersions(Collection)

Sets the specified Set of CatalogVersionModels as the active CatalogVersions of the current session. The previous active Session CatalogVersions are replaced.

Parameters:

catalogVersions - the catalogVersions to be set as active session CatalogVersions

Throws:

java.lang.IllegalArgumentException - if catalogVersions is null

addSessionCatalogVersion

@Deprecated
void addSessionCatalogVersion(java.lang.String catalogId,
                                          java.lang.String catalogVersionName)

Deprecated. since ages - UseCatalogVersionService.addSessionCatalogVersion(CatalogVersionModel)

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

Parameters:

catalogId - the id of the Catalog the CatalogVersion belongs to

catalogVersionName - the version of the Catalog version

Throws:

UnknownIdentifierException - if no CatalogVersion with the specified catalog id and version exists

AmbiguousIdentifierException - if more than one CatalogVersion is found with the specified catalog id and version

java.lang.IllegalArgumentException - if catalogId or catalogVersionName is null

getSessionCatalogVersions

@Deprecated
java.util.Set<CatalogVersionModel> getSessionCatalogVersions()

Deprecated. since ages - UseCatalogVersionService.getSessionCatalogVersions()

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

Returns:

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

getCatalogVersion

@Deprecated
CatalogVersionModel getCatalogVersion(java.lang.String catalogId,
                                                  java.lang.String catalogVersionName)

Deprecated. since ages - UseCatalogVersionService.getCatalogVersion(String, String)

Returns the CatalogVersionModel with the specified catalogId and catalogVersionName.

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

Throws:

UnknownIdentifierException - if no CatalogVersion with the specified catalog id and version exists

AmbiguousIdentifierException - if more than one CatalogVersion is found with the specified catalog id and version

java.lang.IllegalArgumentException - if catalogId or catalogVersionName is null

getAllCatalogs

java.util.Collection<CatalogModel> getAllCatalogs()

Returns all CatalogModels.

Returns:

an empty collection if no CatalogModel were found.

getAllCatalogsOfType

<T extends CatalogModel> java.util.Collection<T> getAllCatalogsOfType(java.lang.Class<T> catalogType)

Returns for the given T (upper bound CatalogModel) all catalogs of T defined in the system

Type Parameters:

T - This could be a ClassificationSystemModel or a CatalogModel

Returns:

an empty collection if no ClassificationSystemModels or CatalogModel were found.

Throws:

java.lang.IllegalArgumentException - if catalogType is null

getCatalog

@Deprecated
CatalogModel getCatalog(java.lang.String id)

Deprecated. since ages - UsegetCatalogForId(String) instead.

Returns the catalog with the specified id.

Returns:

the catalog with the specified id.

Throws:

UnknownIdentifierException - if no Catalog with the specified id is found

AmbiguousIdentifierException - if more than one Catalog is found with the specified id

java.lang.IllegalArgumentException - if id is null

getCatalogForId

CatalogModel getCatalogForId(java.lang.String id)

Returns the catalog with the specified id.

Returns:

the catalog with the specified id.

Throws:

UnknownIdentifierException - if no Catalog with the specified id is found

AmbiguousIdentifierException - if more than one Catalog is found with the specified id

java.lang.IllegalArgumentException - if id is null

getDefaultCatalog

CatalogModel getDefaultCatalog()

Returns the default catalog basing on CatalogModel.DEFAULTCATALOG property. If multiple catalogs the one created the latest will be returned.

Returns:

default CatalogModel, or null in case no default catalog was found.

Throws:

{@link - AmbiguousIdentifierException} if there exists more then one default catalog in the data base.

getSessionCatalogVersion

@Deprecated
CatalogVersionModel getSessionCatalogVersion(java.lang.String catalogId)

Deprecated. since ages - UseCatalogVersionService.getSessionCatalogVersionForCatalog(String)

Returns the CatalogVersionModel in the session with the specified catalogId

Parameters:

catalogId - the Catalog id the CatalogVersion belongs to

Returns:

the catalog version in the session with the specified catalogId, or null if not found

Throws:

java.lang.IllegalArgumentException - if catalogId is null

AmbiguousIdentifierException - if more than one CatalogVersionModel can be found in the session with the specified catalogId