Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.beasys.commerce.ebusiness.catalog
Class CatalogItemImpl

    java.lang.Object
      com.beasys.commerce.ebusiness.catalog.CatalogItemImpl

All Implemented Interfaces:
  CatalogItem, ConfigurableEntity, Serializable

Direct Known Subclasses:
  CategoryImpl, ProductItemImpl

public class CatalogItemImpl
extends Object
implements CatalogItem

This is the implementation class for all items contained by the Catalog. This class exposes data accessors for item data conforming to the Dublin Core Metadata. Refer to the DCM spec for details. Dublin Core Element Set

See Also:
  Serialized Form

Field Summary
`protected MutableCatalogItem` | `delegateItem`

Fields inherited from interface com.beasys.commerce.ebusiness.catalog.CatalogItem
`LARGE_IMAGE_INDEX, LONG_DESCRIPTION_INDEX, MAX_DESCRIPTION, MAX_IMAGES, SHORT_DESCRIPTION_INDEX, SMALL_IMAGE_INDEX`

Fields inherited from interface com.bea.p13n.property.ConfigurableEntity
`RESERVED_PROPERTY_SET`

Method Summary
`void` | `addBusinessPolicy(String policyKey, BusinessPolicy businessPolicy)` Deprecated. This method has been deprecated and now performs no operation.
`void` | `addPropertyValue(String scopeName, String key, Object propertyValue)` Deprecated. This method has been deprecated and now performs no operation. This functionality is now provided only through the EBCC.
`void` | `addPropertyValueMapped(String scopeName, String propertyKey, String mappedKey, Object propertyValue)` Deprecated. This method has been deprecated and now performs no operation.
`BusinessPolicy` | `getBusinessPolicy(String policyKey)` Deprecated. This method has been deprecated and will now return a null.
`String` | `getContributor()` Get the contributor for this catalog item
`String` | `getCoverage()` Get the coverage for this catalog item
`Date` | `getCreationDate()` Get the creation date for this catalog item
`String` | `getCreator()` Get the creator for this catalog item
`String` | `getDescription(int index)` Get the description for this catalog item
`ImageInfo` | `getImage(int index)` Get an Image for this catalog item
`String` | `getJndiName()` Deprecated. This method has been deprecated and will now return a null.
`CatalogItemKey` | `getKey()` Get the primary key for this catalog item
`String` | `getLanguage()` Get the language for this catalog item
`Date` | `getModifiedDate()` Get the modified date for this catalog item
`String` | `getName()` Get the name for this catalog item
`String` | `getPkString()` Retrieve the pk string for an entity.
`Object` | `getProperty(String key, Object defaultValue)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `getProperty(String propertySet, String propertyName)` Retrieve the value that was persisted for this entity for the given property, within the given property set.
`Object` | `getProperty(String scopeName, String key, ConfigurableEntity successor, Object defaultValue)` Deprecated. This method has been deprecated and will now return a null.
`String` | `getPropertyAsString(String propertySet, String propertyName)` Convenience method to return a property as a String.
`String` | `getPropertyAsString(String scopeName, String key, ConfigurableEntity successor, String defaultValue)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `getPropertyDefault(String scopeName, String key, ConfigurableEntity successor)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `getPropertyNoDefault(String propertySet, String propertyName)` Retrieve the value associated with the named key in the specified property set, but does not return a default value from the property's PropertyDefinition if a value was not persisted for this entity.
`Object` | `getPropertyNoDefault(String scopeName, String key, ConfigurableEntity successor)` Deprecated. This method has been deprecated and will now return a null.
`String` | `getPublisher()` Get the publisher for this catalog item
`String` | `getRelation()` Get the relation for this catalog item
`String` | `getRights()` Get the rights for this catalog item
`String` | `getSource()` Get the source for this catalog item
`ConfigurableEntity` | `getSuccessor(String scopeName)` Deprecated. This method has been deprecated and will now return a null.
`long` | `getUniqueId()` Retrieve the unique identifier generated for this ConfigurableEntity.
`BusinessPolicy` | `removeBusinessPolicy(String policyKey)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `removeProperty(String key)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `removeProperty(String propertySet, String propertyName)` Remove the property associated with the named key in the specified property set.
`Object` | `removePropertyValue(String scopeName, String key, Object propertyValue)` Deprecated. This method has been deprecated and will now return a null.
`Object` | `removePropertyValueMapped(String scopeName, String propertyKey, String mappedKey)` Deprecated. This method has been deprecated and will now return a null.
`ConfigurableEntity` | `removeSuccessor(String scopeName)` Deprecated. This method has been deprecated and will now return a null.
`void` | `setProperty(String key, Object value)` Deprecated. This method has been deprecated.
`void` | `setProperty(String propertySet, String propertyName, Object value)` Associate the specified value with the named key in the specified property set.
`void` | `setSuccessor(String scopeName, ConfigurableEntity successor)` Deprecated. This method has been deprecated and now performs no operation.
`String` | `toString()` Builds a string representation of this object.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

### delegateItem

    protected MutableCatalogItem delegateItem

Method Detail

### getKey

    public CatalogItemKey getKey()

  Get the primary key for this catalog item

  Specified by:
    `getKey` in interface `CatalogItem`
  Returns:
    the primary key for the item
  See Also:
    `CatalogItemKey`

### getName

    public String getName()

  Get the name for this catalog item

  Specified by:
    `getName` in interface `CatalogItem`
  Returns:
    the name for the item

### getDescription

    public String getDescription(int index)

  Get the description for this catalog item

  Specified by:
    `getDescription` in interface `CatalogItem`
  Parameters:
    `index` - the description to retrive, either CatalogItem.SHORT_DESCRIPTION_INDEX or CatalogItem.LONG_DESCRIPTION_INDEX
  Returns:
    the description for the item

### getCreator

    public String getCreator()

  Get the creator for this catalog item

  Specified by:
    `getCreator` in interface `CatalogItem`
  Returns:
    the creator for the item

### getPublisher

    public String getPublisher()

  Get the publisher for this catalog item

  Specified by:
    `getPublisher` in interface `CatalogItem`
  Returns:
    the publisher for the item

### getContributor

    public String getContributor()

  Get the contributor for this catalog item

  Specified by:
    `getContributor` in interface `CatalogItem`
  Returns:
    the new contributor for the item

### getCreationDate

    public Date getCreationDate()

  Get the creation date for this catalog item

  Specified by:
    `getCreationDate` in interface `CatalogItem`
  Returns:
    the creation date for the item

### getSource

    public String getSource()

  Get the source for this catalog item

  Specified by:
    `getSource` in interface `CatalogItem`
  Returns:
    the source for the item

### getLanguage

    public String getLanguage()

  Get the language for this catalog item

  Specified by:
    `getLanguage` in interface `CatalogItem`
  Returns:
    the language for the item

### getRelation

    public String getRelation()

  Get the relation for this catalog item

  Specified by:
    `getRelation` in interface `CatalogItem`
  Returns:
    the relation for the item

### getCoverage

    public String getCoverage()

  Get the coverage for this catalog item

  Specified by:
    `getCoverage` in interface `CatalogItem`
  Returns:
    the coverage for the item

### getRights

    public String getRights()

  Get the rights for this catalog item

  Specified by:
    `getRights` in interface `CatalogItem`
  Returns:
    the rights for the item

### getImage

    public ImageInfo getImage(int index)

  Get an Image for this catalog item

  Specified by:
    `getImage` in interface `CatalogItem`
  Parameters:
    `index` - the image to retrive, either SMALL_IMAGE_INDEX or LARGE_IMAGE_INDEX
  Returns:
    an ImageInfo object for the image

### getModifiedDate

    public Date getModifiedDate()

  Get the modified date for this catalog item

  Specified by:
    `getModifiedDate` in interface `CatalogItem`
  Returns:
    the modified date for the item

### toString

    public String toString()

  Builds a string representation of this object.

  Returns:
    the string

### addPropertyValue

    public void addPropertyValue(String scopeName,
                                 String key,
                                 Object propertyValue)
                          throws SystemException,
                                 RemoteException

  Deprecated. This method has been deprecated and now performs no operation. This functionality is now provided only through the EBCC.

  Add the specified property value to the collection of values associated with the named key for the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name to associate the collection of values with.
    `propertyValue` - The value to associate with the key and scope.
  Throws:
    `SystemException`
    `RemoteException`

### addPropertyValueMapped

    public void addPropertyValueMapped(String scopeName,
                                       String propertyKey,
                                       String mappedKey,
                                       Object propertyValue)
                                throws SystemException,
                                       RemoteException

  Deprecated. This method has been deprecated and now performs no operation.

  Add the specified property value to the map object associated with the named key for the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
    `propertyValue` - The value put in the map for the map key.
  Throws:
    `SystemException`
    `RemoteException`

### getProperty

    public Object getProperty(String key,
                              Object defaultValue)
                       throws SystemException,
                              RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the value associated with the named key in the default scope. If the entity does not have the property defined, the property will be searched in the successor hiearchy for the default scope. If the property could not be found in the successor chain, a lookup for the default value defined for the PropertyMetaData in the Schema is returned. The Schema is retrieved using the SchemaGroupName environment property defined for the bean. If the property meta data is not available (or there is no Schema defined) then the specified default value is returned.

  Parameters:
    `key` - The name of the property to retrieve.
    `defaultValue` - The value to return if that property is not set and there is not default value found in the Schema.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `getProperty(String, String)`

### getProperty

    public Object getProperty(String scopeName,
                              String key,
                              ConfigurableEntity successor,
                              Object defaultValue)
                       throws SystemException,
                              RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the value associated with the named key in the specified scope. If the entity does not have the property defined for the specified scope, the property will be searched in the successor hiearchy using the explicit successor first and then the successor for the specified scope. If the could not be found in the successors hiearchy, a lookup for default value defined for the PropertyMetaData in the Schema is returned. The Schema is retrieved using the SchemaGroupName environment property defined for the bean. If the property meta data is not available (or there is no Schema defined) then the specified default value is returned.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name of the property to retrieve.
    `successor` - The explicit successor to use for sucessor hiearchy search if the entity does not have the property defined.
    `defaultValue` - The value to return if that property is not set.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `getProperty(String, String)`

### getPropertyAsString

    public String getPropertyAsString(String scopeName,
                                      String key,
                                      ConfigurableEntity successor,
                                      String defaultValue)
                               throws SystemException,
                                      RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the String value of the property associated the named key in the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name of the property to retrieve.
    `successor` - The explicit successor to use for sucessor hiearchy search if the entity does not have the property defined.
    `defaultValue` - The String to return if that property is not set.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `getPropertyAsString(String, String)`, `ConfigurableEntity.getProperty(java.lang.String, java.lang.String)`

### getPropertyDefault

    public Object getPropertyDefault(String scopeName,
                                     String key,
                                     ConfigurableEntity successor)
                              throws SystemException,
                                     RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the default value from the Schema for the named key and the specified scope. This method is used by the implementation of the getProperty methods for retrieving the default value for a property from the successor hierarchy.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name of the property to retrieve.
    `successor` - The explicit successor to use for sucessor hiearchy search if the entity does not have the property defined.
  Throws:
    `SystemException`
    `RemoteException`

### getPropertyNoDefault

    public Object getPropertyNoDefault(String scopeName,
                                       String key,
                                       ConfigurableEntity successor)
                                throws SystemException,
                                       RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the value associated with the named key in the specified scope but does not return a default value if the property does not exist for the entity of in the hierarchy of successors. This method is used by the implementation of the getProperty methods so that the search in the successor hierarchy does not return a default value from the Schema.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name of the property to retrieve.
    `successor` - The explicit successor to use for sucessor hiearchy search if the entity does not have the property defined.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `getPropertyNoDefault(String, String)`

### getSuccessor

    public ConfigurableEntity getSuccessor(String scopeName)
                                    throws SystemException,
                                           RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the successor associated with this ConfigurableEntity for the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
  Throws:
    `SystemException`
    `RemoteException`

### removeProperty

    public Object removeProperty(String key)
                          throws SystemException,
                                 RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Remove the property associated with the named key in the default scope.

  Parameters:
    `key` - The name of the property to remove.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `removeProperty(String, String)`

### removePropertyValue

    public Object removePropertyValue(String scopeName,
                                      String key,
                                      Object propertyValue)
                               throws SystemException,
                                      RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Remove the property value object from the collection associated with the named key in the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
    `key` - The name of the property that is associated with the collection of values.
    `propertyValue` - The object to remove from the collection.
  Throws:
    `SystemException`
    `RemoteException`

### removePropertyValueMapped

    public Object removePropertyValueMapped(String scopeName,
                                            String propertyKey,
                                            String mappedKey)
                                     throws SystemException,
                                            RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Remove the property value object from the map associated with the named key in the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
  Throws:
    `SystemException`
    `RemoteException`

### removeSuccessor

    public ConfigurableEntity removeSuccessor(String scopeName)
                                       throws RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Remove the successor for the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
  Throws:
    `RemoteException`

### setProperty

    public void setProperty(String key,
                            Object value)
                     throws SystemException,
                            RemoteException

  Deprecated. This method has been deprecated.

  Associate the specified value with the named key in the default scope.

  Parameters:
    `value` - The value to associate with the name.
  Throws:
    `SystemException`
    `RemoteException`
  See Also:
    `setProperty(String, String, Object)`

### setSuccessor

    public void setSuccessor(String scopeName,
                             ConfigurableEntity successor)
                      throws SystemException,
                             RemoteException

  Deprecated. This method has been deprecated and now performs no operation.

  Set the successor for the specified scope.

  Parameters:
    `scopeName` - The name of the scope.
    `successor` - The scope-level successor used during the search of a property.
  Throws:
    `SystemException`
    `RemoteException`

### addBusinessPolicy

    public void addBusinessPolicy(String policyKey,
                                  BusinessPolicy businessPolicy)
                           throws SystemException,
                                  RemoteException

  Deprecated. This method has been deprecated and now performs no operation.

  Add a new business policy to the object with the specified key

  Throws:
    `SystemException`
    `RemoteException`

### getBusinessPolicy

    public BusinessPolicy getBusinessPolicy(String policyKey)
                                     throws SystemException,
                                            RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the business policy with the specified key.

  Throws:
    `SystemException`
    `RemoteException`

### removeBusinessPolicy

    public BusinessPolicy removeBusinessPolicy(String policyKey)
                                        throws SystemException,
                                               RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Remove the business policy with the specified key.

  Throws:
    `SystemException`
    `RemoteException`

### getProperty

    public Object getProperty(String propertySet,
                              String propertyName)
                       throws RemoteException

  Retrieve the value that was persisted for this entity for the given property, within the given property set. If the entity does not have a value persisted for this property, the default value from the property set will be returned.

  Specified by:
    `getProperty` in interface `ConfigurableEntity`
  Parameters:
    `propertySet` - The name of the property set to look in
    `propertyName` - The name of the property to retrieve.
  Returns:
    the value for this property, or null if all searches failed
  Throws:
    `RemoteException`

### getPropertyAsString

    public String getPropertyAsString(String propertySet,
                                      String propertyName)
                               throws RemoteException

  Convenience method to return a property as a String. This method now takes a property set name and property name as arguments as opposed to it's previous signature: getPropertyAsString(String key, String defaultValue)

  Specified by:
    `getPropertyAsString` in interface `ConfigurableEntity`
  Parameters:
    `propertySet` - The name of the property set to look in
    `propertyName` - The name of the property to retrieve.
  Returns:
    the value for this property as a String, or null if all searches failed
  Throws:
    `RemoteException`

### getPropertyNoDefault

    public Object getPropertyNoDefault(String propertySet,
                                       String propertyName)
                                throws RemoteException

  Retrieve the value associated with the named key in the specified property set, but does not return a default value from the property's PropertyDefinition if a value was not persisted for this entity. This method is used by the implementation of the getProperty methods so that the search in the successor hierarchy does not return a default value from the Schema.

  Specified by:
    `getPropertyNoDefault` in interface `ConfigurableEntity`
  Parameters:
    `propertySet` - The name of the property set
    `propertyName` - The name of the property to retrieve.
  Returns:
    the value for this property, or null if all searches failed
  Throws:
    `RemoteException`

### setProperty

    public void setProperty(String propertySet,
                            String propertyName,
                            Object value)
                     throws PropertyValidationException,
                            RemoteException

  Associate the specified value with the named key in the specified property set. This method now takes a property set name, property name and value as arguments as opposed to it's previous signature: setProperty(String scopeName, String key, Object property)

  Specified by:
    `setProperty` in interface `ConfigurableEntity`
  Parameters:
    `propertySet` - The name of the property set.
    `propertyName` - The name of the property to assign
    `value` - The value to associate with the property name
  Throws:
    `PropertyValidationException` - If the property value does not match the PropertyDefinition for this property set
    `RemoteException`

### removeProperty

    public Object removeProperty(String propertySet,
                                 String propertyName)
                          throws RemoteException

  Remove the property associated with the named key in the specified property set.

  NOTE: if an explicit setter method is found for this property, this method will set the value to null. This method now takes a property set name and property name as arguments as opposed to it's previous signature: removeProperty(String scopeName, String key)

  Specified by:
    `removeProperty` in interface `ConfigurableEntity`
  Parameters:
    `propertySet` - The name of the property set.
    `propertyName` - The name of the property to remove.
  Returns:
    the old value of the property, or null if there was none.
  Throws:
    `RemoteException`

### getUniqueId

    public long getUniqueId()
                     throws RemoteException

  Retrieve the unique identifier generated for this ConfigurableEntity. The unique identifier is used by the EntityPropertyManager to optimize the foreign keys in the persistent storage. This method may not be implemented in a lightweight implementation of ConfigurableEntity.

  Specified by:
    `getUniqueId` in interface `ConfigurableEntity`
  Returns:
    this entity's unique id
  Throws:
    `RemoteException`

### getPkString

    public String getPkString()
                       throws RemoteException

  Retrieve the pk string for an entity. A combination of pk string and jndi name is always unique between entities.

  Specified by:
    `getPkString` in interface `ConfigurableEntity`
  Returns:
    the primary key string identifier for this entity
  Throws:
    `RemoteException`

### getJndiName

    public String getJndiName()
                       throws RemoteException

  Deprecated. This method has been deprecated and will now return a null.

  Retrieve the jndi name for an entity. A combination of pk string and jndi name is always unique between entities.

  Specified by:
    `getJndiName` in interface `ConfigurableEntity`
  Returns:
    the jndi name for this entity
  Throws:
    `RemoteException`

Overview | Package | Class | Tree | Deprecated | Index | Help
| © 2004 BEA Systems, Inc.
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2004 BEA Systems, Inc. All Rights Reserved