com.jwpepper.cat
Interface Entry

All Known Subinterfaces:
Catalog, CompositeEntry, Section, SimpleEntry
All Known Implementing Classes:
EntryImpl

public abstract interface Entry
extends Entity

The base class of the Entry version of the classic composite pattern. An entry is any piece of a J.W. Pepper catalog. It can be an individual product entry, a section that contains other entries, or the whole catalog itself.
Last modified $Date: 1999/10/05 17:13:06 $

Version:
$Revision
Author:
Neophytos Iacovou (iacovou@ancept.com)

Field Summary
static java.lang.String CRT_CLASS
           
static java.lang.String DESCRIPTION
           
static java.lang.String PARENT
           
static java.lang.String TITLE
           
 
Method Summary
 void create(Identifier id, java.util.Locale loc, java.lang.String ttl, java.lang.String desc)
          Creates a new entry having the specified values.
 void create(Identifier id, java.util.Locale loc, java.lang.String ttl, java.lang.String desc, CompositeEntryReference prnt)
          Creates a new entry having the specified values.
 CatalogReference getCatalog()
          Provides the catalog in which this entry occurs.
 java.lang.String getDescription(java.util.Locale loc)
          Provides a description of the entry.
 CompositeEntryReference getParent()
          Many entries may have parents.
 java.lang.String getTitle(java.util.Locale loc)
           
 
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

DESCRIPTION

public static final java.lang.String DESCRIPTION

PARENT

public static final java.lang.String PARENT

TITLE

public static final java.lang.String TITLE
Method Detail

create

public void create(Identifier id,
                   java.util.Locale loc,
                   java.lang.String ttl,
                   java.lang.String desc)
            throws CreateException,
                   java.rmi.RemoteException
Creates a new entry having the specified values.
Parameters:
id - the client identifier for the transaction.
loc - the locale for the title and description
ttl - the title of the entry
desc - the entry description
Throws:
CreateException - an error occurred creating the entry in the data store
java.rmi.RemoteException - a network error occurred

create

public void create(Identifier id,
                   java.util.Locale loc,
                   java.lang.String ttl,
                   java.lang.String desc,
                   CompositeEntryReference prnt)
            throws CreateException,
                   java.rmi.RemoteException
Creates a new entry having the specified values.
Parameters:
id - the client identifier for the transaction.
loc - the locale for the title and description
ttl - the title of the entry
desc - the entry description
prnt - the parent of this entry
Throws:
CreateException - an error occurred creating the entry in the data store
java.rmi.RemoteException - a network error occurred

getDescription

public java.lang.String getDescription(java.util.Locale loc)
                                throws java.rmi.RemoteException
Provides a description of the entry. This description may appear as the body of the entry in a physical catalog.
Parameters:
loc - the locale for which it should be translated, if possible
Returns:
the entry description
Throws:
java.rmi.RemoteException - a network error occurred

getCatalog

public CatalogReference getCatalog()
                            throws java.rmi.RemoteException
Provides the catalog in which this entry occurs. If this entry is itself a catalog, then it returns itself.
Returns:
the catalog to which this entry belongs
Throws:
java.rmi.RemoteException - a network error occurred

getParent

public CompositeEntryReference getParent()
                                  throws java.rmi.RemoteException
Many entries may have parents. This method provides the parent of this entry.
Returns:
the parent of this entry
Throws:
java.rmi.RemoteException - a network error occurred

getTitle

public java.lang.String getTitle(java.util.Locale loc)
                          throws java.rmi.RemoteException
Parameters:
loc - the locale for which the title should be translated, if possible
Returns:
the title of the entry
Throws:
java.rmi.RemoteException - a network error occurred