CatalogItemImpl Class

com.beasys.commerce.ebusiness.catalog
CatalogItemImpl Class

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

Hierarchy
Object
  CatalogItemImpl
All Implemented Interfaces

CatalogItem, ConfigurableEntity, Serializable
Direct Known Subclasses

CategoryImpl, ProductItemImpl

Field Summary
protected MutableCatalogItem
delegateItem
MutableCatalogItem
 

Method Summary
public void
addBusinessPolicy(String policyKey, BusinessPolicy businessPolicy)
Add a new business policy to the object with the specified key
public void
addPropertyValue(String scopeName, String key, Object propertyValue)
Add the specified property value to the collection of values associated with the named key for the specified scope.
public void
addPropertyValueMapped(String scopeName, String propertyKey, String mappedKey, Object propertyValue)
Add the specified property value to the map object associated with the named key for the specified scope.
public BusinessPolicy
getBusinessPolicy(String policyKey)
Retrieve the business policy with the specified key.
public String
getContributor()
Get the contributor for this catalog item
public String
getCoverage()
Get the coverage for this catalog item
public Date
getCreationDate()
Get the creation date for this catalog item
public String
getCreator()
Get the creator for this catalog item
public String
getDescription(int index)
Get the description for this catalog item
public ImageInfo
getImage(int index)
Get an Image for this catalog item
public String
getJndiName()
Retrieve the jndi name for an entity.
public CatalogItemKey
getKey()
Get the primary key for this catalog item
public String
getLanguage()
Get the language for this catalog item
public Date
getModifiedDate()
Get the modified date for this catalog item
public String
getName()
Get the name for this catalog item
public String
getPkString()
Retrieve the pk string for an entity.
public Object
getProperty(String key, Object defaultValue)
Retrieve the value associated with the named key in the default scope.
public Object
getProperty(String scopeName, String key, ConfigurableEntity successor, Object defaultValue)
Retrieve the value associated with the named key in the specified scope.
public Object
getProperty(String propertySet, String propertyName)
Retrieve the value that was persisted for this entity for the given property, within the given property set.
public String
getPropertyAsString(String scopeName, String key, ConfigurableEntity successor, String defaultValue)
Retrieve the String value of the property associated the named key in the specified scope.
public String
getPropertyAsString(String propertySet, String propertyName)
Convenience method to return a property as a String.
public Object
getPropertyDefault(String scopeName, String key, ConfigurableEntity successor)
Retrieve the default value from the Schema for the named key and the specified scope.
public Object
getPropertyNoDefault(String scopeName, String key, ConfigurableEntity successor)
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.
public 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.
public String
getPublisher()
Get the publisher for this catalog item
public String
getRelation()
Get the relation for this catalog item
public String
getRights()
Get the rights for this catalog item
public String
getSource()
Get the source for this catalog item
public ConfigurableEntity
getSuccessor(String scopeName)
Retrieve the successor associated with this ConfigurableEntity for the specified scope.
public long
getUniqueId()
Retrieve the unique identifier generated for this ConfigurableEntity.
public BusinessPolicy
removeBusinessPolicy(String policyKey)
Remove the business policy with the specified key.
public Object
removeProperty(String key)
Remove the property associated with the named key in the default scope.
public Object
removeProperty(String propertySet, String propertyName)
Remove the property associated with the named key in the specified property set.
public Object
removePropertyValue(String scopeName, String key, Object propertyValue)
Remove the property value object from the collection associated with the named key in the specified scope.
public Object
removePropertyValueMapped(String scopeName, String propertyKey, String mappedKey)
Remove the property value object from the map associated with the named key in the specified scope.
public ConfigurableEntity
removeSuccessor(String scopeName)
Remove the successor for the specified scope.
public void
setProperty(String key, Object value)
Associate the specified value with the named key in the default scope.
public void
setProperty(String propertySet, String propertyName, Object value)
Associate the specified value with the named key in the specified property set.
public void
setSuccessor(String scopeName, ConfigurableEntity successor)
Set the successor for the specified scope.
public String
toString()
Builds a string representation of this object.
 
Methods from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
   
Methods from interface com.beasys.commerce.ebusiness.catalog.CatalogItem
getContributor, getCoverage, getCreationDate, getCreator, getDescription, getImage, getKey, getLanguage, getModifiedDate, getName, getPublisher, getRelation, getRights, getSource
 
Methods from interface com.bea.p13n.property.ConfigurableEntity
getJndiName, getPkString, getProperty, getPropertyAsString, getPropertyNoDefault, getUniqueId, removeProperty, setProperty
 

Field Detail

delegateItem

protected MutableCatalogItem delegateItem

 

Method Detail

addBusinessPolicy(String, BusinessPolicy) Method

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

public void addBusinessPolicy(String policyKey, 
                              BusinessPolicy businessPolicy)
     throws SystemException, RemoteException
Add a new business policy to the object with the specified key

Exceptions

SystemException
RemoteException

addPropertyValue(String, String, Object) Method

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

public void addPropertyValue(String scopeName, 
                             String key, 
                             Object propertyValue)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

addPropertyValueMapped(String, String, String, Object) Method

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

public void addPropertyValueMapped(String scopeName, 
                                   String propertyKey, 
                                   String mappedKey, 
                                   Object propertyValue)
     throws SystemException, RemoteException
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.
propertyKey
The name to associate the map object with.
mappedKey
The map key to associate the value in the map.
propertyValue
The value put in the map for the map key.

Exceptions

SystemException
RemoteException

getBusinessPolicy(String) Method

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

public BusinessPolicy getBusinessPolicy(String policyKey)
     throws SystemException, RemoteException
Retrieve the business policy with the specified key.

Exceptions

SystemException
RemoteException

getContributor() Method

public String getContributor()
Get the contributor for this catalog item

Returns

the new contributor for the item

getCoverage() Method

public String getCoverage()
Get the coverage for this catalog item

Returns

the coverage for the item

getCreationDate() Method

public Date getCreationDate()
Get the creation date for this catalog item

Returns

the creation date for the item

getCreator() Method

public String getCreator()
Get the creator for this catalog item

Returns

the creator for the item

getDescription(int) Method

public String getDescription(int index)
Get the description for this catalog item

Parameters

index
the description to retrive, either CatalogItem.SHORT_DESCRIPTION_INDEX or CatalogItem.LONG_DESCRIPTION_INDEX

Returns

the description for the item

getImage(int) Method

public ImageInfo getImage(int index)
Get an Image for this catalog item

Parameters

index
the image to retrive, either SMALL_IMAGE_INDEX or LARGE_IMAGE_INDEX

Returns

an ImageInfo object for the image

getJndiName() Method

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

public String getJndiName()
     throws RemoteException
Retrieve the jndi name for an entity. A combination of pk string and jndi name is always unique between entities.

Returns

the jndi name for this entity

Exceptions

RemoteException

getKey() Method

public CatalogItemKey getKey()
Get the primary key for this catalog item

Returns

the primary key for the item

getLanguage() Method

public String getLanguage()
Get the language for this catalog item

Returns

the language for the item

getModifiedDate() Method

public Date getModifiedDate()
Get the modified date for this catalog item

Returns

the modified date for the item

getName() Method

public String getName()
Get the name for this catalog item

Returns

the name for the item

getPkString() Method

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.

Returns

the primary key string identifier for this entity

Exceptions

RemoteException

getProperty(String, Object) Method

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

public Object getProperty(String key, 
                          Object defaultValue)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.getProperty(String, String)

getProperty(String, String, ConfigurableEntity, Object) Method

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

public Object getProperty(String scopeName, 
                          String key, 
                          ConfigurableEntity successor, 
                          Object defaultValue)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.getProperty(String, String)

getProperty(String, String) Method

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.

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

Exceptions

RemoteException

getPropertyAsString(String, String, ConfigurableEntity, String) Method

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

public String getPropertyAsString(String scopeName, 
                                  String key, 
                                  ConfigurableEntity successor, 
                                  String defaultValue)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.getPropertyAsString(String, String)
ConfigurableEntity.getProperty(String, String)

getPropertyAsString(String, String) Method

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)

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

Exceptions

RemoteException

getPropertyDefault(String, String, ConfigurableEntity) Method

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

public Object getPropertyDefault(String scopeName, 
                                 String key, 
                                 ConfigurableEntity successor)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

getPropertyNoDefault(String, String, ConfigurableEntity) Method

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

public Object getPropertyNoDefault(String scopeName, 
                                   String key, 
                                   ConfigurableEntity successor)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.getPropertyNoDefault(String, String)

getPropertyNoDefault(String, String) Method

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.

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

Exceptions

RemoteException

getPublisher() Method

public String getPublisher()
Get the publisher for this catalog item

Returns

the publisher for the item

getRelation() Method

public String getRelation()
Get the relation for this catalog item

Returns

the relation for the item

getRights() Method

public String getRights()
Get the rights for this catalog item

Returns

the rights for the item

getSource() Method

public String getSource()
Get the source for this catalog item

Returns

the source for the item

getSuccessor(String) Method

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

public ConfigurableEntity getSuccessor(String scopeName)
     throws SystemException, RemoteException
Retrieve the successor associated with this ConfigurableEntity for the specified scope.

Parameters

scopeName
The name of the scope.

Exceptions

SystemException
RemoteException

getUniqueId() Method

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.

Returns

this entity's unique id

Exceptions

RemoteException

removeBusinessPolicy(String) Method

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

public BusinessPolicy removeBusinessPolicy(String policyKey)
     throws SystemException, RemoteException
Remove the business policy with the specified key.

Exceptions

SystemException
RemoteException

removeProperty(String) Method

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

public Object removeProperty(String key)
     throws SystemException, RemoteException
Remove the property associated with the named key in the default scope.

Parameters

key
The name of the property to remove.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.removeProperty(String, String)

removeProperty(String, String) Method

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)

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.

Exceptions

RemoteException

removePropertyValue(String, String, Object) Method

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

public Object removePropertyValue(String scopeName, 
                                  String key, 
                                  Object propertyValue)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

removePropertyValueMapped(String, String, String) Method

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

public Object removePropertyValueMapped(String scopeName, 
                                        String propertyKey, 
                                        String mappedKey)
     throws SystemException, RemoteException
Remove the property value object from the map associated with the named key in the specified scope.

Parameters

scopeName
The name of the scope.
propertyKey
The name of the property that is associated with the map.
mappedKey
The map key of the object to remove from the map.

Exceptions

SystemException
RemoteException

removeSuccessor(String) Method

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

public ConfigurableEntity removeSuccessor(String scopeName)
     throws RemoteException
Remove the successor for the specified scope.

Parameters

scopeName
The name of the scope.

Exceptions

RemoteException

setProperty(String, Object) Method

DEPRECATED This method has been deprecated.

public void setProperty(String key, 
                        Object value)
     throws SystemException, RemoteException
Associate the specified value with the named key in the default scope.

Parameters

key
The name to associate the value with.
value
The value to associate with the name.

Exceptions

SystemException
RemoteException

Related Topics

CatalogItemImpl.setProperty(String, String, Object)

setProperty(String, String, Object) Method

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)

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

Exceptions

PropertyValidationException
If the property value does not match the PropertyDefinition for this property set
RemoteException

setSuccessor(String, ConfigurableEntity) Method

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

public void setSuccessor(String scopeName, 
                         ConfigurableEntity successor)
     throws SystemException, RemoteException
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.

Exceptions

SystemException
RemoteException

toString() Method

public String toString()
Builds a string representation of this object.

Overrides
Object.toString()

Returns

the string