© 2002 BEA Systems, Inc.


com.bea.commerce.ebusiness.customer
Interface CustomerPropertyManager


public interface CustomerPropertyManager
extends EntityPropertyManager

Manages properties associated with Customer. Implemented as a stateless session bean. Delegates calls to the CustomerEJB.

Handles property sets for "CustomerProperties". This mapping can be found in usermgmt-ejb-jar.xml deployment descriptor.


Method Summary
 void createCustomer(java.lang.String customerName)
          Create a customer record with the given name.
 boolean customerExists(java.lang.String customerName)
          Determine if a customer exists
 void deleteCustomer(java.lang.String customerName)
          Remove a customer
 java.lang.Object getProperty(java.lang.String customerName, java.lang.String propertySet, java.lang.String propertyName)
          Returns the value of the property defined for the specified property and property set.
 java.lang.String getPropertyAsString(java.lang.String customerName, java.lang.String propertySet, java.lang.String propertyName)
          Get a property from the customer, converted to a String If the property is not found, the default value from the property set will be returned.
 java.lang.Object removeProperty(java.lang.String customerName, java.lang.String propertySet, java.lang.String propertyName)
          Remove a property from the customer
 void setProperty(java.lang.String customerName, java.lang.String propertySet, java.lang.String propertyName, java.lang.Object value)
          Set a property in the profile
 
Methods inherited from interface com.bea.p13n.property.EntityPropertyManager
createUniqueId, getDynamicProperties, getEntityNames, getHomeName, getProperties, getProperty, getPropertyLocator, getUniqueId, removeEntity, removeProperties, removeProperty, setProperty
 
Methods inherited from interface javax.ejb.EJBObject
getEJBHome, getHandle, getPrimaryKey, isIdentical, remove
 

Method Detail

getProperty

public java.lang.Object getProperty(java.lang.String customerName,
                                    java.lang.String propertySet,
                                    java.lang.String propertyName)
                             throws java.rmi.RemoteException,
                                    CustomerNotFoundException
Returns the value of the property defined for the specified property and property set.

If the property does not have a value persisted, then null is returned.

Parameters:
customerName - the name of the customer whose property we wish to retrieve
propertySet - the name of the property set
propertyName - the name of the property
Returns:
the property's value, or null if there is none
Throws:
CustomerNotFoundException - if the customer is not valid

getPropertyAsString

public java.lang.String getPropertyAsString(java.lang.String customerName,
                                            java.lang.String propertySet,
                                            java.lang.String propertyName)
                                     throws java.rmi.RemoteException,
                                            CustomerNotFoundException
Get a property from the customer, converted to a String If the property is not found, the default value from the property set will be returned.

Parameters:
profileName - the name of the profile to read
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
Returns:
the property's value as a String
Throws:
CustomerNotFoundException - if the customer is not valid

setProperty

public void setProperty(java.lang.String customerName,
                        java.lang.String propertySet,
                        java.lang.String propertyName,
                        java.lang.Object value)
                 throws PropertyValidationException,
                        CustomerNotFoundException,
                        java.rmi.RemoteException
Set a property in the profile

Parameters:
customerName - the name of the profile to modify
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
value - the new value for the property
Throws:
PropertyValidationException - if the new value is not valid
CustomerNotFoundException - if the customer is not valid

removeProperty

public java.lang.Object removeProperty(java.lang.String customerName,
                                       java.lang.String propertySet,
                                       java.lang.String propertyName)
                                throws java.rmi.RemoteException,
                                       CustomerNotFoundException
Remove a property from the customer

Parameters:
customerName - the name of the customer to modify
propertySet - the property set containing the property
propertyName - the name of the property to retrieve
Returns:
the old value of the property
Throws:
CustomerNotFoundException - if the customer is not valid

createCustomer

public void createCustomer(java.lang.String customerName)
                    throws java.rmi.RemoteException,
                           java.lang.Exception
Create a customer record with the given name.

Parameters:
customerName - the name of the customer to create

deleteCustomer

public void deleteCustomer(java.lang.String customerName)
                    throws java.rmi.RemoteException,
                           CustomerNotFoundException
Remove a customer

Parameters:
customerName - the name of the customer to remove

customerExists

public boolean customerExists(java.lang.String customerName)
                       throws java.rmi.RemoteException,
                              CustomerNotFoundException
Determine if a customer exists

Parameters:
customerName - the name to look for
Returns:
true if it exists, false otherwise

© 2002 BEA Systems, Inc.

Copyright © 2002 BEA Systems, Inc. All Rights Reserved