Package de.hybris.platform.jalo

Class GenericItem

java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.GenericItem
All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
AbstractRedirect, GeneratedAbstractAction, GeneratedAbstractAdvancedSavedQuerySearchParameter, GeneratedAbstractAsConfiguration, GeneratedAbstractAsSearchProfile, GeneratedAbstractBundleRule, GeneratedAbstractComment, GeneratedAbstractConfiguratorSetting, GeneratedAbstractConstraint, GeneratedAbstractContactInfo, GeneratedAbstractCoupon, GeneratedAbstractCredential, GeneratedAbstractDestination, GeneratedAbstractDynamicContent, GeneratedAbstractIntegrationObjectItemAttribute, GeneratedAbstractMedia, GeneratedAbstractMerchProperty, GeneratedAbstractOrder, GeneratedAbstractOrderEntry, GeneratedAbstractOrderEntryProductInfo, GeneratedAbstractPromotion, GeneratedAbstractPromotionAction, GeneratedAbstractPromotionRestriction, GeneratedAbstractRetentionRule, GeneratedAbstractRule, GeneratedAbstractRuleEngineContext, GeneratedAbstractRuleEngineRule, GeneratedAbstractRulesModule, GeneratedAbstractRuleTemplate, GeneratedAbstractSnIndexerItemSource, GeneratedAbstractSnSearchProviderConfiguration, GeneratedAbstractUserAudit, GeneratedAbstractWorkflowAction, GeneratedAbstractWorkflowDecision, GeneratedAddress, GeneratedAdvancedShippingNotice, GeneratedAdvancedShippingNoticeEntry, GeneratedAgreement, GeneratedAsSearchProfileActivationSet, GeneratedAtpFormula, GeneratedAttributeValueAssignment, GeneratedB2BBookingLineEntry, GeneratedB2BBudget, GeneratedB2BComment, GeneratedB2BCostCenter, GeneratedB2BCustomerPunchOutCredentialMapping, GeneratedB2BDocument, GeneratedB2BDocumentPaymentInfo, GeneratedB2BDocumentType, GeneratedB2BMerchantCheck, GeneratedB2BMerchantCheckResult, GeneratedB2BPermission, GeneratedB2BPermissionResult, GeneratedB2BQuoteLimit, GeneratedB2BRegistration, GeneratedB2BReportingSet, GeneratedBackofficeIndexedTypeToSearchservicesIndexConfig, GeneratedBackofficeIndexedTypeToSolrFacetSearchConfig, GeneratedBackofficeObjectCollectionItemReference, GeneratedBackofficeObjectSpecialCollection, GeneratedBackofficeSavedQuery, GeneratedBackofficeSearchCondition, GeneratedBaseSite, GeneratedBaseStore, GeneratedBatch, GeneratedBillingPlan, GeneratedBillingTime, GeneratedBruteForceLoginAttempts, GeneratedBundleSelectionCriteria, GeneratedBundleTemplate, GeneratedBundleTemplateStatus, GeneratedBusinessProcess, GeneratedBusinessProcessParameter, GeneratedC2LItem, GeneratedCampaign, GeneratedCarrier, GeneratedCatalog, GeneratedCatalogVersion, GeneratedCatalogVersionDifference, GeneratedCatalogVersionToRuleEngineContextMapping, GeneratedCategory, GeneratedCatForPromotionSourceRule, GeneratedCCPaySubValidation, GeneratedChangeDescriptor, GeneratedChargeEntry, GeneratedClassAttributeAssignment, GeneratedClassFeatureGroup, GeneratedClassFeatureGroupAssignment, GeneratedClassificationAttribute, GeneratedClassificationAttributeUnit, GeneratedClassificationAttributeValue, GeneratedCMSItem, GeneratedCMSItemTypeAttributeFilterConfig, GeneratedCMSPreviewTicket, GeneratedCMSRelation, GeneratedCMSVersion, GeneratedCockpitFavoriteCategory, GeneratedCockpitItemTemplate, GeneratedCockpitObjectAbstractCollection, GeneratedCockpitSavedFacetValue, GeneratedCockpitSavedParameterValue, GeneratedCockpitSavedQuery, GeneratedCockpitSavedSortCriterion, GeneratedCockpitUIComponentAccessRight, GeneratedCockpitUIComponentConfiguration, GeneratedCodeGenerationConfiguration, GeneratedCombinedCatsForRule, GeneratedCommentAttachment, GeneratedCommentMetadata, GeneratedCommentType, GeneratedCommentUserSetting, GeneratedComponent, GeneratedComponentTypeGroup, GeneratedComposedIndexedType, GeneratedCompositeEntry, GeneratedConsent, GeneratedConsentTemplate, GeneratedConsignment, GeneratedConsignmentEntry, GeneratedConsignmentEntryEvent, GeneratedConstraintGroup, GeneratedContentSlotName, GeneratedConversation, GeneratedConversionErrorLog, GeneratedConversionGroup, GeneratedCorsConfigurationProperty, GeneratedCouponNotification, GeneratedCouponRedemption, GeneratedCronJob, GeneratedCronJobHistory, GeneratedCsTicket, GeneratedCsTicketChangeEventEntry, GeneratedCsTicketEmail, GeneratedCsTicketEventEmailConfiguration, GeneratedCustomerCouponForPromotionSourceRule, GeneratedCustomerReview, GeneratedCustomerVendorReview, GeneratedCxAbstractCalcConfig, GeneratedCxAbstractTrigger, GeneratedCxConfig, GeneratedCxCustomization, GeneratedCxCustomizationsGroup, GeneratedCxResults, GeneratedCxSegment, GeneratedCxUserToSegment, GeneratedCxVariation, GeneratedDataHubInstanceModel, GeneratedDeeplinkUrl, GeneratedDeeplinkUrlRule, GeneratedDeliveryMode, GeneratedDeliveryTimeSlot, GeneratedDestinationTarget, GeneratedDiscount, GeneratedDistributedProcess, GeneratedDomain, GeneratedDroolsKIEBase, GeneratedDroolsKIESession, GeneratedEmailAddress, GeneratedEmailMessage, GeneratedEndpoint, GeneratedEntitlement, GeneratedEventConfiguration, GeneratedEventExportDeadLetter, GeneratedEventPropertyConfiguration, GeneratedExcludedCatForRule, GeneratedExcludedProductForRule, GeneratedExport, GeneratedExportDataHistoryEntry, GeneratedExternalImportKey, GeneratedFormat, GeneratedFraudReport, GeneratedFraudSymptomScoring, GeneratedFutureStock, GeneratedGeneratedSmarteditConfiguration, GeneratedGenericDataSupplierGenerationWizard, GeneratedImpexDocumentId, GeneratedImportBatchContent, GeneratedInboundChannelConfiguration, GeneratedIndexTestItem, GeneratedIntegrationObject, GeneratedIntegrationObjectItem, GeneratedIntegrationObjectVirtualAttributeDescriptor, GeneratedInventoryEvent, GeneratedItemSyncTimestamp, GeneratedItemVersionMarker, GeneratedJaloTranslatorConfiguration, GeneratedJaloVelocityRenderer, GeneratedJob, GeneratedJobLog, GeneratedJobSearchRestriction, GeneratedKeyword, GeneratedMediaContainer, GeneratedMediaContext, GeneratedMediaFolder, GeneratedMediaFormat, GeneratedMediaFormatMapping, GeneratedMediaMetaData, GeneratedMerchIndexingConfig, GeneratedMerchProductDirectoryConfig, GeneratedMerchSynchronization, GeneratedMerchSynchronizationConfig, GeneratedMobileNumberVerification, GeneratedMonitoredRequest, GeneratedMonitoredRequestError, GeneratedObjectCollectionElement, GeneratedOpeningDay, GeneratedOpeningSchedule, GeneratedOrderCancelConfig, GeneratedOrderEntryModificationRecordEntry, GeneratedOrderForm, GeneratedOrderFormEntry, GeneratedOrderHistoryEntry, GeneratedOrderModificationRecord, GeneratedOrderModificationRecordEntry, GeneratedPackagingInfo, GeneratedParserProperty, GeneratedPatchExecution, GeneratedPatchExecutionUnit, GeneratedPaymentInfo, GeneratedPaymentMode, GeneratedPaymentSubscriptionResult, GeneratedPaymentTransaction, GeneratedPaymentTransactionEntry, GeneratedPDTRow, GeneratedPointOfService, GeneratedPreviewData, GeneratedPreviewTicket, GeneratedPrincipal, GeneratedProcessTaskLog, GeneratedProduct, GeneratedProductConfiguration, GeneratedProductEntitlement, GeneratedProductFeature, GeneratedProductForPromotionSourceRule, GeneratedProductInterest, GeneratedProductOrderLimit, GeneratedProductReference, GeneratedProductTaxCode, GeneratedPromotionActionParameter, GeneratedPromotionGroup, GeneratedPromotionOrderEntryConsumed, GeneratedPromotionPriceRow, GeneratedPromotionQuantityAndPricesRow, GeneratedPromotionResult, GeneratedPunchOutCredential, GeneratedRenderersProperty, GeneratedRendererTemplate, GeneratedRestockConfig, GeneratedRestriction, GeneratedReturnEntry, GeneratedReturnRequest, GeneratedRuleActionDefinition, GeneratedRuleActionDefinitionCategory, GeneratedRuleActionDefinitionParameter, GeneratedRuleActionDefinitionRuleTypeMapping, GeneratedRuleConditionDefinition, GeneratedRuleConditionDefinitionCategory, GeneratedRuleConditionDefinitionParameter, GeneratedRuleConditionDefinitionRuleTypeMapping, GeneratedRuleGroup, GeneratedRuleToEngineRuleTypeMapping, GeneratedSamlUserGroup, GeneratedSavedQuery, GeneratedSavedValueEntry, GeneratedSavedValues, GeneratedSessionEvent, GeneratedSiteMapConfig, GeneratedSiteMapLanguageCurrency, GeneratedSiteMapPage, GeneratedSiteMessage, GeneratedSiteMessageForCustomer, GeneratedSnField, GeneratedSnIndex, GeneratedSnIndexConfiguration, GeneratedSnIndexerItemSourceOperation, GeneratedSnIndexerOperation, GeneratedSnIndexType, GeneratedSnSynonymDictionary, GeneratedSnSynonymEntry, GeneratedSolrAbstractKeywordRedirect, GeneratedSolrEndpointUrl, GeneratedSolrFacetSearchConfig, GeneratedSolrFacetSearchKeywordRedirect, GeneratedSolrIndex, GeneratedSolrIndexConfig, GeneratedSolrIndexedCoresRecord, GeneratedSolrIndexedProperty, GeneratedSolrIndexedType, GeneratedSolrIndexerQuery, GeneratedSolrIndexerQueryParameter, GeneratedSolrIndexOperation, GeneratedSolrIndexOperationRecord, GeneratedSolrModifiedItem, GeneratedSolrQueryAggregatedStats, GeneratedSolrSearchConfig, GeneratedSolrSearchQueryProperty, GeneratedSolrSearchQuerySort, GeneratedSolrSearchQueryTemplate, GeneratedSolrServerConfig, GeneratedSolrSort, GeneratedSolrSortField, GeneratedSolrStopWord, GeneratedSolrSynonymConfig, GeneratedSolrValueRange, GeneratedSolrValueRangeSet, GeneratedSourcingBan, GeneratedSourcingConfig, GeneratedStandardPaymentModeValue, GeneratedStep, GeneratedStockLevel, GeneratedStockLevelHistoryEntry, GeneratedStockLevelReservationHistoryEntry, GeneratedStoredHttpSession, GeneratedStoredPunchOutSession, GeneratedStoreLocatorFeature, GeneratedStreamConfiguration, GeneratedStreamConfigurationContainer, GeneratedSubscription, GeneratedSubscriptionTerm, GeneratedSyncAttributeDescriptorConfig, GeneratedSystemSetupAudit, GeneratedTask, GeneratedTaskCondition, GeneratedTax, GeneratedTaxInvoice, GeneratedTheme, GeneratedTitle, GeneratedTrigger, GeneratedUnit, GeneratedUsageCharge, GeneratedUsageUnit, GeneratedUserProfile, GeneratedUserRight, GeneratedVendor, GeneratedVoucherInvalidation, GeneratedWarehouse, GeneratedWarehouseBin, GeneratedWarehouseBinEntry, GeneratedWarehouseTransfer, GeneratedWarehouseTransferEntry, GeneratedWherePart, GeneratedWidgetParameter, GeneratedWidgetPreferences, GeneratedWishlist2, GeneratedWishlist2Entry, GeneratedWorkflowActionComment, GeneratedWorkflowItemAttachment, GeneratedY2YColumnDefintion, GeneratedYFormData, GeneratedYFormDataHistory, GeneratedYFormDefinition, GeneratedZone, GeneratedZoneDeliveryModeValue, OAuthAccessToken, OAuthAuthorizationCode, OAuthClientDetails, OAuthRefreshToken, OpenIDExternalScopes, OutboundChannelConfiguration, OutboundSyncRetry, WebhookConfiguration, WebhookPayload
public class GenericItem extends LocalizableItem
This class represents a generic item.

The default implementation of getInitialProperties(JaloSession, Item.ItemAttributeMap) collects all initial properties (localized and unlocalized ones) by itself, now And the corresponding implementation of getInitialProperties(JaloSession, Item.ItemAttributeMap) assures that this 'initial' properties will be removed from the 'non initial map'.

See Also:

  • Constructor Details

    • GenericItem

      public GenericItem()

  • Method Details

    • getImplementation

      public GenericItem.GenericItemImpl getImplementation()
      Description copied from class: BridgeAbstraction
      returns the implementation object of this jalo bridge abstraction
      Overrides:
      getImplementation in class ExtensibleItem
      Returns:
      the implementation object of this jalo bridge abstraction

    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example: 

      
 public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
 ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
 man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
 // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
 SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
 super.getNonInitialAttributes( ctx, allAttributes );
 // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      Specified by:
      createItem in class Item
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked

    • getInitialProperties

      protected JaloPropertyContainer getInitialProperties(JaloSession jaloSession, Item.ItemAttributeMap allAttributes)
      Override to specify all properties which should be written during ejbCreate. This way is is possible to implement non-null property fields ( means property fields which are written in SQL INSERT ). Properties which are set via Item.setNonInitialAttributes(SessionContext, Item, Item.ItemAttributeMap) are usually written by additional SQL UPDATE statements. 
       protected JaloPropertyContainer getInitialProperties(ItemAttributeMap allAttributes)
 {
        JaloPropertyContainer cont = jaloSession.createPropertyContainer();
        cont.setProperty("key", (Serializable) allAttributes.get("myKey"));
        return cont;
 }

      The default implementation collects all initial properties (localized and unlocalized ones), which were registered by calling allAttributes.setAttributeMode( MYPROPERTY, Item.AttributeMode.INITIAL ); inside MyType#createItem( SessionContext , ComposedType , Item.ItemAttributeMap ).

      Parameters:
      jaloSession - the jalo session which the new item is create within
      allAttributes - the attribute values of the new item

    • getNonInitialAttributes

      protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes)
      The default implementation of getNonInitialAttributes(SessionContext, Item.ItemAttributeMap) assures that the 'registered initial' properties getInitialProperties(JaloSession, Item.ItemAttributeMap) will be removed from the 'non initial map'.
      Overrides:
      getNonInitialAttributes in class Item
      Parameters:
      ctx - session context with language = NULL
      allAttributes - a ItemAttributeMap contaning attribute values.
      Returns:
      a ItemAttributeMap containing all attribute values, which belong to non-initial attributes.

    • getRelatedItems

      public <T extends Item> Collection<T> getRelatedItems(String relationQualifier)
      Description copied from class: Item
      Internal method to directly return related items linked by the One To Many relation. Its purpose is to allow the underlying persistence to intercept this call and handle it in a more efficient way.
      Overrides:
      getRelatedItems in class Item
      Parameters:
      relationQualifier - name of the attribute seen from the One end of the relation.
      Returns:
      the collection of related items or null if direct access is not supported by the underlying persistence layer.

    • getRelatedItems

      public <T extends Item> Collection<T> getRelatedItems(RelationsInfo relationsInfo)
      Description copied from class: Item
      Internal method to directly return related items linked by the One To Many relation. Its purpose is to allow the underlying persistence to intercept this call and handle it in a more efficient way.
      Overrides:
      getRelatedItems in class Item
      Parameters:
      relationsInfo - consists of relation-related objects
      Returns:
      the collection of related items or null if direct access is not supported by the underlying persistence layer.

    • setRelatedItems

      public <T extends Item> boolean setRelatedItems(String relationQualifier, Collection<T> values)
      Description copied from class: Item
      Internal method to directly set related items linked by the One To Many relation. Its purpose is to allow the underlying persistence to intercept this call and handle it in a more efficient way.
      Overrides:
      setRelatedItems in class Item
      Parameters:
      relationQualifier - name of the attribute seen from the One end of the relation.
      values - collection of Items to be set.
      Returns:
      false if operation is not supported by the underlying persistence layer.