ogre.dms.service
Interface SubscribingService

All Superinterfaces:

Remote

public interface SubscribingService
extends Remote

Method Summary

DMSResult	commitSubscribe(String userID, String subject) subscribe a subject
DMSResult	commitUnSubscribe(String userID, String subject) unsubscribe a subject
DMSResult	deleteSubscriptionBoardInfo(Vector subscriptionKeyList)
DMSResult	forceCommitSubscribe(String userID, String subject) Deprecated. V2.2 HotFix_82 use forceCommitSubscribe(String, String, String) instead.
DMSResult	forceCommitSubscribe(String subscriberID, String subject, String ownerID) forceSubscribe a subject retrieve without check initPermission
DMSResult	forceCommitUnSubscribe(String userID, String subject) force unsubscribe a subject without check initPermission the user must subscribe the subject
SubscriptionBoardInfo	getSubscriptionBoardInfo(String subscriptionKey)
Vector	getSubscriptionBoardInfoByMemID(String memID)
DMSResult	initAddSubscriberToDocument(String userID, String documentKey) Check user have permission to add subscribe to the document.
DMSResult	initSubscribe(String userID, String subject) to a folder the user requires "Reader" on the subject or "Owner" on its parentfolder to subscribe to a document the user requires "Viewer" on the subject or "Owner on its parentfolder "to subscribe
DMSResult	initUnSubscribe(String userID, String subject) 1. the user must have subscribe the subject
boolean	isAlive()
Vector	retrieveSubscribeMember(String subject) retrieve member ID from subscribe add by JC
void	updateSubscriptionBoardInfo(Vector subscriptionBoardInfoList)

Method Detail

initSubscribe

DMSResult initSubscribe(String userID,
                        String subject)
                        throws RemoteException

to a folder the user requires "Reader" on the subject or "Owner" on its parentfolder to subscribe to a document the user requires "Viewer" on the subject or "Owner on its parentfolder "to subscribe

Throws:

RemoteException

initUnSubscribe

DMSResult initUnSubscribe(String userID,
                          String subject)
                          throws RemoteException

1. the user must have subscribe the subject

Throws:

RemoteException

retrieveSubscribeMember

Vector retrieveSubscribeMember(String subject)
                               throws RemoteException

retrieve member ID from subscribe add by JC

Parameters:

subject - the subject can be FolderID or DocumentID

Throws:

RemoteException

initAddSubscriberToDocument

DMSResult initAddSubscriberToDocument(String userID,
                                      String documentKey)
                                      throws RemoteException

Check user have permission to add subscribe to the document. Refers to ISODMS-764.

Returns:

Throws:

RemoteException

forceCommitSubscribe

DMSResult forceCommitSubscribe(String userID,
                               String subject)
                               throws RemoteException

Deprecated. V2.2 HotFix_82 use forceCommitSubscribe(String, String, String) instead.

forceSubscribe a subject retrieve without check initPermission

Parameters:

subject - the subject can be FolderID or DocumentID

Throws:

RemoteException

forceCommitSubscribe

DMSResult forceCommitSubscribe(String subscriberID,
                               String subject,
                               String ownerID)
                               throws RemoteException

forceSubscribe a subject retrieve without check initPermission

Parameters:

subject - the subject can be FolderID or DocumentID

subscriberID -

subject -

ownerID - who sets this subscription

Returns:

DMSResult

Throws:

RemoteException

Since:

V2.2 HotFix_82

commitSubscribe

DMSResult commitSubscribe(String userID,
                          String subject)
                          throws RemoteException

subscribe a subject

Throws:

RemoteException

forceCommitUnSubscribe

DMSResult forceCommitUnSubscribe(String userID,
                                 String subject)
                                 throws RemoteException

force unsubscribe a subject without check initPermission the user must subscribe the subject

Throws:

RemoteException

commitUnSubscribe

DMSResult commitUnSubscribe(String userID,
                            String subject)
                            throws RemoteException

unsubscribe a subject

Throws:

RemoteException

isAlive

boolean isAlive()
                throws RemoteException

Throws:

RemoteException

deleteSubscriptionBoardInfo

DMSResult deleteSubscriptionBoardInfo(Vector subscriptionKeyList)
                                      throws RemoteException

Throws:

RemoteException

getSubscriptionBoardInfoByMemID

Vector getSubscriptionBoardInfoByMemID(String memID)
                                       throws RemoteException

Parameters:

memID -

Returns:

Throws:

RemoteException

Since:

V2.1

updateSubscriptionBoardInfo

void updateSubscriptionBoardInfo(Vector subscriptionBoardInfoList)
                                 throws RemoteException

Throws:

RemoteException

getSubscriptionBoardInfo

SubscriptionBoardInfo getSubscriptionBoardInfo(String subscriptionKey)
                                               throws RemoteException

Throws:

RemoteException