com.jwpepper.cat
Interface EntryItem

All Known Implementing Classes:
ProductEntryItemImpl

public abstract interface EntryItem
extends Entity

Prescribes the business methods that constitute an entry item business component. An entry item is the bridge between a simple catalog entry and the external thing it represents. In fact, a simple entry can be made up of one or more entry items. The first of those entry items is considered the primary item. The entry derives its title and description from the title and description of the primary entry item. Any secondary entry items associated with the simple entry appear as line items for the simple entry.
Last modified $Date: 1999/10/05 21:00:49 $

Version:
$Revision
Author:
Neophytos Iacovou (iacovou@ancept.com), George Reese (george@ancept.com)

Field Summary
static java.lang.String CRT_CLASS
          The concrete class.
static java.lang.String DESCRIPTION
          The description attribute.
static java.lang.String ENTRY
          The entry attribute.
static java.lang.String LINE_DESC
          The lineDescription attribute.
static java.lang.String PROPERTIES
          The properties attribute.
static java.lang.String TITLE
          The entry title.
 
Method Summary
 java.lang.String getDescription(java.util.Locale loc)
          Provides the description for this entry item as if it were a primary item in an entry.
 SimpleEntryReference getEntry()
          Provides the entry that owns this entry item.
 java.lang.String getLineDescription(java.util.Locale loc)
          Provides the description of this entry item as if it were a line item in the simple entry in which it appears.
 java.util.Properties getProperties()
          Provides the properties associated with this entry item.
 java.lang.String getTitle(java.util.Locale loc)
          Provides the title for this entry item as if it were a primary item in an entry.
 
Methods inherited from interface com.imaginary.lwp.Entity
getLastUpdateID, getLastUpdateTime, getObjectID, getReference, remove
 

Field Detail

CRT_CLASS

public static final java.lang.String CRT_CLASS
The concrete class.

DESCRIPTION

public static final java.lang.String DESCRIPTION
The description attribute.

ENTRY

public static final java.lang.String ENTRY
The entry attribute.

LINE_DESC

public static final java.lang.String LINE_DESC
The lineDescription attribute.

PROPERTIES

public static final java.lang.String PROPERTIES
The properties attribute.

TITLE

public static final java.lang.String TITLE
The entry title.
Method Detail

getDescription

public java.lang.String getDescription(java.util.Locale loc)
                                throws java.rmi.RemoteException
Provides the description for this entry item as if it were a primary item in an entry. This is generally implemented by delegating to a method in the real world thing this entry item represents.
Parameters:
loc - the locale for which a description translation is desired
Returns:
the entry item description
Throws:
java.rmi.RemoteException - a network error occurred

getEntry

public SimpleEntryReference getEntry()
                              throws java.rmi.RemoteException
Provides the entry that owns this entry item.
Returns:
the owning entry
Throws:
java.rmi.RemoteException - a network error occurred

getLineDescription

public java.lang.String getLineDescription(java.util.Locale loc)
                                    throws java.rmi.RemoteException
Provides the description of this entry item as if it were a line item in the simple entry in which it appears.
Parameters:
loc - the locale for which the description should be translated
Returns:
the line description for the entry item
Throws:
java.rmi.RemoteException - a network error occurred

getProperties

public java.util.Properties getProperties()
                                   throws java.rmi.RemoteException
Provides the properties associated with this entry item. Properties are values originally retrieved from the referent object (e.g. like the price from a product) that may be needed to formulate the title, descritpion, or line description of an entry item.
Returns:
the properties for this entry item
Throws:
java.rmi.RemoteException - a network error occurred

getTitle

public java.lang.String getTitle(java.util.Locale loc)
                          throws java.rmi.RemoteException
Provides the title for this entry item as if it were a primary item in an entry. This is generally implemented by delegating to a method in the referent for this entry item (e.g. by delegating to the product name).
Parameters:
loc - the locale for which the title should be translated, if possible
Returns:
the entry item title
Throws:
java.rmi.RemoteException - a network error occurred