nl.gx.banner.api
Interface BannerSession

All Known Implementing Classes:

BannerSessionImpl

public interface BannerSession

Defines the java methods that may be accessed through the xml api in the Conf servlet. Methods in this interface are called using reflection in the Conf servlet.

Method Summary

nl.gx.banner.storage.Banner[]	createBanner(java.lang.String name, java.lang.String description, java.lang.String imageURL, java.lang.String targetURL, java.lang.String flashURL, java.lang.String contentText, int dimensionId, java.lang.String type, java.lang.String advertiser) Create a new banner.
nl.gx.banner.storage.BannerModel[]	createBannerModel(int bannerId, int modelId)
nl.gx.banner.storage.Dimension[]	createDimension(java.lang.String Name, int width, int height)
nl.gx.banner.storage.Model[]	createModel(java.lang.String name, int dimension, java.lang.String description) Create a new Model.
nl.gx.banner.storage.Banner[]	deleteBanner(int bannerId) Delete a Banner by it's id.
nl.gx.banner.storage.BannerModel[]	deleteBannerModel(int bannerModelId)
nl.gx.banner.storage.Dimension[]	deleteDimension(int dimensionId)
nl.gx.banner.storage.Model[]	deleteModel(int modelId) Delete a model.
nl.gx.banner.storage.Banner[]	getBanner(int BannerId) Retrieve a Banner based on it's id.
nl.gx.banner.storage.BannerModel[]	getBannerModel(int bannerModelId) Retrieve a Banner by id.
nl.gx.banner.storage.BannerModel[]	getBannerModels()
nl.gx.banner.storage.Banner[]	getBanners() Retrieve all banners.
nl.gx.banner.storage.Dimension[]	getDimension(int dimensionId) Retrieve a Dimension by id.
nl.gx.banner.storage.Dimension[]	getDimensions() Retrieve all Dimensions.
nl.gx.banner.storage.Model[]	getModel(int modelId) Retrieve a Model by id.
nl.gx.banner.storage.Model[]	getModels() Retrieve all Models.
nl.gx.banner.storage.Report[]	getReportByDay(int bannerId, int modelId, int contextId, int fromYear, int fromMonth, int fromDay, int toYear, int toMonth, int toDay)
nl.gx.banner.storage.Report[]	getReportByHour(int bannerId, int modelId, int contextId, int fromYear, int fromMonth, int fromDay, int fromHour, int toYear, int toMonth, int toDay, int toHour)
nl.gx.banner.storage.Report[]	getReportByMonth(int bannerId, int modelId, int contextId, int fromYear, int fromMonth, int toYear, int toMonth)
nl.gx.banner.storage.Report[]	getReportTotal(int bannerId, int modelId, int contextId, int fromYear, int fromMonth, int fromDay, int fromHour, int toYear, int toMonth, int toDay, int toHour)
nl.gx.banner.storage.Banner[]	setBannerAdvertiser(int bannerId, java.lang.String value) Set the advertiser of a banner.
nl.gx.banner.storage.Banner[]	setBannerContentText(int bannerId, java.lang.String value) Set the contentText of a banner.
nl.gx.banner.storage.Banner[]	setBannerDescription(int bannerId, java.lang.String value) Set the description of a banner.
nl.gx.banner.storage.Banner[]	setBannerDimension(int bannerId, int dimensionId) Set the Dimension of a Banner.
nl.gx.banner.storage.Banner[]	setBannerFlashURL(int bannerId, java.lang.String value) Set the flashUrl of a banner.
nl.gx.banner.storage.Banner[]	setBannerImageURL(int bannerId, java.lang.String value) Set the imageURL of a banner.
nl.gx.banner.storage.BannerModel[]	setBannerModelExpiration(int bannerModelId, int year, int month, int day, int hour)
nl.gx.banner.storage.BannerModel[]	setBannerModelInterval(int bannerModelId, int fromHour, int toHour)
nl.gx.banner.storage.BannerModel[]	setBannerModelMaxExposure(int bannerModelId, int value)
nl.gx.banner.storage.BannerModel[]	setBannerModelPublication(int bannerModelId, int year, int month, int day, int hour)
nl.gx.banner.storage.BannerModel[]	setBannerModelRelExposure(int bannerModelId, int value)
nl.gx.banner.storage.Banner[]	setBannerName(int bannerId, java.lang.String value) Set the name of a Banner.
nl.gx.banner.storage.Banner[]	setBannerTargetURL(int bannerId, java.lang.String value) Set the targetURL of a banner.
nl.gx.banner.storage.Banner[]	setBannerTargetWindow(int bannerId, int value) Set the targetWindow of a Banner.
nl.gx.banner.storage.Banner[]	setBannerType(int bannerId, java.lang.String value) Set the type af a Banner.
nl.gx.banner.storage.Dimension[]	setDimensionHeight(int dimensionId, int value)
nl.gx.banner.storage.Dimension[]	setDimensionName(int dimensionId, java.lang.String value)
nl.gx.banner.storage.Dimension[]	setDimensionWidth(int dimensionId, int value)
nl.gx.banner.storage.Model[]	setModelDescription(int modelId, java.lang.String value) Sets the description of a Model.
nl.gx.banner.storage.Model[]	setModelName(int modelId, java.lang.String value) Set the name of a model.
nl.gx.banner.storage.Model[]	setModelType(int modelId, int type) Sets the type of a Model.

Method Detail

getBanner

nl.gx.banner.storage.Banner[] getBanner(int BannerId)

Retrieve a Banner based on it's id.

Parameters:

BannerId -

Returns:

Banner array.

getBanners

nl.gx.banner.storage.Banner[] getBanners()

Retrieve all banners.

Returns:

all bannes

createBanner

nl.gx.banner.storage.Banner[] createBanner(java.lang.String name,
                                           java.lang.String description,
                                           java.lang.String imageURL,
                                           java.lang.String targetURL,
                                           java.lang.String flashURL,
                                           java.lang.String contentText,
                                           int dimensionId,
                                           java.lang.String type,
                                           java.lang.String advertiser)

Create a new banner.

Parameters:

name -

description -

imageURL -

targetURL -

flashURL -

contentText -

dimensionId -

type -

advertiser -

Returns:

an array with the newly created Banner as first and only element

deleteBanner

nl.gx.banner.storage.Banner[] deleteBanner(int bannerId)

Delete a Banner by it's id.

Parameters:

bannerId -

Returns:

an empty Banner[]

setBannerName

nl.gx.banner.storage.Banner[] setBannerName(int bannerId,
                                            java.lang.String value)

Set the name of a Banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerDimension

nl.gx.banner.storage.Banner[] setBannerDimension(int bannerId,
                                                 int dimensionId)

Set the Dimension of a Banner.

Parameters:

bannerId -

dimensionId -

Returns:

an array with the updated Banner as first and only element

setBannerDescription

nl.gx.banner.storage.Banner[] setBannerDescription(int bannerId,
                                                   java.lang.String value)

Set the description of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerAdvertiser

nl.gx.banner.storage.Banner[] setBannerAdvertiser(int bannerId,
                                                  java.lang.String value)

Set the advertiser of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerType

nl.gx.banner.storage.Banner[] setBannerType(int bannerId,
                                            java.lang.String value)

Set the type af a Banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerTargetURL

nl.gx.banner.storage.Banner[] setBannerTargetURL(int bannerId,
                                                 java.lang.String value)

Set the targetURL of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerImageURL

nl.gx.banner.storage.Banner[] setBannerImageURL(int bannerId,
                                                java.lang.String value)

Set the imageURL of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerFlashURL

nl.gx.banner.storage.Banner[] setBannerFlashURL(int bannerId,
                                                java.lang.String value)

Set the flashUrl of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerContentText

nl.gx.banner.storage.Banner[] setBannerContentText(int bannerId,
                                                   java.lang.String value)

Set the contentText of a banner.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

setBannerTargetWindow

nl.gx.banner.storage.Banner[] setBannerTargetWindow(int bannerId,
                                                    int value)

Set the targetWindow of a Banner. The value can be either 0 which means the current window (default) or 1 which means a new window.

Parameters:

bannerId -

value -

Returns:

an array with the updated Banner as first and only element

getModel

nl.gx.banner.storage.Model[] getModel(int modelId)

Retrieve a Model by id.

Parameters:

modelId -

Returns:

an array with the Model as first and only element

getModels

nl.gx.banner.storage.Model[] getModels()

Retrieve all Models.

Returns:

an array of Models

createModel

nl.gx.banner.storage.Model[] createModel(java.lang.String name,
                                         int dimension,
                                         java.lang.String description)

Create a new Model.

Parameters:

name -

dimension -

description -

Returns:

an array with the Model as first and only element

deleteModel

nl.gx.banner.storage.Model[] deleteModel(int modelId)

Delete a model.

Parameters:

modelId -

Returns:

an empty array

setModelName

nl.gx.banner.storage.Model[] setModelName(int modelId,
                                          java.lang.String value)

Set the name of a model.

Parameters:

modelId -

value -

Returns:

an array with the Model as first and only element

setModelType

nl.gx.banner.storage.Model[] setModelType(int modelId,
                                          int type)

Sets the type of a Model.

Parameters:

modelId -

type -

Returns:

an array with the Model as first and only element

setModelDescription

nl.gx.banner.storage.Model[] setModelDescription(int modelId,
                                                 java.lang.String value)

Sets the description of a Model.

Parameters:

modelId -

value -

Returns:

an array with the Model as first and only element

getDimension

nl.gx.banner.storage.Dimension[] getDimension(int dimensionId)

Retrieve a Dimension by id.

Parameters:

dimensionId -

Returns:

an array with the Dimension as first element

getDimensions

nl.gx.banner.storage.Dimension[] getDimensions()

Retrieve all Dimensions.

Returns:

createDimension

nl.gx.banner.storage.Dimension[] createDimension(java.lang.String Name,
                                                 int width,
                                                 int height)

deleteDimension

nl.gx.banner.storage.Dimension[] deleteDimension(int dimensionId)

setDimensionName

nl.gx.banner.storage.Dimension[] setDimensionName(int dimensionId,
                                                  java.lang.String value)

setDimensionWidth

nl.gx.banner.storage.Dimension[] setDimensionWidth(int dimensionId,
                                                   int value)

setDimensionHeight

nl.gx.banner.storage.Dimension[] setDimensionHeight(int dimensionId,
                                                    int value)

getBannerModel

nl.gx.banner.storage.BannerModel[] getBannerModel(int bannerModelId)

Retrieve a Banner by id.

Parameters:

bannerModelId -

Returns:

getBannerModels

nl.gx.banner.storage.BannerModel[] getBannerModels()

createBannerModel

nl.gx.banner.storage.BannerModel[] createBannerModel(int bannerId,
                                                     int modelId)

deleteBannerModel

nl.gx.banner.storage.BannerModel[] deleteBannerModel(int bannerModelId)

setBannerModelMaxExposure

nl.gx.banner.storage.BannerModel[] setBannerModelMaxExposure(int bannerModelId,
                                                             int value)

setBannerModelRelExposure

nl.gx.banner.storage.BannerModel[] setBannerModelRelExposure(int bannerModelId,
                                                             int value)

setBannerModelPublication

nl.gx.banner.storage.BannerModel[] setBannerModelPublication(int bannerModelId,
                                                             int year,
                                                             int month,
                                                             int day,
                                                             int hour)

setBannerModelExpiration

nl.gx.banner.storage.BannerModel[] setBannerModelExpiration(int bannerModelId,
                                                            int year,
                                                            int month,
                                                            int day,
                                                            int hour)

setBannerModelInterval

nl.gx.banner.storage.BannerModel[] setBannerModelInterval(int bannerModelId,
                                                          int fromHour,
                                                          int toHour)

getReportByHour

nl.gx.banner.storage.Report[] getReportByHour(int bannerId,
                                              int modelId,
                                              int contextId,
                                              int fromYear,
                                              int fromMonth,
                                              int fromDay,
                                              int fromHour,
                                              int toYear,
                                              int toMonth,
                                              int toDay,
                                              int toHour)

getReportByDay

nl.gx.banner.storage.Report[] getReportByDay(int bannerId,
                                             int modelId,
                                             int contextId,
                                             int fromYear,
                                             int fromMonth,
                                             int fromDay,
                                             int toYear,
                                             int toMonth,
                                             int toDay)

getReportByMonth

nl.gx.banner.storage.Report[] getReportByMonth(int bannerId,
                                               int modelId,
                                               int contextId,
                                               int fromYear,
                                               int fromMonth,
                                               int toYear,
                                               int toMonth)

getReportTotal

nl.gx.banner.storage.Report[] getReportTotal(int bannerId,
                                             int modelId,
                                             int contextId,
                                             int fromYear,
                                             int fromMonth,
                                             int fromDay,
                                             int fromHour,
                                             int toYear,
                                             int toMonth,
                                             int toDay,
                                             int toHour)