com.jwpepper.cat
Class EntryReference

java.lang.Object
  |
  +--com.imaginary.lwp.BaseReference
        |
        +--com.jwpepper.cat.EntryReference
Direct Known Subclasses:
CompositeEntryReference, SimpleEntryReference

public abstract class EntryReference
extends BaseReference

Provides the client view of an entry business component.
Last modified $Date: 1999/10/05 17:13:06 $

Version:
$Revision
Author:
Neophytos Iacovou (iacovou@ancept.com), George Reese (george@ancept.com)
See Also:
Entry, Serialized Form

Constructor Summary
EntryReference()
          Empty constructor required by serialization.
EntryReference(Entry ent)
          Constructs a new reference associated with the specified entry entity.
EntryReference(long oid)
          Constructs a new reference associated with the entry having the specified objectID.
 
Method Summary
 void assign(long oid, com.sun.java.util.collections.HashMap vals)
          Assigns a new reference preloaded with the attributes in the specified HashMap.
 CatalogReference getCatalog()
          Provides the catalog in which this entry has been placed by delegating to the method of the same name in the associated entity object.
 java.lang.String getDescription(java.util.Locale loc)
          Provides a description of the entry by delegating to the method of the same name in the associated entity object.
 CompositeEntryReference getParent()
          Provides the parent for this entry.
 java.lang.String getTitle(java.util.Locale loc)
          Provides the title for the entry by delegating to the method of the same name in the associated entity object.
 
Methods inherited from class com.imaginary.lwp.BaseReference
assign, assign, get, getEntity, getLastUpdateID, getLastUpdateTime, getObjectID, put, reconnect
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EntryReference

public EntryReference()
Empty constructor required by serialization.

EntryReference

public EntryReference(long oid)
Constructs a new reference associated with the entry having the specified objectID.
Parameters:
oid - the objectID of the entry to which this reference delegates

EntryReference

public EntryReference(Entry ent)
               throws java.rmi.RemoteException
Constructs a new reference associated with the specified entry entity.
Parameters:
ent - the entry entity to associate this reference with
Throws:
java.rmi.RemoteException - a network error occurred
Method Detail

assign

public void assign(long oid,
                   com.sun.java.util.collections.HashMap vals)
Assigns a new reference preloaded with the attributes in the specified HashMap.
Parameters:
oid - the objectID of the entry
vals - the values to preload the reference with
Overrides:
assign in class BaseReference

getCatalog

public CatalogReference getCatalog()
                            throws java.rmi.RemoteException
Provides the catalog in which this entry has been placed by delegating to the method of the same name in the associated entity object.
Returns:
the catalog in which this entry is placed
Throws:
java.rmi.RemoteException; -  

getDescription

public java.lang.String getDescription(java.util.Locale loc)
                                throws java.rmi.RemoteException
Provides a description of the entry by delegating to the method of the same name in the associated entity object.
Parameters:
loc - the locale for which a translation is desired
Returns:
a description of the entry
Throws:
java.rmi.RemoteException - a network error occurred

getParent

public CompositeEntryReference getParent()
                                  throws java.rmi.RemoteException
Provides the parent for this entry.
Returns:
the entry's parent
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 the entry by delegating to the method of the same name in the associated entity object.
Parameters:
loc - the locale for which a translation is desired
Returns:
the entry title
Throws:
java.rmi.RemoteException - a network error occurred