wt.recent
Interface RecentlyVisitedService

All Known Implementing Classes:
StandardRecentlyVisitedService

public interface RecentlyVisitedService

Service for accessing recently visited objects.

Supported API: true

Extendable: false


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.
 

Method Detail

addRecentlyVisitedContainer

void addRecentlyVisitedContainer(WTContainer wtc)
                                 throws WTException
Add the given container as the most recently accessed one for the corresponding type.

Supported API: true

Parameters:
wtc -
Throws:
WTException

addRecentlyVisitedContainer

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

Parameters:
wtc -
type -
Throws:
WTException

addRecentlyVisitedObject

void addRecentlyVisitedObject(WTObject a)
                              throws WTException
Add the given object as the most recently accessed one.

Supported API: true

Parameters:
a -
Throws:
WTException

getLastVisitedContainer

ObjectVisitedInfo getLastVisitedContainer()
                                          throws WTException
Returns the most recently accessed container.

Supported API: true

Returns:
ObjectVisitedInfo
Throws:
WTException

getRecentlyVisitedContainer

ObjectVisitedInfo getRecentlyVisitedContainer(String type)
                                              throws WTException
Gets the most recently accessed container for given type.

Supported API: true

Parameters:
type -
Returns:
ObjectVisitedInfo
Throws:
WTException

getRecentlyVisitedContainerStack

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

Parameters:
type -
Returns:
Vector
Throws:
WTException

getRecentlyVisitedObject

ObjectVisitedInfo getRecentlyVisitedObject()
                                           throws WTException
Returns the most recently accessed object.

Supported API: true

Returns:
ObjectVisitedInfo
Throws:
WTException

getRecentlyVisitedObjectStack

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

Returns:
Vector
Throws:
WTException

setLastVisitedContainer

void setLastVisitedContainer(WTContainer wtc)
                             throws WTException
Sets the given container as the most recently accessed container.

Supported API: true

Parameters:
wtc -
Throws:
WTException

setRecentlyVisitedContainerStackSize

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

Parameters:
i -
type -
Throws:
WTException

setRecentlyVisitedObjectStackSize

void setRecentlyVisitedObjectStackSize(int i)
                                       throws WTException
Sets the maximum number of objects as part of stack of recently visited objects.

Supported API: true

Parameters:
i -
Throws:
WTException

getRecentlyVisitedContainerStackSize

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

Parameters:
type -
Returns:
int
Throws:
WTException

getRecentlyVisitedObjectStackSize

int getRecentlyVisitedObjectStackSize()
                                      throws WTException
Returns the setting for maximum number of objects as part of stack of recently visited objects.

Supported API: true

Returns:
int
Throws:
WTException

addRecentlyVisitedObjectByOid

void addRecentlyVisitedObjectByOid(ObjectIdentifier oid)
                                   throws WTException
Add the object corresponding to given ObjectIdentifier as the most recently accessed one.

Supported API: true

Parameters:
oid -
Throws:
WTException

addRecentlyVisitedContainerByOid

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

Parameters:
oid -
Throws:
WTException