Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

ogre.dms.service
Interface FolderManagementService

All Superinterfaces:
Remote
public interface FolderManagementService
extends Remote

Version:
$Id: FolderManagementService.java,v 1.1.1.1.2.7.2.12 2009/09/21 05:52:00 esso Exp $
Author:
Docpedia team

Method Summary
 DMSResult commitCopyFolder(String userID, String sourceFolderID, String targetFolderID)
          Copy the folder to the target parent folder.
 DMSResult commitDeleteFolder(String userID, String folderID)
          Delete the folder.
 DMSResult commitMoveFolder(String userID, String sourceFolderID, String targetFolderID)
          Move the folder to the target parent folder.
 String commitNewFolder(String userID, String targetParentFolderID, VirtualFolderInfo newFolderInfo)
          Create a folder in the target parent folder.
 String commitNewFolder(String userID, String targetParentFolderID, VirtualFolderInfo newFolderInfo, boolean inherit)
          Create a folder in the target parent folder.
 DMSResult commitUpdateVirtualFolderInfo(String userID, VirtualFolderInfo vfInfo)
          Update the VirtualFolderInfo
 DMSResult commitUpdateVirtualFolderInfo(String userID, VirtualFolderInfo vfInfo, boolean isnotify)
          Update the VirtualFolderInfo
 DMSResult commitUpdateVirtualFolderInfo(String userID, VirtualFolderInfo vfInfo, boolean isnotify, HashMap toSubFolderMap)
           
 int getDocumentItemCount(String parentFolderID)
          Retrieve the up-to-date document counts of the parent folder.
 int getDocumentItemCount(String userID, String parentFolderID)
          Retrieve the up-to-date document counts of the parent folder with permission check.
 List getDocumentItemList(String parentFolderID)
          Retrieve the up-to-date document objects of the parent folder.
 List getDocumentItemList(String userID, String parentFolderID)
          Retrieve the up-to-date document objects of the parent folder with permission check.
 Vector getFolderFullPath(String subject)
           
 int getShortCutItemCount(String parentFolderID)
          Retrieve the up-to-date short-cut number of the parent folder.
 List getShortCutItemList(String parentFolderID)
          Retrieve the up-to-date short-cut objects of the parent folder.
 Vector getSubFolderByParantFolderID(String folderID)
          Retrieve the sub folder of the parent folder.
 int getSubFolderItemCount(String parentFolderID)
          Retrieve the up-to-date sub folder number of the parent folder.
 List getSubFolderItemList(String parentFolderID)
          Retrieve the up-to-date sub folder objects of the parent folder.
 List getSubFolderItemList(String userID, String parentFolderID)
          Retrieve the up-to-date sub folder objects of the parent folder with permission check.
 List getUndeleteableFolderContents(String folderID)
          See isFolderDeleteable method.
 DMSResult initCopyFolder(String userID, String sourceFolderID, String destFolderID)
          Deprecated. V3.0 Moved to AccessControlService.initCopyFolder(String, String, String).
 DMSResult initDeleteFolder(String userID, String folderID)
          Deprecated. V3.0 Moved to AccessControlService.initDeleteFolder(String, String).
 DMSResult initMoveFolder(String userID, String sourceFolderID, String destFolderID)
          Deprecated. V3.0 Moved to AccessControlService.initMoveFolder(String, String, String).
 DMSResult initNewFolder(String userID, String parentFolderID)
          Deprecated. V3.0 Moved to AccessControlService.initNewFolder(String, String).
 DMSResult initUpdateVirtualFolderInfo(String userID, String folderID)
          Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualFolderInfo(String, String).
 boolean isAlive()
           
 boolean isAllowFileToStoredInDistSite(String docKey, String distSiteID)
          Check if the file is permitted to store files in dist site.
 boolean isAllowFileToStoredInDistSite(VirtualFolderInfo folderInfo, String distSiteID)
          Check if the folder is allowed to store files in dist site.
 boolean isFolderDeleteable(String folderID)
          Check authorized user can delete a folder or not.
 DMSResult restoreFolder(String userID, String targetFolderID)
          Restore the deleted folder (which is in the 'Trash Can') to its original parent folder including its sub items (documents, folders).
 DMSResult setDefinedColumnInfo(String userID, String folderId, List columnInfo, boolean applyToSubFolder)
          Set user defined column to display in the document list page.
 boolean updateFolderOrdersConfiguration(HashMap orders)
          Update the sequence order displayed from the Folder Tree.
 

Method Detail

initNewFolder

DMSResult initNewFolder(String userID,
                        String parentFolderID)
                        throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initNewFolder(String, String).

Throws:
RemoteException

initUpdateVirtualFolderInfo

DMSResult initUpdateVirtualFolderInfo(String userID,
                                      String folderID)
                                      throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualFolderInfo(String, String).

Throws:
RemoteException

initDeleteFolder

DMSResult initDeleteFolder(String userID,
                           String folderID)
                           throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initDeleteFolder(String, String).

Throws:
RemoteException

initCopyFolder

DMSResult initCopyFolder(String userID,
                         String sourceFolderID,
                         String destFolderID)
                         throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCopyFolder(String, String, String).

Throws:
RemoteException

initMoveFolder

DMSResult initMoveFolder(String userID,
                         String sourceFolderID,
                         String destFolderID)
                         throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initMoveFolder(String, String, String).

Throws:
RemoteException

commitNewFolder

String commitNewFolder(String userID,
                       String targetParentFolderID,
                       VirtualFolderInfo newFolderInfo)
                       throws RemoteException
Create a folder in the target parent folder.

Parameters:
userID -
targetParentFolderID -
newFolderInfo - new folder infomation
Returns:
- new FolderID of newly created VirtualFolder or null
Throws:
RemoteException

commitNewFolder

String commitNewFolder(String userID,
                       String targetParentFolderID,
                       VirtualFolderInfo newFolderInfo,
                       boolean inherit)
                       throws RemoteException
Create a folder in the target parent folder.

Parameters:
userID -
targetParentFolderID -
newFolderInfo - new folder infomation
inherit - - if true, system will inherit the parent folder's setting including basic information, permission, and subscription.
Returns:
- new FolderID of newly created VirtualFolder or null.
Throws:
RemoteException

commitUpdateVirtualFolderInfo

DMSResult commitUpdateVirtualFolderInfo(String userID,
                                        VirtualFolderInfo vfInfo)
                                        throws RemoteException
Update the VirtualFolderInfo

Parameters:
userID -
vfInfo -
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException

commitUpdateVirtualFolderInfo

DMSResult commitUpdateVirtualFolderInfo(String userID,
                                        VirtualFolderInfo vfInfo,
                                        boolean isnotify)
                                        throws RemoteException
Update the VirtualFolderInfo

Parameters:
userID -
vfInfo -
isnotify - if true, system will notify the subscribers.
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException

commitUpdateVirtualFolderInfo

DMSResult commitUpdateVirtualFolderInfo(String userID,
                                        VirtualFolderInfo vfInfo,
                                        boolean isnotify,
                                        HashMap toSubFolderMap)
                                        throws RemoteException
Parameters:
userID - String
vfInfo - VirtualFolderInfo
isnotify - boolean
toSubFolderMap - HashMap
Returns:
DMSResult
Throws:
RemoteException

setDefinedColumnInfo

DMSResult setDefinedColumnInfo(String userID,
                               String folderId,
                               List columnInfo,
                               boolean applyToSubFolder)
                               throws RemoteException
Set user defined column to display in the document list page.

Parameters:
userID -
folderId -
columnInfo - each element is FolderColumn
applyToSubFolder -
Returns:
DMSResult
Throws:
RemoteException
Since:
V3.0

commitDeleteFolder

DMSResult commitDeleteFolder(String userID,
                             String folderID)
                             throws RemoteException
Delete the folder. Not actually delete it. The folder is just be moved to 'Trash Can'. If you delete it in the 'Trash Can', it's actually be marked as 'DMSUnit.FOLDER_STATUS_DELETED' in database. i.e. DMS does not delete the folder from the database.

Parameters:
userID -
folderID -
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException

commitCopyFolder

DMSResult commitCopyFolder(String userID,
                           String sourceFolderID,
                           String targetFolderID)
                           throws RemoteException
Copy the folder to the target parent folder.

Parameters:
userID -
sourceFolderID - FolderID of the copied folder
targetFolderID - the folder to which the user copies the target folder
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException

commitMoveFolder

DMSResult commitMoveFolder(String userID,
                           String sourceFolderID,
                           String targetFolderID)
                           throws RemoteException
Move the folder to the target parent folder.

Parameters:
userID -
sourceFolderID - FolderID of the source folder
targetFolderID - the folder to which the user moves the target folder
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException

getSubFolderByParantFolderID

Vector getSubFolderByParantFolderID(String folderID)
                                    throws RemoteException
Retrieve the sub folder of the parent folder. (One level only.)

Parameters:
folderID -
Returns:
Vector each element is VirtualFolderInfo
Throws:
RemoteException

updateFolderOrdersConfiguration

boolean updateFolderOrdersConfiguration(HashMap orders)
                                        throws RemoteException
Update the sequence order displayed from the Folder Tree. USUALLY THIS IS USED BY SYSTEM.

Parameters:
orders - is a HashMap with key representing for the FolderID, and value for the index order.
Returns:
true if the operation is done without errors.
Throws:
RemoteException

isAlive

boolean isAlive()
                throws RemoteException
Throws:
RemoteException

getFolderFullPath

Vector getFolderFullPath(String subject)
                         throws RemoteException
Parameters:
subject -
Returns:
QueryService.getRootPathFolderItemList(String)
Throws:
RemoteException
See Also:
QueryService.getRootPathFolderItemList(String)

isFolderDeleteable

boolean isFolderDeleteable(String folderID)
                           throws RemoteException
Check authorized user can delete a folder or not. Because there are tons of VirtualDocuments and VirtualFolders. Cannot delete a folder with documents which are not in status of 'Released'.

Parameters:
folderID -
Returns:
true if the folder is deleteable.
Throws:
RemoteException

getUndeleteableFolderContents

List getUndeleteableFolderContents(String folderID)
                                   throws RemoteException
See isFolderDeleteable method. This method has the same business logic with isFolderDeleteable, but this one will return which folder(s) or document(s) that cannot be deleted.

Parameters:
folderID -
Returns:
List containing folder(s) or document(s) that cannot be deleted. Each element is DisplayItem containing information about document key infomation or attribute type id, etc.
Throws:
RemoteException

restoreFolder

DMSResult restoreFolder(String userID,
                        String targetFolderID)
                        throws RemoteException
Restore the deleted folder (which is in the 'Trash Can') to its original parent folder including its sub items (documents, folders).

Parameters:
userID -
targetFolderID -
Returns:
DMSResult use DMSResult#getPermission() to check the result.
Throws:
RemoteException
Since:
V2.1

isAllowFileToStoredInDistSite

boolean isAllowFileToStoredInDistSite(VirtualFolderInfo folderInfo,
                                      String distSiteID)
                                      throws RemoteException
Check if the folder is allowed to store files in dist site.

Parameters:
folderInfo -
distSiteID -
Returns:
true if it is allowed to save in dist site.
Throws:
RemoteException
Since:
V2.2 Optional module is required.

isAllowFileToStoredInDistSite

boolean isAllowFileToStoredInDistSite(String docKey,
                                      String distSiteID)
                                      throws RemoteException
Check if the file is permitted to store files in dist site.

Parameters:
docKey -
distSiteID -
Returns:
true if it is allowed to save in dist site.
Throws:
RemoteException
Since:
V2.2 Optional module is required.

getSubFolderItemList

List getSubFolderItemList(String parentFolderID)
                          throws RemoteException
Retrieve the up-to-date sub folder objects of the parent folder.

Parameters:
parentFolderID -
Returns:
List each element is UnitItem
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getSubFolderItemList

List getSubFolderItemList(String userID,
                          String parentFolderID)
                          throws RemoteException
Retrieve the up-to-date sub folder objects of the parent folder with permission check.

Parameters:
parentFolderID -
Returns:
List each element is UnitItem
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getSubFolderItemCount

int getSubFolderItemCount(String parentFolderID)
                          throws RemoteException
Retrieve the up-to-date sub folder number of the parent folder.

Parameters:
parentFolderID -
Returns:
item count
Throws:
RemoteException
Since:
V2.2 HotFix_96

getShortCutItemList

List getShortCutItemList(String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date short-cut objects of the parent folder.

Parameters:
parentFolderID -
Returns:
List each element is UnitItem
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getShortCutItemCount

int getShortCutItemCount(String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date short-cut number of the parent folder.

Parameters:
parentFolderID -
Returns:
item count
Throws:
RemoteException
Since:
V2.2 HotFix_96

getDocumentItemList

List getDocumentItemList(String userID,
                         String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date document objects of the parent folder with permission check.

Parameters:
parentFolderID -
Returns:
List each element is UnitItem
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getDocumentItemList

List getDocumentItemList(String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date document objects of the parent folder.

Parameters:
parentFolderID -
Returns:
List each element is UnitItem
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getDocumentItemCount

int getDocumentItemCount(String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date document counts of the parent folder.

Parameters:
parentFolderID -
Returns:
row count of the document in the specified folder.
Throws:
RemoteException
Since:
V2.2 HotFix_49 & V3.0

getDocumentItemCount

int getDocumentItemCount(String userID,
                         String parentFolderID)
                         throws RemoteException
Retrieve the up-to-date document counts of the parent folder with permission check.

Parameters:
parentFolderID -
Returns:
row count of the document in the specified folder according to the userID's permission.
Throws:
RemoteException
Since:
V3.0 + V2.2 HotFix_63
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright(c) 2005-2012 by Flowring Technology Corp., 12 F., No 120, Sec 2, Gongdao 5th Rd., Hsin-Chu City 300, Taiwan(R.O.C.) All rights reserved.