CustomDataManager Interface
- public interface CustomDataManager
extends CatalogService
Service interface for managing the custom attributes of Product Catalog items.
Related Topics
CustomDataManagerHome
CustomDataManagerImpl
CatalogManager
CatalogItem
-
All Superinterfaces
-
BusinessSmartComponent
, CatalogService
, EJBObject
, Remote
, Serializable
, Session
public long |
-
createUniqueId (CatalogRequest request, String jndiHomeName, String pkString)
- Create a record for a new ConfigurableEntity, as identified by
the given jndiHomeName and pkString.
|
public Map |
-
getProperties (CatalogRequest request, CatalogItemKey itemKey, String namespace)
- Retrieve all the property values within a namespace
|
public Map |
-
getProperties (CatalogRequest request, CatalogItemKey itemKey)
- Retrieve all the property values
|
public Object |
-
getProperty (CatalogRequest request, CatalogItemKey itemKey, String namespace, String key, Object defaultValue)
- Retrieve the value associated with the named key.
|
public Object |
-
getProperty (CatalogRequest request, CatalogItemKey itemKey, String propertySetName, String propertySetType, String key, boolean returnDefault)
- Retrieve the value associated with the named key.
|
public void |
-
removeProperties (CatalogRequest request, CatalogItemKey itemKey)
- Remove all the properties for an item
|
public Object |
-
removeProperty (CatalogRequest request, CatalogItemKey itemKey, String namespace, String key)
- Remove the property associated with the named key.
|
public Object |
-
removeProperty (CatalogRequest request, CatalogItemKey itemKey, String propertySetName, String propertySetType, String key)
- Remove the property associated with the named key.
|
public void |
-
setProperty (CatalogRequest request, CatalogItemKey itemKey, String namespace, String key, Object value)
- Associate the specified value with the named key.
|
public void |
-
setProperty (CatalogRequest request, CatalogItemKey itemKey, String propertySetName, String propertySetType, String key, Object value)
- Associate the specified value with the named key.
|
createUniqueId(CatalogRequest, String, String) Method
public long createUniqueId(CatalogRequest
request,
String
jndiHomeName,
String
pkString)
throws RemoteException
, CatalogException
Create a record for a new ConfigurableEntity, as identified by
the given jndiHomeName and pkString.
Parameters
-
request
- The catalog request.
-
jndiHomeName
- the entity's home name
-
pkString
- the entity's identifier string
Returns
- the newly created entity id
Exceptions
-
RemoteException
-
CatalogException
- if there is an error
getProperties(CatalogRequest, CatalogItemKey, String) Method
public Map
getProperties(CatalogRequest
request,
CatalogItemKey
itemKey,
String
namespace)
throws RemoteException
, CatalogException
Retrieve all the property values within a namespace
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
namespace
- The name of the property to retrieve.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
getProperties(CatalogRequest, CatalogItemKey) Method
public Map
getProperties(CatalogRequest
request,
CatalogItemKey
itemKey)
throws RemoteException
, CatalogException
Retrieve all the property values
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
getProperty(CatalogRequest, CatalogItemKey, String, String, Object) Method
public Object
getProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
namespace,
String
key,
Object
defaultValue)
throws RemoteException
, CatalogException
Retrieve the value associated with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
namespace
- The name of the property to retrieve.
-
key
- The value to return if that property is not set.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
getProperty(CatalogRequest, CatalogItemKey, String, String, String, boolean) Method
public Object
getProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
propertySetName,
String
propertySetType,
String
key,
boolean returnDefault)
throws CatalogException
, RemoteException
Retrieve the value associated with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
propertySetName
- The name of the property to retrieve.
-
propertySetType
- The value to return if that property is not set.
Exceptions
-
CatalogException
- on general error.
-
RemoteException
removeProperties(CatalogRequest, CatalogItemKey) Method
public void removeProperties(CatalogRequest
request,
CatalogItemKey
itemKey)
throws RemoteException
, CatalogException
Remove all the properties for an item
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
removeProperty(CatalogRequest, CatalogItemKey, String, String) Method
public Object
removeProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
namespace,
String
key)
throws RemoteException
, CatalogException
Remove the property associated with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
namespace
- The name of the property to remove.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
removeProperty(CatalogRequest, CatalogItemKey, String, String, String) Method
public Object
removeProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
propertySetName,
String
propertySetType,
String
key)
throws CatalogException
, RemoteException
Remove the property associated with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
propertySetName
- The name of the property to remove.
Exceptions
-
CatalogException
- on general error.
-
RemoteException
setProperty(CatalogRequest, CatalogItemKey, String, String, Object) Method
public void setProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
namespace,
String
key,
Object
value)
throws RemoteException
, CatalogException
Associate the specified value with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
namespace
- The name to associate the value with.
-
key
- The value to associate with the name.
Exceptions
-
RemoteException
-
CatalogException
- on general error.
setProperty(CatalogRequest, CatalogItemKey, String, String, String, Object) Method
public void setProperty(CatalogRequest
request,
CatalogItemKey
itemKey,
String
propertySetName,
String
propertySetType,
String
key,
Object
value)
throws RemoteException
, CatalogException
Associate the specified value with the named key.
Parameters
-
request
- The catalog request.
-
itemKey
- The key of the target catalog item.
-
propertySetName
- The name to associate the value with.
-
propertySetType
- The value to associate with the name.
Exceptions
-
RemoteException
-
CatalogException
- on general error.