wt.recent
Interface RecentlyVisitedService

All Known Implementing Classes:

RecentlyVisitedServiceFwd, StandardRecentlyVisitedService

public interface RecentlyVisitedService

Service for accessing recently visited objects.

Supported API: true

Extendable: false

Method Summary

void	addCustomStackObject(WTObject a, String customStackName) Add the given object to the given custom stack as the most recently accessed one.
Vector	addCustomStackObject(WTObject a, String customStackName, boolean returnStack) Add the given object to the given custom stack as the most recently accessed one and return the stack.
void	addCustomStackObjectByOid(ObjectIdentifier oid, String customStackName) Add the object corresponding to given ObjectIdentifier to the given custom stack as the most recently accessed one.
Vector	addCustomStackObjectByOid(ObjectIdentifier oid, String customStackName, boolean returnStack) Add the object corresponding to given ObjectIdentifier to the given custom stack as the most recently accessed one and return the stack.
void	addRecentlyVisitedContainer(WTContainer wtc) Add the given container as the most recently accessed one for the corresponding type.
Vector	addRecentlyVisitedContainer(WTContainer wtc, boolean returnStack) Add the given container as the most recently accessed one for the corresponding type and return the stack.
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.
Vector	addRecentlyVisitedContainerByOid(ObjectIdentifier oid, boolean returnStack) Add the container corresponding to given ObjectIdentifier as the most recently accessed one for the corresponding type and return the stack.
void	addRecentlyVisitedObject(WTObject a) Add the given object as the most recently accessed one.
Vector	addRecentlyVisitedObject(WTObject a, boolean returnStack) Add the given object as the most recently accessed one and return the stack.
void	addRecentlyVisitedObjectByOid(ObjectIdentifier oid) Add the object corresponding to given ObjectIdentifier as the most recently accessed one.
Vector	addRecentlyVisitedObjectByOid(ObjectIdentifier oid, boolean returnStack) Add the object corresponding to given ObjectIdentifier as the most recently accessed one and return the stack.
Boolean	getBypassRecentList() Supported API: false
Vector	getCustomStack(String customStackName) Gets all the most recently accessed objects currently in the given custom stack preference.
Vector	getCustomStack(String classname, String customStackName) Gets all the most recently accessed objects belonging to the classname currently in the given Custom Stack preference.
Vector	getFromDB(String prefName) Deprecated.
ObjectVisitedInfo	getLastVisitedContainer() Returns the most recently accessed container.
ObjectVisitedInfo	getLatestCustomStackObject(String customStackName) Returns the most recently accessed object from given Custom Stack.
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.
Vector	getRecentlyVisitedObjectStack(String classname) Gets all the most recently accessed objects belonging to the classname currently in the preference.
int	getRecentlyVisitedObjectStackSize() Returns the setting for maximum number of objects as part of stack of recently visited objects.
Vector	listCustomStacks() Get all custom stack names as Vector.
void	setBypassRecentList(Boolean bypass) Supported API: false
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

public 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

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

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

Parameters:

a -

Throws:

WTException

getLastVisitedContainer

public ObjectVisitedInfo getLastVisitedContainer()
                                          throws WTException

Returns the most recently accessed container.

Supported API: true

Returns:

ObjectVisitedInfo

Throws:

WTException

getRecentlyVisitedContainer

public 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

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

Parameters:

type -

Returns:

Vector

Throws:

WTException

getRecentlyVisitedObject

public ObjectVisitedInfo getRecentlyVisitedObject()
                                           throws WTException

Returns the most recently accessed object.

Supported API: true

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

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

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

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

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

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

Returns:

int

Throws:

WTException

addCustomStackObject

public void addCustomStackObject(WTObject a,
                                 String customStackName)
                          throws WTException

Add the given object to the given custom stack as the most recently accessed one.

Supported API: false

Parameters:

a -

customStackName -

Throws:

WTException

getLatestCustomStackObject

public ObjectVisitedInfo getLatestCustomStackObject(String customStackName)
                                             throws WTException

Returns the most recently accessed object from given Custom Stack.

Supported API: false

Parameters:

customStackName -

Returns:

ObjectVisitedInfo

Throws:

WTException

getCustomStack

public Vector getCustomStack(String customStackName)
                      throws WTException

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

Supported API: false

Parameters:

customStackName -

Returns:

Vector

Throws:

WTException

listCustomStacks

public Vector listCustomStacks()
                        throws WTException

Get all custom stack names as Vector.

Supported API: false

Returns:

Vector

Throws:

WTException

getCustomStack

public Vector getCustomStack(String classname,
                             String customStackName)
                      throws WTException

Gets all the most recently accessed objects belonging to the classname currently in the given Custom Stack preference. The first object in the returned Vector would be the most recently accessed object & so on.

Supported API: false

Parameters:

classname -

customStackName -

Returns:

Vector

Throws:

WTException

getRecentlyVisitedObjectStack

public Vector getRecentlyVisitedObjectStack(String classname)
                                     throws WTException

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

Supported API: false

Parameters:

classname -

Returns:

Vector

Throws:

WTException

setBypassRecentList

public void setBypassRecentList(Boolean bypass)
                         throws WTException

Supported API: false

Parameters:

bypass -

Throws:

WTException

getBypassRecentList

public Boolean getBypassRecentList()
                            throws WTException

Supported API: false

Returns:

Boolean

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

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

Parameters:

oid -

Throws:

WTException

addCustomStackObjectByOid

public void addCustomStackObjectByOid(ObjectIdentifier oid,
                                      String customStackName)
                               throws WTException

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

Supported API: false

Parameters:

oid -

customStackName -

Throws:

WTException

addRecentlyVisitedObjectByOid

public Vector addRecentlyVisitedObjectByOid(ObjectIdentifier oid,
                                            boolean returnStack)
                                     throws WTException

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

Supported API: false

Parameters:

oid -

returnStack -

Returns:

Vector

Throws:

WTException

addRecentlyVisitedContainer

public Vector addRecentlyVisitedContainer(WTContainer wtc,
                                          boolean returnStack)
                                   throws WTException

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

Supported API: false

Parameters:

wtc -

returnStack -

Returns:

Vector

Throws:

WTException

addCustomStackObjectByOid

public Vector addCustomStackObjectByOid(ObjectIdentifier oid,
                                        String customStackName,
                                        boolean returnStack)
                                 throws WTException

Add the object corresponding to given ObjectIdentifier to the given custom stack as the most recently accessed one and return the stack.

Supported API: false

Parameters:

oid -

customStackName -

returnStack -

Returns:

Vector

Throws:

WTException

addRecentlyVisitedContainerByOid

public Vector addRecentlyVisitedContainerByOid(ObjectIdentifier oid,
                                               boolean returnStack)
                                        throws WTException

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

Supported API: false

Parameters:

oid -

returnStack -

Returns:

Vector

Throws:

WTException

addRecentlyVisitedObject

public Vector addRecentlyVisitedObject(WTObject a,
                                       boolean returnStack)
                                throws WTException

Add the given object as the most recently accessed one and return the stack.

Supported API: false

Parameters:

a -

returnStack -

Returns:

Vector

Throws:

WTException

addCustomStackObject

public Vector addCustomStackObject(WTObject a,
                                   String customStackName,
                                   boolean returnStack)
                            throws WTException

Add the given object to the given custom stack as the most recently accessed one and return the stack.

Supported API: false

Parameters:

a -

customStackName -

returnStack -

Returns:

Vector

Throws:

WTException

getFromDB

public Vector getFromDB(String prefName)
                 throws WTException

Deprecated.

Supported API: false

Parameters:

prefName -

Returns:

Vector

Throws:

WTException