com.wm.app.tn.db
Class ProfileFldOps

java.lang.Object
  extended by com.wm.app.tn.db.ProfileFldOps

public class ProfileFldOps
extends java.lang.Object

Provides database operations for retrieving, inserting, updating and deleting partner ProfileFields. ExtendedProfileFields will contain metadata and a value. StandardProfileFields will contain metadata, but their value will always be null. Each StandardProfileField returned by methods in this class has to be merged with the associated value from the table & column identified in the field's metadata. This is done in the com.wm.app.tn.db.ProfileOps.

This class has no application knowledge in it. The data is not validated before committing it to the database. That is the responsibility of the caller.


Field Summary
static java.util.Hashtable profGroups
           
 
Constructor Summary
ProfileFldOps()
           
 
Method Summary
static void addExtendedField(java.sql.Connection conn, java.lang.String partnerID, ExtendedProfileField fld)
          Inserts an extended field for a partner.
static void addExtendedField(java.lang.String partnerID, ExtendedProfileField fld)
          Inserts an extended field for a partner.
static void deleteExtendedField(java.sql.Connection conn, java.lang.String partnerID, java.lang.String pfID)
          Deletes an extended field for a partner.
static void deleteExtendedField(java.lang.String partnerID, java.lang.String pfID)
          Deletes an extended field for a partner.
static void deleteExtendedFields(java.sql.Connection conn, java.lang.String partnerID, int groupID)
           
static ExtendedProfileField getExtendedField(java.sql.Connection conn, java.lang.String partnerID, java.lang.String name)
          Retrieves an extended ProfileField for a partner.
static ExtendedProfileField getExtendedField(java.lang.String partnerID, java.lang.String name)
          Retrieves an extended ProfileField for a partner.
static ExtendedProfileField getExtendedFieldByID(java.lang.String partnerID, java.lang.String ID)
          Retrieves an extended ProfileField for a partner.
static java.util.Vector getExtendedFields()
           
static java.util.Vector<ExtendedProfileField> getExtendedFields(java.lang.String partnerID, java.lang.String displayName)
           
static java.lang.Object getExtendedFieldValue(java.lang.String partnerID, java.lang.String ID)
           
static java.util.Vector getExtFldsForPartner(java.lang.String partnerID)
           
static java.util.Enumeration getGroupFields(java.sql.Connection conn, java.lang.String partnerID, int groupID, boolean extended)
          Retrieves ProfileFields by group for a partner.
static java.util.Enumeration getGroupFields(java.lang.String partnerID, int groupID, boolean extended)
          Retrieves ProfileFields by group for a partner.
static boolean updateExtendedField(java.sql.Connection conn, ExtendedProfileField fld)
          Updates an extended field for a partner.
static void updateExtendedField(ExtendedProfileField fld)
          Updates an extended field for a partner.
static void updateExtendedFields(java.sql.Connection conn, java.lang.String partnerID, java.util.Vector flds)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

profGroups

public static java.util.Hashtable profGroups
Constructor Detail

ProfileFldOps

public ProfileFldOps()
Method Detail

getGroupFields

public static java.util.Enumeration getGroupFields(java.lang.String partnerID,
                                                   int groupID,
                                                   boolean extended)
                                            throws java.sql.SQLException,
                                                   ProfileStoreException
Retrieves ProfileFields by group for a partner.

Parameters:
partnerID - internally assigned ID for a partner
group - name of the group to retrive fields for
extended - indicates whether to retrieve extended or standard fields. Pass true for extended fields and false for standard fields.
Returns:
an Enumeration of ProfileField IData's
Throws:
java.sql.SQLException
ProfileStoreException

getGroupFields

public static java.util.Enumeration getGroupFields(java.sql.Connection conn,
                                                   java.lang.String partnerID,
                                                   int groupID,
                                                   boolean extended)
                                            throws java.sql.SQLException,
                                                   ProfileStoreException
Retrieves ProfileFields by group for a partner.

Parameters:
conn - an open Connection to the Trading Networks database
partnerID - internally assigned ID for a partner
group - name of the group to retrieve fields for
extended - indicates whether to retrieve extended or standard fields. Pass true for extended fields and false for standard fields.
Returns:
an Enumeration of ProfileField IData's
Throws:
java.sql.SQLException
ProfileStoreException

getExtendedField

public static ExtendedProfileField getExtendedField(java.lang.String partnerID,
                                                    java.lang.String name)
                                             throws java.sql.SQLException,
                                                    ProfileStoreException
Retrieves an extended ProfileField for a partner.

Parameters:
partnerID - internally assigned ID of a partner
name - the name of the extended field
Returns:
a ProfileField
Throws:
java.sql.SQLException
ProfileStoreException

getExtendedField

public static ExtendedProfileField getExtendedField(java.sql.Connection conn,
                                                    java.lang.String partnerID,
                                                    java.lang.String name)
                                             throws java.sql.SQLException,
                                                    ProfileStoreException
Retrieves an extended ProfileField for a partner.

Parameters:
conn - an open Connection to the Trading Networks database
partnerID - internally assigned ID of a partner
name - the name of the extended field
Returns:
a ProfileField
Throws:
java.sql.SQLException
ProfileStoreException

getExtendedFieldByID

public static ExtendedProfileField getExtendedFieldByID(java.lang.String partnerID,
                                                        java.lang.String ID)
                                                 throws java.sql.SQLException,
                                                        ProfileStoreException
Retrieves an extended ProfileField for a partner.

Parameters:
partnerID - internally assigned ID of a partner
name - the name of the extended field
Returns:
a ProfileField
Throws:
java.sql.SQLException
ProfileStoreException

getExtendedFieldValue

public static java.lang.Object getExtendedFieldValue(java.lang.String partnerID,
                                                     java.lang.String ID)
                                              throws java.sql.SQLException,
                                                     ProfileStoreException
Throws:
java.sql.SQLException
ProfileStoreException

addExtendedField

public static void addExtendedField(java.lang.String partnerID,
                                    ExtendedProfileField fld)
                             throws java.sql.SQLException,
                                    ProfileStoreException
Inserts an extended field for a partner.

Parameters:
partnerID - internally assigned ID of a partner
fld - the ExtendedProfileField to be inserted to the database
Throws:
java.sql.SQLException
ProfileStoreException

addExtendedField

public static void addExtendedField(java.sql.Connection conn,
                                    java.lang.String partnerID,
                                    ExtendedProfileField fld)
                             throws java.sql.SQLException,
                                    ProfileStoreException
Inserts an extended field for a partner.

Parameters:
conn - an open Connection to the Trading Networks database
partnerID - internally assigned ID of a partner
fld - the ExtendedProfileField to be inserted to the database
Throws:
java.sql.SQLException
ProfileStoreException

updateExtendedField

public static void updateExtendedField(ExtendedProfileField fld)
                                throws java.sql.SQLException,
                                       ProfileStoreException
Updates an extended field for a partner.

Parameters:
partnerID - internally assigned ID of a partner
fld - the ExtendedProfileField to be inserted to the database
Throws:
java.sql.SQLException
ProfileStoreException

updateExtendedFields

public static void updateExtendedFields(java.sql.Connection conn,
                                        java.lang.String partnerID,
                                        java.util.Vector flds)
                                 throws java.sql.SQLException,
                                        ProfileStoreException
Throws:
java.sql.SQLException
ProfileStoreException

updateExtendedField

public static boolean updateExtendedField(java.sql.Connection conn,
                                          ExtendedProfileField fld)
                                   throws java.sql.SQLException,
                                          ProfileStoreException
Updates an extended field for a partner. If the field's value has been nulled-out, the field is removed.

Parameters:
conn - an open Connection to the Trading Networks database
partnerID - internally assigned ID of a partner
fld - the ExtendedProfileField to be inserted to the database
Throws:
java.sql.SQLException
ProfileStoreException

deleteExtendedField

public static void deleteExtendedField(java.lang.String partnerID,
                                       java.lang.String pfID)
                                throws java.sql.SQLException,
                                       ProfileStoreException
Deletes an extended field for a partner.

Parameters:
partnerID - internally assigned ID of a partner
pfID - the the ProfileFieldID of the extended field to be deleted. Given a ProfielField instance, this value can be retrieved by calling getMetaData().getFieldID() on it.
Throws:
java.sql.SQLException
ProfileStoreException

deleteExtendedField

public static void deleteExtendedField(java.sql.Connection conn,
                                       java.lang.String partnerID,
                                       java.lang.String pfID)
                                throws java.sql.SQLException,
                                       ProfileStoreException
Deletes an extended field for a partner.

Parameters:
conn - an open Connection to the Trading Networks database
partnerID - internally assigned ID of a partner
pfID - the the ProfileFieldID of the extended field to be deleted. Given a ProfileField instance, this value can be retrieved by calling getMetaData().getFieldID() on it.
Throws:
java.sql.SQLException
ProfileStoreException

deleteExtendedFields

public static void deleteExtendedFields(java.sql.Connection conn,
                                        java.lang.String partnerID,
                                        int groupID)
                                 throws java.sql.SQLException,
                                        ProfileStoreException
Throws:
java.sql.SQLException
ProfileStoreException

getExtFldsForPartner

public static java.util.Vector getExtFldsForPartner(java.lang.String partnerID)
                                             throws java.sql.SQLException,
                                                    ProfileStoreException
Throws:
java.sql.SQLException
ProfileStoreException

getExtendedFields

public static java.util.Vector getExtendedFields()
                                          throws java.sql.SQLException
Throws:
java.sql.SQLException

getExtendedFields

public static java.util.Vector<ExtendedProfileField> getExtendedFields(java.lang.String partnerID,
                                                                       java.lang.String displayName)