com.jwpepper.inv
Interface Annotation

All Known Implementing Classes:
AnnotationImpl

public abstract interface Annotation
extends Entity

This interface defines the Annotation Object.
Last Modified $Date: 1999/10/05 21:05:36 $

Version:
$Revision: 1.6 $
Author:
Robert Schmid (robert@ancept.com)

Field Summary
static java.lang.String LOCALE
           
static java.lang.String MIMETYPE
           
static java.lang.String PRODUCTS
           
static java.lang.String TEXT
           
 
Method Summary
 void addProduct(Identifier id, Product prd)
          This method adds a Product to a collection of Products that the Annotation belongs to.
 void create(Identifier id, java.util.Locale loc, java.lang.String txt, java.lang.String mime)
          This method creates a new Annotation Object and sets its attributes.
 java.util.Locale getLocale()
          This method returns the Locale Object.
 java.lang.String getMimeType()
          This method returns the Annotation String.
 java.lang.String getText()
          This method returns the Annotation String.
 com.sun.java.util.collections.Iterator products()
          This method returns an iterator over the products collection.
 void removeProduct(Identifier id, Product prd)
          This method removes a Product from a collection of Products that the Annotation belongs to.
 
Methods inherited from interface com.imaginary.lwp.Entity
getLastUpdateID, getLastUpdateTime, getObjectID, getReference, remove
 

Field Detail

LOCALE

public static final java.lang.String LOCALE

TEXT

public static final java.lang.String TEXT

MIMETYPE

public static final java.lang.String MIMETYPE

PRODUCTS

public static final java.lang.String PRODUCTS
Method Detail

addProduct

public void addProduct(Identifier id,
                       Product prd)
                throws PersistenceException,
                       java.rmi.RemoteException
This method adds a Product to a collection of Products that the Annotation belongs to.
Parameters:
id - An identifer object for the Annotation
prd - A Product object to add to the collection
Throws:
PersistenceException - If an error occurs in the Lightweight Persistence Engine
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

create

public void create(Identifier id,
                   java.util.Locale loc,
                   java.lang.String txt,
                   java.lang.String mime)
            throws CreateException,
                   java.rmi.RemoteException,
                   PersistenceException
This method creates a new Annotation Object and sets its attributes.
Parameters:
id - An identifer object for the Annotation
loc - Country/Language Information
txt - The text of the Annotation
mime - The mimetype of the Annotation
Throws:
PersistenceException - If an error occurs in the Lightweight Persistence Engine
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

getLocale

public java.util.Locale getLocale()
                           throws java.rmi.RemoteException
This method returns the Locale Object.
Returns:
A Locale Object
Throws:
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

getText

public java.lang.String getText()
                         throws java.rmi.RemoteException
This method returns the Annotation String.
Returns:
A String containing the text of the Annotation
Throws:
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

getMimeType

public java.lang.String getMimeType()
                             throws java.rmi.RemoteException
This method returns the Annotation String.
Returns:
String A String containing the MimeType of the Annotation
Throws:
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

products

public com.sun.java.util.collections.Iterator products()
                                                throws java.rmi.RemoteException
This method returns an iterator over the products collection.
Returns:
An iterator of the collection of products
Throws:
java.rmi.RemoteException - If an error occurs in the Remote Method Interface

removeProduct

public void removeProduct(Identifier id,
                          Product prd)
                   throws PersistenceException,
                          java.rmi.RemoteException
This method removes a Product from a collection of Products that the Annotation belongs to.
Parameters:
id - An identifer object for the Annotation
prd - A Product object to add to the collection
Throws:
PersistenceException - If an error occurs in the Lightweight Persistence Engine
java.rmi.RemoteException - If an error occurs in the Remote Method Interface