com.retek.component.media
Interface Media

All Superinterfaces:
BusinessObject, DistributedObject
All Known Implementing Classes:
MediaImpl

public interface Media
extends DistributedObject


Field Summary
static java.lang.String ACTIVE_DATE
           
static java.lang.String ACTIVE_END_DATE
           
static java.lang.String ACTIVE_START_DATE
           
static java.lang.String ACTIVE_STATUS
           
static java.lang.String AVERAGE_ORDER_SIZE
           
static java.lang.String BANNER
           
static java.lang.String CHANNEL
           
static java.lang.String CURRENT_FORECAST
           
static java.lang.String DATE
           
static java.lang.String DEFAULT_SOURCE_CODE
           
static java.lang.String DEFAULT_WAREHOUSE
           
static java.lang.String DELETION
           
static java.lang.String DESCRIPTION
           
static java.lang.String DESCRIPTION_SEARCH
           
static java.lang.String DROP_CODE_DATE
           
static java.lang.String DROP_CODE_SOURCE_CODE_COLLECTION
           
static java.lang.String EFFECTIVE_PRICE_END_DATE
           
static java.lang.String EFFECTIVE_PRICE_START_DATE
           
static java.lang.String ID
           
static java.lang.String IN_HOME_DATE
           
static java.lang.String ORIGINAL_FORECAST
           
static java.lang.String PAGE_LENGTH
           
static java.lang.String PAGE_SPREAD
           
static java.lang.String PAGE_UOM
           
static java.lang.String PAGE_WIDTH
           
static java.lang.String RELEASE_DATE
           
static java.lang.String RELEASED_STATUS
           
static java.lang.String RESPONSE_RATE
           
static java.lang.String RUSH_DELIVERY_CHARGE
           
static java.lang.String RUSH_DELIVERY_CHARGE_EXCEPTION
           
static java.lang.String RUSH_DELIVERY_CHARGE_GIFT_CERTIFICATE
           
static java.lang.String SEASON
           
static java.lang.String SELLING_ITEM_COLLECTION
           
static java.lang.String SELLING_SKU
           
static java.lang.String SELLING_SKU_COLLECTION
           
static java.lang.String SELLING_SKU_UNIT_PRICE
           
static java.lang.String SHIPPING_RATE_COLLECTION
           
static java.lang.String STATUS
           
static java.lang.String STD_DELIVERY_CHARGE_DOLLAR
           
static java.lang.String STD_DELIVERY_CHARGE_MAX
           
static java.lang.String STD_DELIVERY_CHARGE_MIN
           
static java.lang.String STD_DELIVERY_CHARGE_PERCENT
           
static java.lang.String TOTAL_AD_COST
           
static java.lang.String TOTAL_NUMBER_OF_PAGES
           
static java.lang.String TYPE
           
static java.lang.String VIRTUAL_STORE
           
static java.lang.String WORKSHEET_STATUS
           
static java.lang.String YEAR
           
 
Method Summary
 DropCode addDropCode(DropCode dropCode)
           
 void addSourceCode(DropCode dropCode, SourceCode sourceCode)
           
 ShippingRateTable createAdjustmentShippingRateTable()
          Create a new adjustment shipping rate table for the media.
 RDate getActiveDate()
           
 java.util.Collection getAllShippingRateTables()
          Return all shipping rate tables for the media.
 java.lang.String getAvgOrderSize()
           
 Banner getBanner()
           
 ChannelType getChannelType()
           
 long getCirculation()
           
 java.lang.String getCurrentForecast()
           
 SourceCode getDefaultSourceCode()
           
 java.lang.String getDescription()
           
 java.lang.String getDisplayCode()
           
 DropCode getDropCode(java.lang.String code)
           
 java.util.Collection getDropCodes()
           
 RDate getInHomeDate()
           
 MediaType getMediaType()
           
 MediaOrderableStatus getOrderableStatus()
           
 java.lang.String getOriginalForecast()
           
 java.math.BigDecimal getPageLength()
           
 UnitOfMeasure getPageUnitOfMeasure()
           
 java.math.BigDecimal getPageWidth()
           
 RDate getPriceEffectiveEndDate()
           
 RDate getPriceEffectiveStartDate()
           
 RDate getReleaseDate()
           
 RDate getReserveFromDate()
           
 java.lang.String getResponseRate()
           
 SeasonCode getSeasonCode()
           
 SellingItem getSellingItem(java.lang.String sellingItemNumber)
           
 java.util.Collection getSellingItems()
           
 int getSellingSkuCount()
           
 ShippingRateTable getShippingRateTable()
          Return the current (most recent shipping rate table) for the media.
 ShippingRateTable getShippingRateTable(RDate effectiveDate)
          Return the shipping rate table for the specified effectiveDate.
 java.util.Collection getSourceCodes()
           
 MediaStatus getStatus()
           
 Store getStore()
           
 SubConcept getSubConcept()
           
 Money getTotalAdCost()
           
 java.math.BigDecimal getTotalArea()
           
 long getTotalNumPages()
           
 java.lang.String getYear()
           
 boolean isNewAdjustmentShippingRateTableAllowed()
          Return boolean indicating if the media is allowed to have a new adjusted shipping rate table created.
 void remove()
           
 void removeDropCode(DropCode dropCode)
           
 void removeSourceCode(DropCode dropCode, SourceCode sourceCode)
           
 void setActiveDate(RDate activeDate)
           
 void setAvgOrderSize(java.lang.String avgOrderSize)
           
 void setChannelType(ChannelType channelType)
           
 void setCurrentForecast(java.lang.String currentForecast)
           
 void setDefaultSourceCode(SourceCode defaultSourceCode)
           
 void setDescription(java.lang.String description)
           
 void setInHomeDate(RDate inHomeDate)
           
 void setMediaType(MediaType mediaType)
           
 void setOriginalForecast(java.lang.String originalForecast)
           
 void setPageLength(java.math.BigDecimal pageLength)
           
 void setPageUnitOfMeasure(UnitOfMeasure unitOfMeasure)
           
 void setPageWidth(java.math.BigDecimal pageWidth)
           
 void setPriceEffectiveEndDate(RDate priceEffEndDate)
           
 void setPriceEffectiveStartDate(RDate priceEffStartDate)
           
 void setReleaseDate(RDate releaseDate)
           
 void setResponseRate(java.lang.String responseRate)
           
 void setSeasonCode(SeasonCode seasonCode)
           
 void setStatus(MediaStatus status)
           
 void setSubConcept(SubConcept subConcept)
           
 void setTotalAdCost(Money cost)
           
 void setTotalNumPages(long numPages)
           
 void setVirtualStore(Store store)
           
 void setYear(java.lang.String year)
           
 void submit()
           
 void validateActiveDate()
           
 void validateDropCodeUpdate(DropCode dropCode)
           
 void validateStartDate()
           
 
Methods inherited from interface com.retek.commons.component.DistributedObject
debugToString, discardChanges, getContext, getId, getReference, isDeleted, isDirty, isDirtyDeep, isDirtyIgnoreFields, isPersisted, refresh
 
Methods inherited from interface com.retek.commons.component.BusinessObject
getBusinessInterface
 

Field Detail

DATE

public static final java.lang.String DATE
See Also:
Constant Field Values

ACTIVE_DATE

public static final java.lang.String ACTIVE_DATE
See Also:
Constant Field Values

IN_HOME_DATE

public static final java.lang.String IN_HOME_DATE
See Also:
Constant Field Values

RELEASE_DATE

public static final java.lang.String RELEASE_DATE
See Also:
Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION
See Also:
Constant Field Values

DESCRIPTION_SEARCH

public static final java.lang.String DESCRIPTION_SEARCH
See Also:
Constant Field Values

EFFECTIVE_PRICE_START_DATE

public static final java.lang.String EFFECTIVE_PRICE_START_DATE
See Also:
Constant Field Values

EFFECTIVE_PRICE_END_DATE

public static final java.lang.String EFFECTIVE_PRICE_END_DATE
See Also:
Constant Field Values

YEAR

public static final java.lang.String YEAR
See Also:
Constant Field Values

SEASON

public static final java.lang.String SEASON
See Also:
Constant Field Values

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values

STATUS

public static final java.lang.String STATUS
See Also:
Constant Field Values

BANNER

public static final java.lang.String BANNER
See Also:
Constant Field Values

CHANNEL

public static final java.lang.String CHANNEL
See Also:
Constant Field Values

ID

public static final java.lang.String ID
See Also:
Constant Field Values

DROP_CODE_DATE

public static final java.lang.String DROP_CODE_DATE
See Also:
Constant Field Values

PAGE_LENGTH

public static final java.lang.String PAGE_LENGTH
See Also:
Constant Field Values

PAGE_WIDTH

public static final java.lang.String PAGE_WIDTH
See Also:
Constant Field Values

PAGE_UOM

public static final java.lang.String PAGE_UOM
See Also:
Constant Field Values

TOTAL_NUMBER_OF_PAGES

public static final java.lang.String TOTAL_NUMBER_OF_PAGES
See Also:
Constant Field Values

ACTIVE_START_DATE

public static final java.lang.String ACTIVE_START_DATE
See Also:
Constant Field Values

ACTIVE_END_DATE

public static final java.lang.String ACTIVE_END_DATE
See Also:
Constant Field Values

TOTAL_AD_COST

public static final java.lang.String TOTAL_AD_COST
See Also:
Constant Field Values

PAGE_SPREAD

public static final java.lang.String PAGE_SPREAD
See Also:
Constant Field Values

STD_DELIVERY_CHARGE_MIN

public static final java.lang.String STD_DELIVERY_CHARGE_MIN
See Also:
Constant Field Values

STD_DELIVERY_CHARGE_MAX

public static final java.lang.String STD_DELIVERY_CHARGE_MAX
See Also:
Constant Field Values

STD_DELIVERY_CHARGE_DOLLAR

public static final java.lang.String STD_DELIVERY_CHARGE_DOLLAR
See Also:
Constant Field Values

STD_DELIVERY_CHARGE_PERCENT

public static final java.lang.String STD_DELIVERY_CHARGE_PERCENT
See Also:
Constant Field Values

RESPONSE_RATE

public static final java.lang.String RESPONSE_RATE
See Also:
Constant Field Values

ORIGINAL_FORECAST

public static final java.lang.String ORIGINAL_FORECAST
See Also:
Constant Field Values

CURRENT_FORECAST

public static final java.lang.String CURRENT_FORECAST
See Also:
Constant Field Values

AVERAGE_ORDER_SIZE

public static final java.lang.String AVERAGE_ORDER_SIZE
See Also:
Constant Field Values

WORKSHEET_STATUS

public static final java.lang.String WORKSHEET_STATUS
See Also:
Constant Field Values

ACTIVE_STATUS

public static final java.lang.String ACTIVE_STATUS
See Also:
Constant Field Values

RELEASED_STATUS

public static final java.lang.String RELEASED_STATUS
See Also:
Constant Field Values

DEFAULT_SOURCE_CODE

public static final java.lang.String DEFAULT_SOURCE_CODE
See Also:
Constant Field Values

SELLING_ITEM_COLLECTION

public static final java.lang.String SELLING_ITEM_COLLECTION
See Also:
Constant Field Values

SHIPPING_RATE_COLLECTION

public static final java.lang.String SHIPPING_RATE_COLLECTION
See Also:
Constant Field Values

SELLING_SKU_COLLECTION

public static final java.lang.String SELLING_SKU_COLLECTION
See Also:
Constant Field Values

SELLING_SKU_UNIT_PRICE

public static final java.lang.String SELLING_SKU_UNIT_PRICE
See Also:
Constant Field Values

DROP_CODE_SOURCE_CODE_COLLECTION

public static final java.lang.String DROP_CODE_SOURCE_CODE_COLLECTION
See Also:
Constant Field Values

VIRTUAL_STORE

public static final java.lang.String VIRTUAL_STORE
See Also:
Constant Field Values

DEFAULT_WAREHOUSE

public static final java.lang.String DEFAULT_WAREHOUSE
See Also:
Constant Field Values

RUSH_DELIVERY_CHARGE

public static final java.lang.String RUSH_DELIVERY_CHARGE
See Also:
Constant Field Values

RUSH_DELIVERY_CHARGE_EXCEPTION

public static final java.lang.String RUSH_DELIVERY_CHARGE_EXCEPTION
See Also:
Constant Field Values

RUSH_DELIVERY_CHARGE_GIFT_CERTIFICATE

public static final java.lang.String RUSH_DELIVERY_CHARGE_GIFT_CERTIFICATE
See Also:
Constant Field Values

DELETION

public static final java.lang.String DELETION
See Also:
Constant Field Values

SELLING_SKU

public static final java.lang.String SELLING_SKU
See Also:
Constant Field Values
Method Detail

setDescription

public void setDescription(java.lang.String description)
                    throws SystemException
Throws:
SystemException

submit

public void submit()
            throws SystemException,
                   BusinessException
Throws:
SystemException
BusinessException

getBanner

public Banner getBanner()
                 throws SystemException
Throws:
SystemException

getDisplayCode

public java.lang.String getDisplayCode()
                                throws SystemException
Throws:
SystemException

setMediaType

public void setMediaType(MediaType mediaType)
                  throws SystemException
Throws:
SystemException

setSeasonCode

public void setSeasonCode(SeasonCode seasonCode)
                   throws SystemException
Throws:
SystemException

setSubConcept

public void setSubConcept(SubConcept subConcept)
                   throws SystemException
Throws:
SystemException

setStatus

public void setStatus(MediaStatus status)
               throws SystemException
Throws:
SystemException

setYear

public void setYear(java.lang.String year)
             throws SystemException
Throws:
SystemException

setInHomeDate

public void setInHomeDate(RDate inHomeDate)
                   throws SystemException
Throws:
SystemException

setReleaseDate

public void setReleaseDate(RDate releaseDate)
                    throws SystemException
Throws:
SystemException

setActiveDate

public void setActiveDate(RDate activeDate)
                   throws SystemException
Throws:
SystemException

setPriceEffectiveStartDate

public void setPriceEffectiveStartDate(RDate priceEffStartDate)
                                throws SystemException
Throws:
SystemException

setPriceEffectiveEndDate

public void setPriceEffectiveEndDate(RDate priceEffEndDate)
                              throws SystemException
Throws:
SystemException

setPageLength

public void setPageLength(java.math.BigDecimal pageLength)
                   throws SystemException
Throws:
SystemException

setPageWidth

public void setPageWidth(java.math.BigDecimal pageWidth)
                  throws SystemException
Throws:
SystemException

setPageUnitOfMeasure

public void setPageUnitOfMeasure(UnitOfMeasure unitOfMeasure)
                          throws SystemException
Throws:
SystemException

setTotalAdCost

public void setTotalAdCost(Money cost)
                    throws SystemException
Throws:
SystemException

setTotalNumPages

public void setTotalNumPages(long numPages)
                      throws SystemException
Throws:
SystemException

setResponseRate

public void setResponseRate(java.lang.String responseRate)
                     throws SystemException
Throws:
SystemException

setAvgOrderSize

public void setAvgOrderSize(java.lang.String avgOrderSize)
                     throws SystemException
Throws:
SystemException

setOriginalForecast

public void setOriginalForecast(java.lang.String originalForecast)
                         throws SystemException
Throws:
SystemException

setCurrentForecast

public void setCurrentForecast(java.lang.String currentForecast)
                        throws SystemException
Throws:
SystemException

setDefaultSourceCode

public void setDefaultSourceCode(SourceCode defaultSourceCode)
                          throws SystemException
Throws:
SystemException

getDescription

public java.lang.String getDescription()
                                throws SystemException
Throws:
SystemException

getMediaType

public MediaType getMediaType()
                       throws SystemException
Throws:
SystemException

getSeasonCode

public SeasonCode getSeasonCode()
                         throws SystemException
Throws:
SystemException

getSubConcept

public SubConcept getSubConcept()
                         throws SystemException
Throws:
SystemException

getStatus

public MediaStatus getStatus()
                      throws SystemException
Throws:
SystemException

getYear

public java.lang.String getYear()
                         throws SystemException
Throws:
SystemException

getInHomeDate

public RDate getInHomeDate()
                    throws SystemException
Throws:
SystemException

getReleaseDate

public RDate getReleaseDate()
                     throws SystemException
Throws:
SystemException

getReserveFromDate

public RDate getReserveFromDate()
                         throws SystemException
Throws:
SystemException

getActiveDate

public RDate getActiveDate()
                    throws SystemException
Throws:
SystemException

getPriceEffectiveStartDate

public RDate getPriceEffectiveStartDate()
                                 throws SystemException
Throws:
SystemException

getPriceEffectiveEndDate

public RDate getPriceEffectiveEndDate()
                               throws SystemException
Throws:
SystemException

getPageLength

public java.math.BigDecimal getPageLength()
                                   throws SystemException
Throws:
SystemException

getPageWidth

public java.math.BigDecimal getPageWidth()
                                  throws SystemException
Throws:
SystemException

getPageUnitOfMeasure

public UnitOfMeasure getPageUnitOfMeasure()
                                   throws SystemException
Throws:
SystemException

getTotalAdCost

public Money getTotalAdCost()
                     throws SystemException
Throws:
SystemException

getTotalNumPages

public long getTotalNumPages()
                      throws SystemException
Throws:
SystemException

getResponseRate

public java.lang.String getResponseRate()
                                 throws SystemException
Throws:
SystemException

getAvgOrderSize

public java.lang.String getAvgOrderSize()
                                 throws SystemException
Throws:
SystemException

getOriginalForecast

public java.lang.String getOriginalForecast()
                                     throws SystemException
Throws:
SystemException

getCurrentForecast

public java.lang.String getCurrentForecast()
                                    throws SystemException
Throws:
SystemException

getDefaultSourceCode

public SourceCode getDefaultSourceCode()
                                throws SystemException
Throws:
SystemException

getCirculation

public long getCirculation()
                    throws SystemException
Throws:
SystemException

getTotalArea

public java.math.BigDecimal getTotalArea()
                                  throws SystemException
Throws:
SystemException

setVirtualStore

public void setVirtualStore(Store store)
                     throws SystemException
Throws:
SystemException

getStore

public Store getStore()
               throws SystemException
Throws:
SystemException

getDropCodes

public java.util.Collection getDropCodes()
                                  throws SystemException
Throws:
SystemException

getDropCode

public DropCode getDropCode(java.lang.String code)
                     throws SystemException
Throws:
SystemException

addDropCode

public DropCode addDropCode(DropCode dropCode)
                     throws SystemException,
                            BusinessException
Throws:
SystemException
BusinessException

validateDropCodeUpdate

public void validateDropCodeUpdate(DropCode dropCode)
                            throws SystemException,
                                   BusinessException
Throws:
SystemException
BusinessException

addSourceCode

public void addSourceCode(DropCode dropCode,
                          SourceCode sourceCode)
                   throws SystemException,
                          BusinessException
Throws:
SystemException
BusinessException

removeSourceCode

public void removeSourceCode(DropCode dropCode,
                             SourceCode sourceCode)
                      throws SystemException
Throws:
SystemException

validateActiveDate

public void validateActiveDate()
                        throws SystemException,
                               BusinessException
Throws:
SystemException
BusinessException

validateStartDate

public void validateStartDate()
                       throws SystemException,
                              BusinessException
Throws:
SystemException
BusinessException

removeDropCode

public void removeDropCode(DropCode dropCode)
                    throws SystemException
Throws:
SystemException

getSourceCodes

public java.util.Collection getSourceCodes()
                                    throws SystemException
Throws:
SystemException

getSellingItems

public java.util.Collection getSellingItems()
                                     throws SystemException
Throws:
SystemException

getSellingItem

public SellingItem getSellingItem(java.lang.String sellingItemNumber)
                           throws SystemException
Throws:
SystemException

getSellingSkuCount

public int getSellingSkuCount()
                       throws SystemException
Throws:
SystemException

getChannelType

public ChannelType getChannelType()
                           throws SystemException
Throws:
SystemException

setChannelType

public void setChannelType(ChannelType channelType)
                    throws SystemException
Throws:
SystemException

getOrderableStatus

public MediaOrderableStatus getOrderableStatus()
                                        throws SystemException
Throws:
SystemException

getShippingRateTable

public ShippingRateTable getShippingRateTable()
                                       throws SystemException
Return the current (most recent shipping rate table) for the media.

Returns:
ShippingRateTable current shipping rate table
Throws:
SystemException

getShippingRateTable

public ShippingRateTable getShippingRateTable(RDate effectiveDate)
                                       throws SystemException
Return the shipping rate table for the specified effectiveDate.

Returns:
ShippingRateTable shipping rate table for effective date
Throws:
SystemException

getAllShippingRateTables

public java.util.Collection getAllShippingRateTables()
                                              throws SystemException
Return all shipping rate tables for the media.

Returns:
Set shipping rate tables.
Throws:
SystemException

isNewAdjustmentShippingRateTableAllowed

public boolean isNewAdjustmentShippingRateTableAllowed()
                                                throws SystemException
Return boolean indicating if the media is allowed to have a new adjusted shipping rate table created. If the media's current rate table can be adjusted (ex. if the media is not yet orderable) this operation will answer false, since the current rate table can simply be changed. If the media's current rate table is locked down and cannot be adjusted (ex. if the media is orderable) this operation will answer true.

Returns:
boolean true if new adjustment shipping rate table allowed for media
Throws:
SystemException

createAdjustmentShippingRateTable

public ShippingRateTable createAdjustmentShippingRateTable()
                                                    throws SystemException,
                                                           BusinessException
Create a new adjustment shipping rate table for the media. The adjustment rate table will have an effective date of tommorrow. The existing shipping rate table for the media will be marked with an effective date of today. This operation will throw a business exception if it is not valid to create an adjustment rate table.

Returns:
ShippingRateTable new adjustment shipping rate table
Throws:
SystemException
BusinessException

remove

public void remove()
            throws SystemException,
                   BusinessException
Throws:
SystemException
BusinessException


Copyright © 2004 Retek Inc. All Rights Reserved. - Generated at Fri, 10/22/2004 07:28