Package de.hybris.platform.cockpit.jalo

Class CockpitManager

java.lang.Object

de.hybris.platform.jalo.Manager

de.hybris.platform.jalo.extension.Extension

de.hybris.platform.cockpit.jalo.GeneratedCockpitManager

de.hybris.platform.cockpit.jalo.CockpitManager

All Implemented Interfaces:

ItemLifecycleListener, Serializable

public class CockpitManager
extends GeneratedCockpitManager

This is the extension manager of the Cockpit extension.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.jalo.extension.Extension

Extension.RestrictedLanguagesProvider, Extension.RightsProvider

Nested classes/interfaces inherited from class de.hybris.platform.jalo.Manager

Manager.GenericManagerSingletonCreator, Manager.ManagerSingletonCreator

Field Summary

Fields inherited from class de.hybris.platform.cockpit.jalo.GeneratedCockpitManager

COCKPITITEMTEMPLATE2CLASSIFICATIONCLASSRELATION_MARKMODIFIED, COCKPITITEMTEMPLATE2CLASSIFICATIONCLASSRELATION_SRC_ORDERED, COCKPITITEMTEMPLATE2CLASSIFICATIONCLASSRELATION_TGT_ORDERED, COCKPITITEMTEMPLATE2COMPOSEDTYPERELATIONCOCKPITITEMTEMPLATESHANDLER, COMMENTTOCOMMENTMETADATACOMMENTMETADATAHANDLER, DEFAULT_INITIAL_ATTRIBUTES, ITEM2COCKPITITEMTEMPLATERELATION_MARKMODIFIED, ITEM2COCKPITITEMTEMPLATERELATION_SRC_ORDERED, ITEM2COCKPITITEMTEMPLATERELATION_TGT_ORDERED, PRINCIPAL2COCKPITUICOMPONENTCONFIGURATIONRELATIONCOCKPITUICONFIGURATIONSHANDLER, PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION_MARKMODIFIED, PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION_SRC_ORDERED, PRINCIPAL2COCKPITUICOMPONENTREADACCESSRELATION_TGT_ORDERED, PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION_MARKMODIFIED, PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION_SRC_ORDERED, PRINCIPAL2COCKPITUICOMPONENTWRITEACCESSRELATION_TGT_ORDERED, READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED, READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED, READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED, READPRINCIPAL2COCKPITSAVEDQUERYRELATION_MARKMODIFIED, READPRINCIPAL2COCKPITSAVEDQUERYRELATION_SRC_ORDERED, READPRINCIPAL2COCKPITSAVEDQUERYRELATION_TGT_ORDERED, USER2COCKPITFAVORITECATEGORYRELATIONCOCKPITFAVORITECATEGORIESHANDLER, USER2COCKPITOBJECTABSTRACTCOLLECTIONRELATIONCOLLECTIONSHANDLER, USER2COCKPITSAVEDQUERYRELATIONCOCKPITSAVEDQUERIESHANDLER, WIDGETPREFERENCESTOUSERRELATIONWIDGETPREFERENCESHANDLER, WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED, WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED, WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED

Constructor Summary

Constructors

Constructor	Description
CockpitManager()

Method Summary

Modifier and Type	Method	Description
CockpitItemTemplate	createCockpitItemTemplate(String code, Class<? extends Item> itemClass)
CockpitUIComponentConfiguration	createCockpitUIComponentConfiguration(String factoryBean, String code, String objectTemplateCode, Principal principal, Media media)
void	createEssentialData(Map<String,String> params, JspContext jspc)
void	createProjectData(Map<String,String> params, JspContext jspc)
String	generateOpenInHMCURL(String pk, javax.servlet.http.HttpServletRequest request)	Generates an URL for opening the corresponding item hMC editor
List<CockpitObjectCollection>	getAllCollections()	Deprecated. since 6.3, use CockpitCollectionService to fetch collections
Set<CockpitObjectAbstractCollection>	getAllCollections(User user)	Deprecated. since 6.3, use CockpitCollectionService.getCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead
CockpitItemTemplate	getCockpitItemTemplate(ComposedType type, String qualifier)	Searches for item template with the given {code}qualifier{code} assigned to the given {code}type{code}.
List<CockpitObjectAbstractCollection>	getCollections(SessionContext ctx, User user)	Deprecated. since 6.3, use CockpitCollectionService.getCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead
List<CockpitObjectAbstractCollection>	getGlobalCollections()	Deprecated. since 6.3, use CockpitCollectionService to fetch collections
List<CockpitSavedQuery>	getGlobalSavedQueries()
static CockpitManager	getInstance()	Get the valid instance of this manager.
MediaFolder	getJasperReportsMediaFolder()
Collection<CockpitItemTemplate>	getMatchingItemTemplates(Item item)	Returns all item templates which potentially match the given item.
String	getMnemonic(SessionContext ctx, CatalogVersion item)	Generated method - Getter of the CatalogVersion.mnemonic attribute.
List<CockpitObjectAbstractCollection>	getSpecialCollections(User user)	Deprecated. since 6.3, use CockpitCollectionService.getSpecialCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead
List<CockpitObjectAbstractCollection>	getSpecialCollections(User user, String collectionType)	Deprecated. since 6.3, use CockpitCollectionService.getSpecialCollections(de.hybris.platform.core.model.user.UserModel, String) instead

Methods inherited from class de.hybris.platform.cockpit.jalo.GeneratedCockpitManager

addToAssignedCockpitItemTemplates, addToAssignedCockpitItemTemplates, addToCockpitFavoriteCategories, addToCockpitFavoriteCategories, addToCockpitItemTemplates, addToCockpitItemTemplates, addToCockpitItemTemplates, addToCockpitItemTemplates, addToCockpitSavedQueries, addToCockpitSavedQueries, addToCockpitUIConfigurations, addToCockpitUIConfigurations, addToCollections, addToCollections, addToCommentMetadata, addToCommentMetadata, addToReadableCockpitUIComponents, addToReadableCockpitUIComponents, addToReadCollections, addToReadCollections, addToReadSavedQueries, addToReadSavedQueries, addToWidgetPreferences, addToWidgetPreferences, addToWritableCockpitUIComponents, addToWritableCockpitUIComponents, addToWriteCollections, addToWriteCollections, createCockpitFavoriteCategory, createCockpitFavoriteCategory, createCockpitItemTemplate, createCockpitItemTemplate, createCockpitObjectAbstractCollection, createCockpitObjectAbstractCollection, createCockpitObjectCollection, createCockpitObjectCollection, createCockpitObjectSpecialCollection, createCockpitObjectSpecialCollection, createCockpitSavedFacetValue, createCockpitSavedFacetValue, createCockpitSavedParameterValue, createCockpitSavedParameterValue, createCockpitSavedQuery, createCockpitSavedQuery, createCockpitSavedSortCriterion, createCockpitSavedSortCriterion, createCockpitUIComponentAccessRight, createCockpitUIComponentAccessRight, createCockpitUIComponentConfiguration, createCockpitUIComponentConfiguration, createCockpitUIConfigurationMedia, createCockpitUIConfigurationMedia, createCockpitUIScriptConfigMedia, createCockpitUIScriptConfigMedia, createCommentMetadata, createCommentMetadata, createCompiledJasperMedia, createCompiledJasperMedia, createJasperMedia, createJasperMedia, createJasperWidgetPreferences, createJasperWidgetPreferences, createObjectCollectionItemReference, createObjectCollectionItemReference, createWidgetParameter, createWidgetParameter, getAssignedCockpitItemTemplates, getAssignedCockpitItemTemplates, getAssignedCockpitItemTemplatesCount, getAssignedCockpitItemTemplatesCount, getCockpitFavoriteCategories, getCockpitFavoriteCategories, getCockpitItemTemplates, getCockpitItemTemplates, getCockpitItemTemplates, getCockpitItemTemplates, getCockpitItemTemplatesCount, getCockpitItemTemplatesCount, getCockpitSavedQueries, getCockpitSavedQueries, getCockpitUIConfigurations, getCockpitUIConfigurations, getCollections, getCommentMetadata, getCommentMetadata, getDefaultAttributeModes, getMnemonic, getName, getReadableCockpitUIComponents, getReadableCockpitUIComponents, getReadableCockpitUIComponentsCount, getReadableCockpitUIComponentsCount, getReadCollections, getReadCollections, getReadCollectionsCount, getReadCollectionsCount, getReadSavedQueries, getReadSavedQueries, getReadSavedQueriesCount, getReadSavedQueriesCount, getWidgetPreferences, getWidgetPreferences, getWritableCockpitUIComponents, getWritableCockpitUIComponents, getWritableCockpitUIComponentsCount, getWritableCockpitUIComponentsCount, getWriteCollections, getWriteCollections, getWriteCollectionsCount, getWriteCollectionsCount, isHidden, isHidden, isHiddenAsPrimitive, isHiddenAsPrimitive, isWorkStatus, isWorkStatus, isWorkStatusAsPrimitive, isWorkStatusAsPrimitive, removeFromAssignedCockpitItemTemplates, removeFromAssignedCockpitItemTemplates, removeFromCockpitFavoriteCategories, removeFromCockpitFavoriteCategories, removeFromCockpitItemTemplates, removeFromCockpitItemTemplates, removeFromCockpitItemTemplates, removeFromCockpitItemTemplates, removeFromCockpitSavedQueries, removeFromCockpitSavedQueries, removeFromCockpitUIConfigurations, removeFromCockpitUIConfigurations, removeFromCollections, removeFromCollections, removeFromCommentMetadata, removeFromCommentMetadata, removeFromReadableCockpitUIComponents, removeFromReadableCockpitUIComponents, removeFromReadCollections, removeFromReadCollections, removeFromReadSavedQueries, removeFromReadSavedQueries, removeFromWidgetPreferences, removeFromWidgetPreferences, removeFromWritableCockpitUIComponents, removeFromWritableCockpitUIComponents, removeFromWriteCollections, removeFromWriteCollections, setAssignedCockpitItemTemplates, setAssignedCockpitItemTemplates, setCockpitFavoriteCategories, setCockpitFavoriteCategories, setCockpitItemTemplates, setCockpitItemTemplates, setCockpitItemTemplates, setCockpitItemTemplates, setCockpitSavedQueries, setCockpitSavedQueries, setCockpitUIConfigurations, setCockpitUIConfigurations, setCollections, setCollections, setCommentMetadata, setCommentMetadata, setHidden, setHidden, setHidden, setHidden, setMnemonic, setMnemonic, setReadableCockpitUIComponents, setReadableCockpitUIComponents, setReadCollections, setReadCollections, setReadSavedQueries, setReadSavedQueries, setWidgetPreferences, setWidgetPreferences, setWorkStatus, setWorkStatus, setWorkStatus, setWorkStatus, setWritableCockpitUIComponents, setWritableCockpitUIComponents, setWriteCollections, setWriteCollections

Methods inherited from class de.hybris.platform.jalo.extension.Extension

checkBeforeInitialization, checkBeforeItemRemoval, createSampleData, getCreatorDescription, getCreatorName, getCreatorParameterDefault, getCreatorParameterNames, getCreatorParameterPossibleValues, getRemote, isCreatorDisabled, notifyInitializationEnd, notifyInitializationStart, notifyItemRemoval, onFirstSessionCreation, writeReplace

Methods inherited from class de.hybris.platform.jalo.Manager

afterItemCreation, beforeItemCreation, destroy, extractNonRequiredRemoteFromItem, extractRequiredRemoteFromItem, getAllValuesSessionContext, getAttribute, getAttributeMap, getFirstItemByAttribute, getFirstItemByAttribute, getRemoteManagerClass, getSession, getSingletonManagerInstance, getTenant, getTransientObject, getTransientObjectMap, init, setAttribute, setTenant, setTransientObject, wrap

Methods inherited from class java.lang.Object

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

Constructor Details

CockpitManager

public CockpitManager()

Method Details

getInstance

public static CockpitManager getInstance()

Get the valid instance of this manager.

Returns:

the current instance of this manager

getGlobalCollections

@Deprecated
public List<CockpitObjectAbstractCollection> getGlobalCollections()

Deprecated.

since 6.3, use CockpitCollectionService to fetch collections

getAllCollections

@Deprecated
public List<CockpitObjectCollection> getAllCollections()

Deprecated.

since 6.3, use CockpitCollectionService to fetch collections

getGlobalSavedQueries

public List<CockpitSavedQuery> getGlobalSavedQueries()

getMnemonic

public String getMnemonic(SessionContext ctx,
 CatalogVersion item)

Description copied from class: GeneratedCockpitManager

Generated method - Getter of the CatalogVersion.mnemonic attribute.

Overrides:

getMnemonic in class GeneratedCockpitManager

Returns:

the mnemonic

getCollections

@Deprecated
public List<CockpitObjectAbstractCollection> getCollections(SessionContext ctx,
 User user)

Deprecated.

since 6.3, use CockpitCollectionService.getCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead

Description copied from class: GeneratedCockpitManager

Generated method - Getter of the User.collections attribute.

Overrides:

getCollections in class GeneratedCockpitManager

Returns:

the collections

getSpecialCollections

@Deprecated
public List<CockpitObjectAbstractCollection> getSpecialCollections(User user)

Deprecated.

since 6.3, use CockpitCollectionService.getSpecialCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead

getSpecialCollections

@Deprecated
public List<CockpitObjectAbstractCollection> getSpecialCollections(User user,
 String collectionType)

Deprecated.

since 6.3, use CockpitCollectionService.getSpecialCollections(de.hybris.platform.core.model.user.UserModel, String) instead

generateOpenInHMCURL

public String generateOpenInHMCURL(String pk,
 javax.servlet.http.HttpServletRequest request)
                            throws EJBPasswordEncoderNotFoundException

Generates an URL for opening the corresponding item hMC editor

Parameters:

pk - the PK of the item which will be opened

request - the request, will be used for extracting server name, port and scheme if the property 'hmc.base.url' is undefined, Could be null!

Returns:

the generated URL

Throws:

EJBPasswordEncoderNotFoundException

getCockpitItemTemplate

public CockpitItemTemplate getCockpitItemTemplate(ComposedType type,
 String qualifier)

Searches for item template with the given {code}qualifier{code} assigned to the given {code}type{code}.

Parameters:

type - type the searched item template is assigned to

qualifier - qualifier of the searched item template

Returns:

item template with the given {code}qualifier{code} assigned to the given {code}type{code} or {code}null{code} if no such item template exists

getMatchingItemTemplates

public Collection<CockpitItemTemplate> getMatchingItemTemplates(Item item)

Returns all item templates which potentially match the given item.

Parameters:

item - item to get potential matching templates for

Returns:

item templates which potentially match the given item

createCockpitUIComponentConfiguration

public CockpitUIComponentConfiguration createCockpitUIComponentConfiguration(String factoryBean,
 String code,
 String objectTemplateCode,
 Principal principal,
 Media media)

createCockpitItemTemplate

public CockpitItemTemplate createCockpitItemTemplate(String code,
 Class<? extends Item> itemClass)

createEssentialData

public void createEssentialData(Map<String,String> params,
 JspContext jspc)
                         throws Exception

Overrides:

createEssentialData in class Extension

Throws:

Exception

createProjectData

public void createProjectData(Map<String,String> params,
 JspContext jspc)
                       throws Exception

Overrides:

createProjectData in class Extension

Throws:

Exception

getJasperReportsMediaFolder

public MediaFolder getJasperReportsMediaFolder()

getAllCollections

@Deprecated
public Set<CockpitObjectAbstractCollection> getAllCollections(User user)

Deprecated.

since 6.3, use CockpitCollectionService.getCollectionsForUser(de.hybris.platform.core.model.user.UserModel) instead

Returns:

all collection for given user, including collections assigned to groups that user belongs to.