wt.recent
Class StandardRecentlyVisitedService

java.lang.Object
  wt.services.StandardManager
      wt.recent.StandardRecentlyVisitedService

All Implemented Interfaces:

Serializable, NetFactor, RecentlyVisitedService, wt.services.Manager

public class StandardRecentlyVisitedService
extends StandardManager
implements RecentlyVisitedService, Serializable

Service implementation for recently accessed objects/containers.

Use the newStandardRecentlyVisitedService static factory method(s), not the StandardRecentlyVisitedService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Method Summary

void	addRecentlyVisitedContainer(WTContainer wtc) Add the given container as the most recently accessed one for the corresponding type.
void	addRecentlyVisitedContainer(WTContainer wtc, String type) Add the given container as the most recently accessed one for the given type.
void	addRecentlyVisitedContainerByOid(ObjectIdentifier oid) Add the container corresponding to given ObjectIdentifier as the most recently accessed one for the corresponding type.
void	addRecentlyVisitedObject(WTObject a) Add the given object as the most recently accessed one.
void	addRecentlyVisitedObjectByOid(ObjectIdentifier oid) Add the object corresponding to given ObjectIdentifier as the most recently accessed one.
ObjectVisitedInfo	getLastVisitedContainer() Returns the most recently accessed container.
ObjectVisitedInfo	getRecentlyVisitedContainer(String type) Gets the most recently accessed container for given type.
Vector	getRecentlyVisitedContainerStack(String type) Gets all the most recently accessed containers for given type.
int	getRecentlyVisitedContainerStackSize(String type) Returns the setting for maximum number of conainers as part of stack of recently visited containers of given type.
ObjectVisitedInfo	getRecentlyVisitedObject() Returns the most recently accessed object.
Vector	getRecentlyVisitedObjectStack() Gets all the most recently accessed objects currently in the preference.
int	getRecentlyVisitedObjectStackSize() Returns the setting for maximum number of objects as part of stack of recently visited objects.
void	setLastVisitedContainer(WTContainer wtc) Sets the given container as the most recently accessed container.
void	setRecentlyVisitedContainerStackSize(int i, String type) Sets the maximum number of containers as part of stack of recently visited containers for given type.
void	setRecentlyVisitedObjectStackSize(int i) Sets the maximum number of objects as part of stack of recently visited objects.

Methods inherited from class wt.services.StandardManager

getManagerService, getManagerStatus, getName, getStartupType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addRecentlyVisitedContainer

public void addRecentlyVisitedContainer(WTContainer wtc)
                                 throws WTException

Add the given container as the most recently accessed one for the corresponding type.

Supported API: true

Specified by:

addRecentlyVisitedContainer in interface RecentlyVisitedService

Parameters:

wtc -

Throws:

WTException

addRecentlyVisitedContainer

public void addRecentlyVisitedContainer(WTContainer wtc,
                                        String type)
                                 throws WTException

Add the given container as the most recently accessed one for the given type.

Supported API: true

Specified by:

addRecentlyVisitedContainer in interface RecentlyVisitedService

Parameters:

wtc -

type -

Throws:

WTException

addRecentlyVisitedObject

public void addRecentlyVisitedObject(WTObject a)
                              throws WTException

Add the given object as the most recently accessed one.

Supported API: true

Specified by:

addRecentlyVisitedObject in interface RecentlyVisitedService

Parameters:

a -

Throws:

WTException

getLastVisitedContainer

public ObjectVisitedInfo getLastVisitedContainer()
                                          throws WTException

Returns the most recently accessed container.

Supported API: true

Specified by:

getLastVisitedContainer in interface RecentlyVisitedService

Returns:

ObjectVisitedInfo

Throws:

WTException

getRecentlyVisitedContainer

public ObjectVisitedInfo getRecentlyVisitedContainer(String type)
                                              throws WTException

Gets the most recently accessed container for given type.

Supported API: true

Specified by:

getRecentlyVisitedContainer in interface RecentlyVisitedService

Parameters:

type -

Returns:

ObjectVisitedInfo

Throws:

WTException

getRecentlyVisitedContainerStack

public Vector getRecentlyVisitedContainerStack(String type)
                                        throws WTException

Gets all the most recently accessed containers for given type. The first object in the returned Vector would be the latest accessed container & so on.

Supported API: true

Specified by:

getRecentlyVisitedContainerStack in interface RecentlyVisitedService

Parameters:

type -

Returns:

Vector

Throws:

WTException

getRecentlyVisitedObject

public ObjectVisitedInfo getRecentlyVisitedObject()
                                           throws WTException

Returns the most recently accessed object.

Supported API: true

Specified by:

getRecentlyVisitedObject in interface RecentlyVisitedService

Returns:

ObjectVisitedInfo

Throws:

WTException

getRecentlyVisitedObjectStack

public Vector getRecentlyVisitedObjectStack()
                                     throws WTException

Gets all the most recently accessed objects currently in the preference. The first object in the returned Vector would be the most recently accessed object & so on.

Supported API: true

Specified by:

getRecentlyVisitedObjectStack in interface RecentlyVisitedService

Returns:

Vector

Throws:

WTException

setLastVisitedContainer

public void setLastVisitedContainer(WTContainer wtc)
                             throws WTException

Sets the given container as the most recently accessed container.

Supported API: true

Specified by:

setLastVisitedContainer in interface RecentlyVisitedService

Parameters:

wtc -

Throws:

WTException

setRecentlyVisitedContainerStackSize

public void setRecentlyVisitedContainerStackSize(int i,
                                                 String type)
                                          throws WTException

Sets the maximum number of containers as part of stack of recently visited containers for given type.

Supported API: true

Specified by:

setRecentlyVisitedContainerStackSize in interface RecentlyVisitedService

Parameters:

i -

type -

Throws:

WTException

setRecentlyVisitedObjectStackSize

public void setRecentlyVisitedObjectStackSize(int i)
                                       throws WTException

Sets the maximum number of objects as part of stack of recently visited objects.

Supported API: true

Specified by:

setRecentlyVisitedObjectStackSize in interface RecentlyVisitedService

Parameters:

i -

Throws:

WTException

getRecentlyVisitedContainerStackSize

public int getRecentlyVisitedContainerStackSize(String type)
                                         throws WTException

Returns the setting for maximum number of conainers as part of stack of recently visited containers of given type.

Supported API: true

Specified by:

getRecentlyVisitedContainerStackSize in interface RecentlyVisitedService

Parameters:

type -

Returns:

int

Throws:

WTException

getRecentlyVisitedObjectStackSize

public int getRecentlyVisitedObjectStackSize()
                                      throws WTException

Returns the setting for maximum number of objects as part of stack of recently visited objects.

Supported API: true

Specified by:

getRecentlyVisitedObjectStackSize in interface RecentlyVisitedService

Returns:

int

Throws:

WTException

addRecentlyVisitedObjectByOid

public void addRecentlyVisitedObjectByOid(ObjectIdentifier oid)
                                   throws WTException

Add the object corresponding to given ObjectIdentifier as the most recently accessed one.

Supported API: true

Specified by:

addRecentlyVisitedObjectByOid in interface RecentlyVisitedService

Parameters:

oid -

Throws:

WTException

addRecentlyVisitedContainerByOid

public void addRecentlyVisitedContainerByOid(ObjectIdentifier oid)
                                      throws WTException

Add the container corresponding to given ObjectIdentifier as the most recently accessed one for the corresponding type.

Supported API: true

Specified by:

addRecentlyVisitedContainerByOid in interface RecentlyVisitedService

Parameters:

oid -

Throws:

WTException