com.sas.sasserver
Class _rprxRemoteDesignTimeBookmarkManager

com.sas.sasserver._rprxRemoteDesignTimeBookmarkManager
All Implemented Interfaces:
com.sas.beans.IntrospectInterfaceForBeanInfo, com.sas.beans.PropertyChangeSource, com.sas.beans.VetoableChangeSource, com.sas.ComponentInterface, com.sas.LinkPropertiesInterface, com.sas.ModelInterface, com.sas.PublicClonable, com.sas.rmi.ConnectionLoginInterface, com.sas.rmi.DesignTimeInf, com.sas.rmi.RocfRemoteObject, BookmarkManagerInterface, RemoteBookmarkManagerInterface, com.sas.ViewInterface, MultipleValueEventSourceInterface, java.beans.PropertyChangeListener, java.io.ObjectInputValidation, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class _rprxRemoteDesignTimeBookmarkManager
implements BookmarkManagerInterface, RemoteBookmarkManagerInterface, com.sas.ComponentInterface

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.sas.sasserver.BookmarkManagerInterface
contextClasspath, INVALID_PASSWORD, NEW_USER, VALIDATED
 
Constructor Summary
_rprxRemoteDesignTimeBookmarkManager()
           
 
Method Summary
 com.sas.collection.hlist.HListInterface _getBookmarkData(com.sas.collection.hlist.HListInterface p1)
           
 com.sas.collection.hlist.HListInterface _getBookmarks(long p1, java.lang.String p2)
           
 com.sas.collection.hlist.HListInterface _getBookmarks(long p1, java.lang.String p2, java.lang.String p3)
           
 java.lang.String[] _getMessage()
           
 com.sas.collection.hlist.HListInterface _getUsers(long p1, boolean p2)
           
 int _RemoteObject_version()
           
 long _setBookmarks(java.lang.String p1, long p2, java.lang.String p3, java.lang.String p4, com.sas.collection.hlist.HListInterface p5)
           
 long _validateUser(java.lang.String p1, java.lang.String p2)
           
 java.lang.Object clone()
          Returns a clone of the original design time component called upon
 java.lang.Object getBookmarkData(java.lang.Object p1)
          A list (has an eis entry name) passed in to get the real application list
 java.lang.Object getBookmarks(long p1, java.lang.String p2)
          Get the list of bookmarks and folders (public only) for a given document and username
 java.lang.Object getBookmarks(long p1, java.lang.String p2, java.lang.String p3)
          Get the list of bookmarks and folders (public and private) for a given document and username only if the password is valid
 java.lang.String[] getUsers(long p1, boolean p2)
          Get all the users who have registered bookmarks for a given document.
 void setBookmarks(java.lang.String p1, long p2, java.lang.String p3, java.lang.String p4, java.lang.Object p5)
          Set the bookmarks for a given user.
 int validateUser(java.lang.String p1, java.lang.String p2)
          Validate the password for a given username.
 

Constructor Detail

_rprxRemoteDesignTimeBookmarkManager

public _rprxRemoteDesignTimeBookmarkManager()
Method Detail

_RemoteObject_version

public int _RemoteObject_version()
Specified by:
_RemoteObject_version in interface com.sas.rmi.RocfRemoteObject
Specified by:
_RemoteObject_version in class com.sas.rmi.RemoteBaseClient

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Description copied from class: RemoteDesignTimeBaseClient
Returns a clone of the original design time component called upon

Specified by:
clone in interface com.sas.PublicClonable
Overrides:
clone in class com.sas.rmi.RemoteDesignTimeBaseClient
Returns:
a clone object
Throws:
java.lang.CloneNotSupportedException - if the model attached to the component being cloned will not allow the clone to attach.

getBookmarks

public java.lang.Object getBookmarks(long p1,
                                     java.lang.String p2)
                              throws BookmarkException
Description copied from interface: BookmarkManagerInterface
Get the list of bookmarks and folders (public only) for a given document and username

Specified by:
getBookmarks in interface BookmarkManagerInterface
Parameters:
p1 - of the document associated with the bookmark
p2 - 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

public java.lang.Object getBookmarks(long p1,
                                     java.lang.String p2,
                                     java.lang.String p3)
                              throws BookmarkException
Description copied from interface: BookmarkManagerInterface
Get the list of bookmarks and folders (public and private) for a given document and username only if the password is valid

Specified by:
getBookmarks in interface BookmarkManagerInterface
Parameters:
p1 - of the document associated with the bookmark
p2 - of the user for the document
p3 - for the user
Returns:
HList containing lists of Bookmark information
Throws:
BookmarkException - if the password is invalid for the userName

setBookmarks

public void setBookmarks(java.lang.String p1,
                         long p2,
                         java.lang.String p3,
                         java.lang.String p4,
                         java.lang.Object p5)
                  throws BookmarkException
Description copied from interface: BookmarkManagerInterface
Set the bookmarks for a given user. If password is invalid for an existing user BookmarkException is thrown

Specified by:
setBookmarks in interface BookmarkManagerInterface
Parameters:
p1 - associated with the bookmark
p2 - associated with the bookmark
p3 - of the user for the document
p4 - for the user
Throws:
BookmarkException

getUsers

public java.lang.String[] getUsers(long p1,
                                   boolean p2)
                            throws BookmarkException
Description copied from interface: BookmarkManagerInterface
Get all the users who have registered bookmarks for a given document.

Specified by:
getUsers in interface BookmarkManagerInterface
Parameters:
p1 - for the users list
p2 - 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:
BookmarkException

validateUser

public int validateUser(java.lang.String p1,
                        java.lang.String p2)
                 throws BookmarkException
Description copied from interface: BookmarkManagerInterface
Validate the password for a given username.

Specified by:
validateUser in interface BookmarkManagerInterface
Parameters:
p1 - to validate the password for.
p2 - 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

public java.lang.Object getBookmarkData(java.lang.Object p1)
                                 throws BookmarkException
Description copied from interface: BookmarkManagerInterface
A list (has an eis entry name) passed in to get the real application list

Specified by:
getBookmarkData in interface BookmarkManagerInterface
Returns:
An application list associated woith the entry name list
Throws:
BookmarkException

_getBookmarks

public com.sas.collection.hlist.HListInterface _getBookmarks(long p1,
                                                             java.lang.String p2)
Specified by:
_getBookmarks in interface RemoteBookmarkManagerInterface

_getBookmarks

public com.sas.collection.hlist.HListInterface _getBookmarks(long p1,
                                                             java.lang.String p2,
                                                             java.lang.String p3)
Specified by:
_getBookmarks in interface RemoteBookmarkManagerInterface

_setBookmarks

public long _setBookmarks(java.lang.String p1,
                          long p2,
                          java.lang.String p3,
                          java.lang.String p4,
                          com.sas.collection.hlist.HListInterface p5)
Specified by:
_setBookmarks in interface RemoteBookmarkManagerInterface

_getUsers

public com.sas.collection.hlist.HListInterface _getUsers(long p1,
                                                         boolean p2)
Specified by:
_getUsers in interface RemoteBookmarkManagerInterface

_validateUser

public long _validateUser(java.lang.String p1,
                          java.lang.String p2)
Specified by:
_validateUser in interface RemoteBookmarkManagerInterface

_getMessage

public java.lang.String[] _getMessage()
Specified by:
_getMessage in interface RemoteBookmarkManagerInterface

_getBookmarkData

public com.sas.collection.hlist.HListInterface _getBookmarkData(com.sas.collection.hlist.HListInterface p1)
Specified by:
_getBookmarkData in interface RemoteBookmarkManagerInterface



Copyright © 2009 SAS Institute Inc. All Rights Reserved.