com.crystaldecisions.sdk.plugin.desktop.user
Interface IRecentDocuments

All Superinterfaces:

java.util.Collection, ISDKList, java.lang.Iterable, java.util.List

public interface IRecentDocuments
extends ISDKList

The IRecentDocuments interface is used to store list of documents user act on.

Method Summary

IRecentDocument	add(IInfoObject obj) Add document infoobject into the list
IRecentDocument	add(int id, java.lang.String kind) Add document id and the kind of the document into the list
int	getActionType() return the action type of this list
int	getMax() maximum number of items to be kept in this list
boolean	removeByID(int id) remove document from the list by SI_ID
void	setMax(int max) Set maximum number of items to be kept in this list

Methods inherited from interface com.crystaldecisions.sdk.properties.ISDKList

get

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

add

IRecentDocument add(int id,
                    java.lang.String kind)
                    throws SDKException

Add document id and the kind of the document into the list

Parameters:

id - as the SI_ID of the document.

kind - as the SI_KIND of the document

Returns:

IRecentDocument object represent the document.

Throws:

SDKException

add

IRecentDocument add(IInfoObject obj)
                    throws SDKException

Add document infoobject into the list

Parameters:

obj - as the infoobject of the document.

Returns:

IRecentDocument object represent the document.

Throws:

SDKException

removeByID

boolean removeByID(int id)

remove document from the list by SI_ID

Parameters:

id - as SI_ID of the document to be removed.

Returns:

true if the remove succeed.

getMax

int getMax()

maximum number of items to be kept in this list

Returns:

int the maxium number of items can be kept in the list..

setMax

void setMax(int max)

Set maximum number of items to be kept in this list

Parameters:

max - the maxium number of items can be kept in the list..

getActionType

int getActionType()

return the action type of this list

Returns:

int the action type of this list.