com.konakartadmin.blif

Interface AdminFilterMgrIf

All Known Implementing Classes:

AdminFilterMgr, AdminFilterMgrEE

public interface AdminFilterMgrIf

AdminFiltertMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteFilter(int id) Delete an AdminFilter object
void	deleteFiltersForCustomer(int userId) Delete all the AdminFilter objects associated with the specified customer
boolean	filterMgrPresent() Returns true if the filter manager is present.
AdminFilter	getFilter(int Id) Returns the filter referenced by the Id.
AdminFilterSearchResult	getFilters(AdminFilterSearch search, AdminDataDescriptor dataDesc) Returns an array of filter records matching the search criteria.
AdminFilter[]	getFiltersForCustomer(int custId) Returns an array of filter records matching the search criteria.
int	insertFilter(AdminFilter filter) Insert an AdminFilter record.
void	refreshConfigs() Refresh the configuration of the AdminFiltertMgr
void	updateFilter(AdminFilter filter) Update an AdminFilterType object

Method Detail

getFilters

AdminFilterSearchResult getFilters(AdminFilterSearch search,
                                   AdminDataDescriptor dataDesc)
                            throws KKAdminException

Returns an array of filter records matching the search criteria. If no records are found an empty array is returned.

Parameters:

search - an AdminFilterSearch object

dataDesc - an AdminDataDescriptor object

The returned filters may be sorted by:

• AdminDataDescriptor.ORDER_BY_ORDER_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_ORDER_ID_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOMERS_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOMERS_ID_ASCENDING
• AdminDataDescriptor.ORDER_BY_TABLE_ASCENDING
• AdminDataDescriptor.ORDER_BY_TABLE_DESCENDING
• AdminDataDescriptor.ORDER_BY_COLUMN_ASCENDING
• AdminDataDescriptor.ORDER_BY_COLUMN_DESCENDING
• AdminDataDescriptor.ORDER_BY_CONSTRAINT_ASCENDING
• AdminDataDescriptor.ORDER_BY_CONSTRAINT_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM1_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM1_DESCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM2_ASCENDING
• AdminDataDescriptor.ORDER_BY_CUSTOM3_DESCENDING

Returns:

Returns an AdminFilterSearchResult object containing an array of filter records matching the search criteria. If there are no records an empty array is returned within the AdminFilterSearchResult.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getFiltersForCustomer

AdminFilter[] getFiltersForCustomer(int custId)
                             throws KKAdminException

Returns an array of filter records matching the search criteria. If no records are found an empty array is returned.

Parameters:

custId - an AdminFilterSearch object

Returns:

Returns the filters belonging to the specified customer. If there are no records an empty array is returned.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getFilter

AdminFilter getFilter(int Id)
               throws KKAdminException

Returns the filter referenced by the Id.

Parameters:

Id - the id of the Filter

Returns:

Returns an AdminFilter object if it exists, otherwise it returns null

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertFilter

int insertFilter(AdminFilter filter)
          throws KKAdminException

Insert an AdminFilter record.

Parameters:

filter - the AdminFilter record to insert

Returns:

the Id of the inserted AdminFilter

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateFilter

void updateFilter(AdminFilter filter)
           throws KKAdminException

Update an AdminFilterType object

Parameters:

filter - an AdminFilter object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteFilter

void deleteFilter(int id)
           throws KKAdminException

Delete an AdminFilter object

Parameters:

id - the Id of the AdminFilter record to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteFiltersForCustomer

void deleteFiltersForCustomer(int userId)
                       throws KKAdminException

Delete all the AdminFilter objects associated with the specified customer

Parameters:

userId - the userId of the customer whose AdminFilter records to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

filterMgrPresent

boolean filterMgrPresent()

Returns true if the filter manager is present. Only the EE version will return true.

Returns:

true if the filter manager is present otherwise false

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the AdminFiltertMgr

Throws:

java.lang.Exception - an unexpected exception