com.sas.sasserver
Interface BookmarkManagerInterface

All Superinterfaces:

ComponentInterface, java.util.EventListener, LinkPropertiesInterface, ModelInterface, java.io.ObjectInputValidation, java.beans.PropertyChangeListener, com.sas.beans.PropertyChangeSource, RemoteBookmarkManagerInterface, java.io.Serializable, com.sas.beans.VetoableChangeSource, ViewInterface

All Known Subinterfaces:

BookmarkManagerV2Interface

All Known Implementing Classes:

_rprxIOMBookmarkManager, _rprxIOMBookmarkManagerV2, _rprxJ2BookmarkManager, _rprxJ2BookmarkManagerV2, _rprxRemoteBookmarkManagerClient, _rprxRemoteBookmarkManagerV2Client, _rprxRemoteDesignTimeBookmarkManager, _rprxRemoteDesignTimeBookmarkManagerV2

public interface BookmarkManagerInterface
extends RemoteBookmarkManagerInterface, ComponentInterface

Field Summary

static java.lang.String	contextClasspath
static int	INVALID_PASSWORD
static int	NEW_USER
static int	VALIDATED

Method Summary

abstract java.lang.Object	getBookmarkData(java.lang.Object bookmarkID) A list (has an eis entry name) passed in to get the real application list
abstract java.lang.Object	getBookmarks(long documentID, java.lang.String userName) Get the list of bookmarks and folders (public only) for a given document and username
abstract java.lang.Object	getBookmarks(long documentID, java.lang.String userName, java.lang.String password) Get the list of bookmarks and folders (public and private) for a given document and username only if the password is valid
abstract java.lang.String[]	getUsers(long documentID, boolean all) Get all the users who have registered bookmarks for a given document.
abstract void	setBookmarks(java.lang.String documentName, long documentID, java.lang.String userName, java.lang.String password, java.lang.Object bookmarks) Set the bookmarks for a given user.
abstract int	validateUser(java.lang.String userName, java.lang.String password) Validate the password for a given username.

Methods inherited from interface com.sas.sasserver.RemoteBookmarkManagerInterface

_getBookmarkData, _getBookmarks, _getBookmarks, _getMessage, _getUsers, _setBookmarks, _validateUser

Methods inherited from interface com.sas.ComponentInterface

addPropertyChangeListener, addVetoableChangeListener, anyPropertyChangeListeners, dumpComponent, firePropertyChange, firePropertyChange, fireVetoableChange, getComponentDescription, getComponentSupportInfo, initialize, initializeComponent, isDesignTime, removePropertyChangeListener, removeVetoableChangeListener, setComponentDescription, setComponentSupportInfo, setDefaultValues

Methods inherited from interface com.sas.ViewInterface

attachModel, detachModel, getModelInterface, getRequiredInterfaces, getViewInterfaceSupportInfo, refresh, removeInterfaceTraps, setModelInterface, setRequiredInterfaces, setViewInterfaceSupportInfo, supportsRequiredInterfaces, trapInterfaceEvents

Methods inherited from interface com.sas.ModelInterface

attachView, detachView

Methods inherited from interface com.sas.LinkPropertiesInterface

addLink, getLinkInfo, isLinked, queryLinks, queryLinks, removeAllLinks, removeLink, setLinkInfo

Field Detail

contextClasspath

static final java.lang.String contextClasspath

See Also:

Constant Field Values

VALIDATED

static final int VALIDATED

See Also:

Constant Field Values

NEW_USER

static final int NEW_USER

See Also:

Constant Field Values

INVALID_PASSWORD

static final int INVALID_PASSWORD

See Also:

Constant Field Values

Method Detail

getBookmarks

java.lang.Object getBookmarks(long documentID,
                              java.lang.String userName)
                              throws BookmarkException

Get the list of bookmarks and folders (public only) for a given document and username

Parameters:

documentID - of the document associated with the bookmark

userName - of the user for the document

Returns:

HList containing lists of Bookmark information

Throws:

BookmarkException - if unable to get list of bookmarks from server

getBookmarks

java.lang.Object getBookmarks(long documentID,
                              java.lang.String userName,
                              java.lang.String password)
                              throws BookmarkException

Get the list of bookmarks and folders (public and private) for a given document and username only if the password is valid

Parameters:

documentID - of the document associated with the bookmark

userName - of the user for the document

password - for the user

Returns:

HList containing lists of Bookmark information

Throws:

BookmarkException - if the password is invalid for the userName

setBookmarks

void setBookmarks(java.lang.String documentName,
                  long documentID,
                  java.lang.String userName,
                  java.lang.String password,
                  java.lang.Object bookmarks)
                  throws BookmarkException

Set the bookmarks for a given user. If password is invalid for an existing user BookmarkException is thrown

Parameters:

documentID - associated with the bookmark

documentName - associated with the bookmark

userName - of the user for the document

password - for the user

HList - containing lists of Bookmark information

Throws:

BookmarkExcpetion - if the password is invalid for an existing user

BookmarkException

getUsers

java.lang.String[] getUsers(long documentID,
                            boolean all)
                            throws BookmarkException

Get all the users who have registered bookmarks for a given document.

Parameters:

documentID - for the users list

all - the users registered for a given document. If false, only return those users who have registered "public" bookmarks.

Returns:

an array of user Names for a given document.

Throws:

BookmarkExcpetion - if unable to get list of users from server

BookmarkException

validateUser

int validateUser(java.lang.String userName,
                 java.lang.String password)
                 throws BookmarkException

Validate the password for a given username.

Parameters:

userName - to validate the password for.

password - to validate for a given username.

Returns:

integer indicating if the password is valid or not. Possible return values are VALIDATED=0, NEW_USER =1, INVALID_PASSWORD=-1.

Throws:

BookmarkException - if error validating user

getBookmarkData

java.lang.Object getBookmarkData(java.lang.Object bookmarkID)
                                 throws BookmarkException

A list (has an eis entry name) passed in to get the real application list

Parameters:

bookmarkId - a list with entry name

Returns:

An application list associated woith the entry name list

Throws:

BookmarkException