com.konakartadmin.blif

Interface AdminContentMgrIf

All Known Implementing Classes:

AdminContentMgr, AdminContentMgrEE

public interface AdminContentMgrIf

AdminContentMgrIf

Method Summary

Modifier and Type	Method and Description
void	deleteContent(int contentId) Delete an AdminContent object - all associated AdminContentDescriptions are also deleted
void	deleteContentType(int contentTypeId) Delete an AdminContentType object - all associated AdminContentTypeDescriptions are also deleted
AdminContent	getContent(int contentId) Returns the content referenced by the contentId.
AdminContentSearchResult	getContents(AdminContentSearch search, AdminDataDescriptor dataDesc) Returns an array of content records matching the search criteria.
AdminContentType	getContentType(int contentTypeId) Returns the AdminContentType referenced by the contentTypeId.
AdminContentTypeSearchResult	getContentTypes(AdminContentTypeSearch search, AdminDataDescriptor dataDesc) Returns an array of AdminContentType records matching the search criteria.
int	insertContent(AdminContent content) Insert an AdminContent object.
int	insertContentDescription(AdminContentDescription ctDesc) Insert a single AdminContentDescription record.
int	insertContentType(AdminContentType contentType) Insert an AdminContentType object.
int	insertContentTypeDescription(AdminContentTypeDescription ctDesc) Insert a single AdminContentTypeDescription record.
void	refreshConfigs() Refresh the configuration of the AdminContentMgr
void	updateContent(AdminContent content) Update an AdminContent object
void	updateContentType(AdminContentType contentType) Update an AdminContentType object

Method Detail

getContents

AdminContentSearchResult getContents(AdminContentSearch search,
                                     AdminDataDescriptor dataDesc)
                              throws KKAdminException

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

Parameters:

search - an AdminContentSearch object

dataDesc - an AdminDataDescriptor object

Returns:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getContent

AdminContent getContent(int contentId)
                 throws KKAdminException

Returns the content referenced by the contentId.

Parameters:

contentId - the id of the Content

Returns:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertContent

int insertContent(AdminContent content)
           throws KKAdminException

Insert an AdminContent object. If the contentId attribute is not equal to 0 or -1 it is inserted otherwise it is updated with the id of the newly-inserted AdminContent object.

Parameters:

content - an AdminContent object

Returns:

returns the id of the inserted AdminContent

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteContent

void deleteContent(int contentId)
            throws KKAdminException

Delete an AdminContent object - all associated AdminContentDescriptions are also deleted

Parameters:

contentId - the contentId of the AdminContent record to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateContent

void updateContent(AdminContent content)
            throws KKAdminException

Update an AdminContent object

Parameters:

content - an AdminContent object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getContentTypes

AdminContentTypeSearchResult getContentTypes(AdminContentTypeSearch search,
                                             AdminDataDescriptor dataDesc)
                                      throws KKAdminException

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

Parameters:

search - an AdminContentTypeSearch object

dataDesc - an AdminDataDescriptor object

Returns:

Returns an AdminContentSearchTypeResult object containing an array of content type records matching the search criteria. If there are no records an empty array is returned within the AdminContentTypeSearchResult.

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getContentType

AdminContentType getContentType(int contentTypeId)
                         throws KKAdminException

Returns the AdminContentType referenced by the contentTypeId.

Parameters:

contentTypeId - the contentTypeId of the AdminContentType

Returns:

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

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertContentType

int insertContentType(AdminContentType contentType)
               throws KKAdminException

Insert an AdminContentType object. If the contentTypeId attribute is not equal to 0 or -1 it is inserted otherwise it is updated with the id of the newly-inserted AdminContentType object.

Parameters:

contentType - an AdminContentType object

Returns:

returns the id of the inserted AdminContentType

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

deleteContentType

void deleteContentType(int contentTypeId)
                throws KKAdminException

Delete an AdminContentType object - all associated AdminContentTypeDescriptions are also deleted

Parameters:

contentTypeId - the contentTypeId of the AdminContentType record to delete

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateContentType

void updateContentType(AdminContentType contentType)
                throws KKAdminException

Update an AdminContentType object

Parameters:

contentType - an AdminContentType object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertContentDescription

int insertContentDescription(AdminContentDescription ctDesc)
                      throws KKAdminException

Insert a single AdminContentDescription record. This is typically only used when fixing data integrity problems.

Parameters:

ctDesc - the AdminContentDescription record to insert

Returns:

the contentId of the inserted AdminContentDescription

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertContentTypeDescription

int insertContentTypeDescription(AdminContentTypeDescription ctDesc)
                          throws KKAdminException

Insert a single AdminContentTypeDescription record. This is typically only used when fixing data integrity problems.

Parameters:

ctDesc - the AdminContentTypeDescription record to insert

Returns:

the contentTypeId of the inserted AdminContentTypeDescription

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

void refreshConfigs()
             throws java.lang.Exception

Refresh the configuration of the AdminContentMgr

Throws:

java.lang.Exception - an unexpected exception