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 DocumentManagementService

All Superinterfaces:
Remote
public interface DocumentManagementService
extends Remote

Version:
$Id: DocumentManagementService.java,v 1.6.2.38.2.36.2.1 2010/11/16 05:00:49 esso Exp $
Author:
Docpedia team

Method Summary
 DistributionMemberMarks addDistributionMemberMarks(DistributionMemberMarks remark)
          Write a remark for distribution record (document keeper).
 void addDocInfoLog(String docKey, String userID, String actionType, String description)
           
 boolean addPDFTemplate(PDFTemplateItem item, String key)
           
 boolean checkExpireIndex()
           
 Vector checkPhysicalDocumentList(String documentKey)
           
 DMSResult commitCancelApprove(String userID, String documentKey)
          ask the flow engine to cancel the current approveing process
 DMSResult commitCheckIn(String userID, String documentKey, String keyType, String checkInMode)
           
 List commitCheckMainDocOutWithISORelatedDocs(String userID, String mainDocKey, String[] arKeysToCheckOut, String mode)
          Check the main document (mainDocKey) out and the related documents (docKeys).
 String commitCheckOut(String userID, String targetDocumentKey, String mode)
           
 String commitCheckOutWithMainDoc(String userID, String targetDocumentKey, String mode, String mainDocKey)
          Commit check out a document with main doc for modification.
 DMSResult commitCopyDocument(String userID, String targetDocumentKey, String targetFolderID)
          copy target document to target folder
 String commitCreateExternalDraftVirtualDocument(String userID, VirtualDocument newVirtualDocument)
          Create an external draft document in the external user's workspace.
 DMSResult commitCreateRelationRecord(RelationRecord[] rr)
           
 DMSResult commitCreateReview(String userID, String documentKey, HashMap info)
           
 String commitCreateVirtualDocument(String userID, String folderID, VirtualDocument newVirtualDocument)
          user could create a new VirtualDocument in his own working space the VirtualDocumentInfo, Extra features and access control list could be set along with the document creation
 DMSResult commitDeleteDocument(String userID, String targetDocumentKey)
          delete target document
 DMSResult commitDeleteLv4RelationDocument(String sourceKey, String[] ids)
           
 DMSResult commitDeleteRelationRecord(String sourceId, String[] ids)
           
 DMSResult commitDeleteReview(DMSUser user, String key, String keyType)
          Delete document's review.
 DMSResult commitDeleteReview(String userID, String key, String keyType)
           
 DMSResult commitGiveUpCheckOut(String userID, String key, String keyType)
          Give up check out.
 boolean commitLv4RelationDocument(VirtualDocumentInfo sourceInfo, VirtualDocumentInfo decInfo)
           
 DMSResult commitMoveDocument(String userID, String targetDocumentKey, String targetFolderID)
          move target document to target folder
 DMSResult commitObsoleteDocument(String userID, String targetDocumentKey)
           
 DMSResult commitPublishDocument(String userID, String targetDocumentKey, String targetFolderID)
          a user could publish a document in his working space to other folder in regular space
 DMSResult commitPublishDocument(String userID, String targetDocumentKey, String targetFolderID, boolean approve)
          a user could publish a document in his working space to other folder in regular space, param approve indicate whether runing process or not
 DMSResult commitUpdateCategoryItemList(String userID, String documentKey, Vector categoryItemList)
          update the category items of target virtual document
 DMSResult commitUpdateKeywordItemList(String userID, String documentKey, Vector keywordItemList)
          update the keyword items of target virtual document
 DMSResult commitUpdateReview(DMSUser user, String reviewKey, HashMap info)
           
 DMSResult commitUpdateReview(String userID, String reviewKey, HashMap info)
           
 DMSResult commitUpdateVirtualDocumentByAdvancedMaintain(String userID, VirtualDocumentInfo updatedVirtualDocumentInfo)
          If you want to identify the update operation is by Advanced Maintain, you can use this API.
 DMSResult commitUpdateVirtualDocumentInfo(String userID, VirtualDocumentInfo updatedVirtualDocumentInfo)
          user could update VirtualDocumentInfo through this
 DMSResult commitUpdateVirtualDocumentInfo(String userID, VirtualDocumentInfo updatedVirtualDocumentInfo, boolean ignoreLock)
          user could update VirtualDocumentInfo through this
 boolean createApproveData(Vector APDataList)
           
 boolean createFavorite(FavoriteListItem[] items)
           
 VirtualDocument createNewLV4Document(String originalKey, DMSUser user, String publishFolderKey)
          Create an new LV4 document.
 String createPDFTemplate()
          Create PDF watermark template configuration item.
 boolean deleteApproveData(String mainKey, String lv4Key)
           
 void deleteFavorite(String userID, String[] key)
           
 boolean deletePDFTemplate(String PDFtemplateID)
           
 boolean deleteRelationRecordByKey(String sourceId, String targetKey)
           
 String forceCreateVirtualDocument(String userID, String folderID, VirtualDocument newVD)
           
 DMSResult forceNullifyDocument(String userID, String targetDocumentKey, String targetFolderID)
          force a user could nullify a document which had published.
 void forceObsoleteDocument(String userID, String docKey)
           
 DMSResult forcePublishDocument(String userID, String targetDocumentKey, String targetFolderID)
          force a user could publish a document in his working space to other folder in regular space
 DMSResult forcePublishDocument(String userID, String targetDocumentKey, String targetFolderID, boolean approve)
          force a user could publish a document in his working space to other folder in regular space, param approve indicate whether runing process or not
 void forceUpdateCategoryItemList(String documentKey, Vector categoryItemList)
          force update the category items of target virtual document
 void forceUpdateKeywordItemList(String documentKey, Vector keywordItemList)
          force update the keyword items of target virtual document
 String genAttributeSerialNumber(String attTypeID, boolean onlyNumber)
           
 boolean generateImportData(HashMap VDInfoMap, Vector fileList, String parentFolderID, String vdAttrtibuteID)
           
 Vector getApproveData(String taskID)
           
 Vector getApproveDataByDocKey(String docKey)
           
 Vector getApproveDataByKey(String docKey)
           
 int getC0289SerialIDCount(String serialID)
           
 String getColumnOfHistoryDoc()
           
 String getCopiedDocKey(String docKey)
           
 DistributionMember getDistributionMember(String disRecID)
          Retrieve a distribution record (document keeper).
 List getDistributionMemberByKeeper(String memberID)
          Retrieve the DistributionMember list by keeper.
 List getDistributionMemberMarks(String disRecID)
          Retrieve the remarks of distribution record (keeper record).
 Vector getDocAnnounceInfo(String timeString, String docStatus)
           
 List getDocKeeperList(String documentKey)
          Retrieve the document's keepers.
 List getDocOfLatestModifed()
          Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)
 List getDocOfLatestModifed(String userID)
          Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)
 List getDocOfLatestModifedGrantedOnly(String userID)
          Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)
 Vector getDocPublishVDInfoList(String timeString, String showLevel)
           
 List getDocumentListOfDocID(String docID)
          Retrieve the VirtualDocumentInfo (sorted by version id) according to the document id.
 Vector getDuplicateDefineVID(String defineVID, String docKey)
           
 Vector getDuplicateDocNameVD(String docKey, String docName)
           
 Vector getDuplicateSerialIDVD(String serialID, String docKey)
           
 PhysicalDocumentItem getFirstPD(String docKey)
           
 Vector getInvalidAuthorDocument()
           
 Vector getInvalidDocApprovingButTaskCompleteList()
           
 Vector getInvalidMemberList()
           
 Vector getInvalidUpToDateDocument()
           
 String getIsCrossIndex()
           
 String getIsNoPermissionFolderHidden()
           
 Vector getLatestSerialIDVD(String docKey)
           
 Vector getLatestSerialIDVDbyAttr(String docKey, String attID)
           
 String getMainLoginURL(String docKey)
           
 Vector getMultiApplyMode()
           
 String getOpenFileInBrowser()
           
 String getOpenFileInBrowserExtension()
           
 String getOriginalSubject(String docKey, String DocumentType)
           
 PDFTemplateItem getPDFTemplate(String templateID)
           
 Vector getPDFTemplateList()
          Retrieve all PDF watermark template configuration items.
 Vector getPermissionRoleList()
          Deprecated. V2.1 Use getPermissionRoleList(String) instead.
 Vector getPermissionRoleList(String encryptionType)
           
 Vector getRelatedLv4DocKeyList(String docKey)
           
 Vector getRelatedNewLv4DocKeyList(String docKey)
           
 String getVDGenIDType()
           
 List getVDKeyByDocID(String docID)
          Retrieve the document keys (sorted by version id) according to the document id.
 Vector getVDKeyByDocID(String docID, String AttName, String AttValue)
          Retireve the up-to-date document keys (sorted by version id) according to the document id and given condition.
 Vector getVDKeyByItsAtt(String attName, String attValue)
           
 Vector getVDKeyListByLikeName(String docName)
           
 String getViewVDURL(String docKey)
           
 String getWebAgendaURL()
           
 String getWebAgendaURL(String docKey)
           
 Vector getWorkSpacecontentByLoginID(String loginID)
           
 Vector getWorkSpaceContentByUser(String userID)
           
 DMSResult initCancelApprove(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initCancelApprove(String, String).
 DMSResult initCheckIn(String userID, String documentKey, String keyType)
          Deprecated. V3.0 Moved to AccessControlService.initCheckIn(String, String, String).
 DMSResult initCheckOut(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initCheckOut(String, String).
 DMSResult initCheckOutWithMainDoc(String userID, String documentKey, String mainDocKey)
          Deprecated. V3.0 Moved to AccessControlService.initCheckOutWithMainDoc(String, String, String).
 DMSResult initCopyDocument(String userID, String documentKey, String destFolderID)
          Deprecated. V3.0 Moved to ogre.dms.service.AccessControlService#initCopyDocument(String, String).
 DMSResult initCreateReview(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initCreateReview(String, String).
 DMSResult initCreateVirtualDocument(String userID, String folderID)
          Deprecated. V3.0 Moved to AccessControlService.initCreateVirtualDocument(String, String).
 DMSResult initDeleteDocument(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initDeleteDocument(String, String).
 DMSResult initGiveUpCheckOut(String userID, String documentKey, String keyType)
          Deprecated. V3.0 Moved to AccessControlService.initGiveUpCheckOut(String, String, String).
 DMSResult initMoveDocument(String userID, String documentKey, String destFolderID)
          Deprecated. V3.0 Moved to AccessControlService.initMoveDocument(String, String, String).
 DMSResult initNullifyDoc(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initNullifyDoc(String, String).
 DMSResult initPublishDocument(String userID, String documentKey, String folderID)
          Deprecated. V3.0 Moved to AccessControlService.initPublishDocument(String, String, String).
 DMSResult initUpdateACLInDocument(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initUpdateACLInDocument(String, String).
 DMSResult initUpdateRelationDocument(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initUpdateRelationDocument(String, String).
 DMSResult initUpdateVirtualDocumentInfo(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualDocumentInfo(String, String).
 DMSResult initUpdateVirtualDocumentInfo(String userID, String targetDocumentKey, boolean ignoreLock)
          Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualDocumentInfo(String, String, boolean).
 DMSResult initViewDocLog(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initViewDocLog(String, String).
 DMSResult initViewVirtualDocumentExt(String userID, String documentKey)
          Deprecated. V3.0 Moved to AccessControlService.initViewVirtualDocumentExt(String, String).
 boolean isAlive()
           
 int isCheckC0289SerialIDFormat(String attributeTypeID)
           
 boolean isCheckDefineVIDWhenPublishing()
           
 boolean isCheckOutAlone()
           
 boolean isCheckOutWithParent(String parentCopiedKey, String childCopiedKey)
          Check the child document whether is being checked out with parent document.
 boolean isCheckSerialIDWhenPublishing()
           
 boolean isDocDeleteable(String docKey)
          Check authorized user can delete the specifized document or not.
 boolean isDocumentPublishing(String userID, String docKey)
           
 boolean isFirstDocVersion(String documentKey)
           
 boolean isNoPermissionDocAndFolderHiddenInSearchingResult()
          Users can perform document or folder searching, turn this flag to true to hide documents or folders in the search result list which having no permission assigned to users.
 boolean isNoPermissionDocumentHidden()
           
 boolean isRegardReadAsDownloadPermission()
          Regard read permission as download permission.
 boolean markSameCkOutUnitByCopiedKey(DMSUser user, List copiedKeys)
          Mark checked-out documents as same checked-out unit to categorize them.
 DistributionMember newDistributionMember(DistributionMember disMember)
          Add a new Dictribution Member.
 void notifyAclUpdateCompleteMail(DMSUser to, String subject, HashMap info)
          Notify user about updating Folders' Acl.
 void notifyAuditMail(DMSUser from, VirtualDocumentInfo docinfo, String subject, HashMap info)
           
 void notifyDocMail(DMSUser from, VirtualDocumentInfo docinfo, String subject, HashMap info)
           
 void notifyDocRequest(DMSUser from, VirtualDocumentInfo docinfo, String subject, HashMap info)
           
 void notifyExtNoDownloadFile(HashMap info)
          For customization API.
 boolean onePDocHasBeenDownloaded(String docKey, String memID)
           
 void recordDeleteDocument(String docKey)
           
 DMSResult restoreDocument(String userID, String targetDocumentKey)
          Restore a deleted document from the recycle bin.
 boolean reviveDocument(String docKey)
           
 boolean reviveDocument(String userID, String docKey)
           
 Vector searchVDByDateCondition(HashMap map)
           
 DMSResult transferDocKeeper(DMSUser byWhom, String[] docKeys, String keeperID, String keeperDeptID)
          Batch transfer the document's keeper/dept to another person/dept.
 boolean updateApproveData(String taskID, String ActionType, String documentKey)
           
 boolean updateApproveDataAction(Vector applist, String updateField)
           
 DistributionMember updateDistributionMember(String disRecID, Map hmap)
          Update DistributionMember
 boolean updatePDFTemplate(PDFTemplateItem item)
           
 void updateRelationRecord(RelationRecord rr)
          ISODMS-1555, Add by Yaoming on 20100505
 Vector VDNotModifyCondition(HashMap conMap)
          This is not an open API.
 

Method Detail

initCheckOut

DMSResult initCheckOut(String userID,
                       String documentKey)
                       throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCheckOut(String, String).

Throws:
RemoteException

initCheckOutWithMainDoc

DMSResult initCheckOutWithMainDoc(String userID,
                                  String documentKey,
                                  String mainDocKey)
                                  throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCheckOutWithMainDoc(String, String, String).

Throws:
RemoteException

initCheckIn

DMSResult initCheckIn(String userID,
                      String documentKey,
                      String keyType)
                      throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCheckIn(String, String, String).

Throws:
RemoteException

initGiveUpCheckOut

DMSResult initGiveUpCheckOut(String userID,
                             String documentKey,
                             String keyType)
                             throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initGiveUpCheckOut(String, String, String).

Throws:
RemoteException

commitCheckOut

String commitCheckOut(String userID,
                      String targetDocumentKey,
                      String mode)
                      throws RemoteException
Returns:
the document key of the check out copy
Throws:
RemoteException

commitCheckOutWithMainDoc

String commitCheckOutWithMainDoc(String userID,
                                 String targetDocumentKey,
                                 String mode,
                                 String mainDocKey)
                                 throws RemoteException
Commit check out a document with main doc for modification.

Use #commitCheckMainDocOutWithRelatedISODocs(String, String, String[], String) instead.

Returns:
the document key of the check out copy
Throws:
RemoteException

commitCheckMainDocOutWithISORelatedDocs

List commitCheckMainDocOutWithISORelatedDocs(String userID,
                                             String mainDocKey,
                                             String[] arKeysToCheckOut,
                                             String mode)
                                             throws RemoteException
Check the main document (mainDocKey) out and the related documents (docKeys).

Parameters:
userID -
mainDocKey -
arKeysToCheckOut - related doc's key to check out along with main document.
mode - the way to check in - DMSUnit.CHECKIN_MODE_EDIT or DMSUnit.CHECKIN_MODE_REVISION.
Returns:
List the first element is the check-out VirtualDocumentInfo object, and the following elements are the check-out copies of the related documents.
Throws:
RemoteException

commitCheckIn

DMSResult commitCheckIn(String userID,
                        String documentKey,
                        String keyType,
                        String checkInMode)
                        throws RemoteException,
                               Exception
Parameters:
documentKey - documentKey of the checked out copy or original document depends on the given keyType.
keyType - figuring out the document key is from checked out copy or orignal document.
DMSUnit#DOCUMENT_TYPE_ORIGINAL: means the document key is the original document.
DMSUnit#DOCUMENT_TYPE_CHECKEDOUTCOPY: means the document key is the checked out copy.
checkInMode - deciding if there's a new version of document after the document is checked into the system
Can be DMSUnit.CHECKIN_MODE_EDIT or DMSUnit.CHECKIN_MODE_REVISION.
Throws:
RemoteException
Exception

commitGiveUpCheckOut

DMSResult commitGiveUpCheckOut(String userID,
                               String key,
                               String keyType)
                               throws RemoteException
Give up check out. The copied document would be removed and the lock of the original document would be released

Parameters:
userID -
key - according to the keyType, it could be the original document key, the copied document key, or the registration key in table 'DocumentCheckOutRegistration'.
keyType: - "Original", "CkOutCopy", "Registration"
Throws:
RemoteException

initCreateVirtualDocument

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

Throws:
RemoteException

initUpdateVirtualDocumentInfo

DMSResult initUpdateVirtualDocumentInfo(String userID,
                                        String documentKey)
                                        throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualDocumentInfo(String, String).

Throws:
RemoteException

initUpdateVirtualDocumentInfo

DMSResult initUpdateVirtualDocumentInfo(String userID,
                                        String targetDocumentKey,
                                        boolean ignoreLock)
                                        throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initUpdateVirtualDocumentInfo(String, String, boolean).

Throws:
RemoteException

initUpdateRelationDocument

DMSResult initUpdateRelationDocument(String userID,
                                     String documentKey)
                                     throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initUpdateRelationDocument(String, String).

Throws:
RemoteException

initNullifyDoc

DMSResult initNullifyDoc(String userID,
                         String documentKey)
                         throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initNullifyDoc(String, String).

Throws:
RemoteException

initViewVirtualDocumentExt

DMSResult initViewVirtualDocumentExt(String userID,
                                     String documentKey)
                                     throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initViewVirtualDocumentExt(String, String).

Throws:
RemoteException

initUpdateACLInDocument

DMSResult initUpdateACLInDocument(String userID,
                                  String documentKey)
                                  throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initUpdateACLInDocument(String, String).

Throws:
RemoteException

initPublishDocument

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

Throws:
RemoteException

forceCreateVirtualDocument

String forceCreateVirtualDocument(String userID,
                                  String folderID,
                                  VirtualDocument newVD)
                                  throws RemoteException
Throws:
RemoteException

commitCreateVirtualDocument

String commitCreateVirtualDocument(String userID,
                                   String folderID,
                                   VirtualDocument newVirtualDocument)
                                   throws RemoteException
user could create a new VirtualDocument in his own working space the VirtualDocumentInfo, Extra features and access control list could be set along with the document creation

Throws:
RemoteException

commitCreateExternalDraftVirtualDocument

String commitCreateExternalDraftVirtualDocument(String userID,
                                                VirtualDocument newVirtualDocument)
                                                throws RemoteException
Create an external draft document in the external user's workspace.

Parameters:
userID -
newVirtualDocument -
Returns:
document key
Throws:
RemoteException
Since:
V3.0

commitUpdateVirtualDocumentByAdvancedMaintain

DMSResult commitUpdateVirtualDocumentByAdvancedMaintain(String userID,
                                                        VirtualDocumentInfo updatedVirtualDocumentInfo)
                                                        throws RemoteException
If you want to identify the update operation is by Advanced Maintain, you can use this API. Otherwise, you can use commitUpdateVirtualDocumentInfo(String, VirtualDocumentInfo).

Parameters:
userID -
updatedVirtualDocumentInfo -
Returns:
Throws:
RemoteException
Since:
V3.0

commitUpdateVirtualDocumentInfo

DMSResult commitUpdateVirtualDocumentInfo(String userID,
                                          VirtualDocumentInfo updatedVirtualDocumentInfo)
                                          throws RemoteException
user could update VirtualDocumentInfo through this

Throws:
RemoteException

commitUpdateVirtualDocumentInfo

DMSResult commitUpdateVirtualDocumentInfo(String userID,
                                          VirtualDocumentInfo updatedVirtualDocumentInfo,
                                          boolean ignoreLock)
                                          throws RemoteException
user could update VirtualDocumentInfo through this

Throws:
RemoteException

forceUpdateCategoryItemList

void forceUpdateCategoryItemList(String documentKey,
                                 Vector categoryItemList)
                                 throws RemoteException
force update the category items of target virtual document

Throws:
RemoteException

commitUpdateCategoryItemList

DMSResult commitUpdateCategoryItemList(String userID,
                                       String documentKey,
                                       Vector categoryItemList)
                                       throws RemoteException
update the category items of target virtual document

Throws:
RemoteException

forceUpdateKeywordItemList

void forceUpdateKeywordItemList(String documentKey,
                                Vector keywordItemList)
                                throws RemoteException
force update the keyword items of target virtual document

Throws:
RemoteException

commitUpdateKeywordItemList

DMSResult commitUpdateKeywordItemList(String userID,
                                      String documentKey,
                                      Vector keywordItemList)
                                      throws RemoteException
update the keyword items of target virtual document

Throws:
RemoteException

forceNullifyDocument

DMSResult forceNullifyDocument(String userID,
                               String targetDocumentKey,
                               String targetFolderID)
                               throws RemoteException,
                                      Exception
force a user could nullify a document which had published.

Parameters:
userID - String
targetDocumentKey - String
targetFolderID - String
Returns:
DMSResult
Throws:
RemoteException
Exception

forcePublishDocument

DMSResult forcePublishDocument(String userID,
                               String targetDocumentKey,
                               String targetFolderID)
                               throws RemoteException,
                                      Exception
force a user could publish a document in his working space to other folder in regular space

Throws:
RemoteException
Exception

forcePublishDocument

DMSResult forcePublishDocument(String userID,
                               String targetDocumentKey,
                               String targetFolderID,
                               boolean approve)
                               throws RemoteException,
                                      Exception
force a user could publish a document in his working space to other folder in regular space, param approve indicate whether runing process or not

Throws:
RemoteException
Exception

commitPublishDocument

DMSResult commitPublishDocument(String userID,
                                String targetDocumentKey,
                                String targetFolderID)
                                throws RemoteException,
                                       Exception
a user could publish a document in his working space to other folder in regular space

Throws:
RemoteException
Exception

commitPublishDocument

DMSResult commitPublishDocument(String userID,
                                String targetDocumentKey,
                                String targetFolderID,
                                boolean approve)
                                throws RemoteException,
                                       Exception
a user could publish a document in his working space to other folder in regular space, param approve indicate whether runing process or not

Throws:
RemoteException
Exception

initDeleteDocument

DMSResult initDeleteDocument(String userID,
                             String documentKey)
                             throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initDeleteDocument(String, String).

Throws:
RemoteException

initCopyDocument

DMSResult initCopyDocument(String userID,
                           String documentKey,
                           String destFolderID)
                           throws RemoteException
Deprecated. V3.0 Moved to ogre.dms.service.AccessControlService#initCopyDocument(String, String).

Throws:
RemoteException

initMoveDocument

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

Throws:
RemoteException

commitDeleteDocument

DMSResult commitDeleteDocument(String userID,
                               String targetDocumentKey)
                               throws RemoteException,
                                      Exception
delete target document

Throws:
RemoteException
Exception

commitCopyDocument

DMSResult commitCopyDocument(String userID,
                             String targetDocumentKey,
                             String targetFolderID)
                             throws RemoteException
copy target document to target folder

Throws:
RemoteException

commitMoveDocument

DMSResult commitMoveDocument(String userID,
                             String targetDocumentKey,
                             String targetFolderID)
                             throws RemoteException
move target document to target folder

Throws:
RemoteException

initCancelApprove

DMSResult initCancelApprove(String userID,
                            String documentKey)
                            throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCancelApprove(String, String).

Throws:
RemoteException

commitCancelApprove

DMSResult commitCancelApprove(String userID,
                              String documentKey)
                              throws RemoteException,
                                     Exception
ask the flow engine to cancel the current approveing process

Throws:
RemoteException
Exception

initCreateReview

DMSResult initCreateReview(String userID,
                           String documentKey)
                           throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initCreateReview(String, String).

Throws:
RemoteException

commitCreateReview

DMSResult commitCreateReview(String userID,
                             String documentKey,
                             HashMap info)
                             throws RemoteException
Throws:
RemoteException

commitUpdateReview

DMSResult commitUpdateReview(String userID,
                             String reviewKey,
                             HashMap info)
                             throws RemoteException
Throws:
RemoteException

commitUpdateReview

DMSResult commitUpdateReview(DMSUser user,
                             String reviewKey,
                             HashMap info)
                             throws RemoteException
Throws:
RemoteException

commitDeleteReview

DMSResult commitDeleteReview(String userID,
                             String key,
                             String keyType)
                             throws RemoteException
Throws:
RemoteException

commitDeleteReview

DMSResult commitDeleteReview(DMSUser user,
                             String key,
                             String keyType)
                             throws RemoteException
Delete document's review.

Parameters:
user -
key -
keyType -
Returns:
Throws:
RemoteException
Exception
Since:
V3.0

commitCreateRelationRecord

DMSResult commitCreateRelationRecord(RelationRecord[] rr)
                                     throws RemoteException
Throws:
RemoteException

commitDeleteRelationRecord

DMSResult commitDeleteRelationRecord(String sourceId,
                                     String[] ids)
                                     throws RemoteException
Throws:
RemoteException

deleteRelationRecordByKey

boolean deleteRelationRecordByKey(String sourceId,
                                  String targetKey)
                                  throws RemoteException
Throws:
RemoteException

checkPhysicalDocumentList

Vector checkPhysicalDocumentList(String documentKey)
                                 throws RemoteException
Throws:
RemoteException

createFavorite

boolean createFavorite(FavoriteListItem[] items)
                       throws RemoteException
Throws:
RemoteException

deleteFavorite

void deleteFavorite(String userID,
                    String[] key)
                    throws RemoteException
Throws:
RemoteException

commitLv4RelationDocument

boolean commitLv4RelationDocument(VirtualDocumentInfo sourceInfo,
                                  VirtualDocumentInfo decInfo)
                                  throws RemoteException
Throws:
RemoteException

commitDeleteLv4RelationDocument

DMSResult commitDeleteLv4RelationDocument(String sourceKey,
                                          String[] ids)
                                          throws RemoteException
Throws:
RemoteException

getPermissionRoleList

Vector getPermissionRoleList()
                             throws RemoteException
Deprecated. V2.1 Use getPermissionRoleList(String) instead.

Throws:
RemoteException

getPermissionRoleList

Vector getPermissionRoleList(String encryptionType)
                             throws RemoteException
Parameters:
encryptionType -
Returns:
Throws:
RemoteException
Since:
V2.1

getOriginalSubject

String getOriginalSubject(String docKey,
                          String DocumentType)
                          throws RemoteException
Throws:
RemoteException

commitObsoleteDocument

DMSResult commitObsoleteDocument(String userID,
                                 String targetDocumentKey)
                                 throws RemoteException
Throws:
RemoteException

getFirstPD

PhysicalDocumentItem getFirstPD(String docKey)
                                throws RemoteException
Throws:
RemoteException

getDocAnnounceInfo

Vector getDocAnnounceInfo(String timeString,
                          String docStatus)
                          throws RemoteException
Throws:
RemoteException

getDocOfLatestModifed

List getDocOfLatestModifed()
                           throws RemoteException
Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)

Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:
V3.0 HotFix_17

getDocOfLatestModifed

List getDocOfLatestModifed(String userID)
                           throws RemoteException
Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)

Parameters:
userID - to check the user's ACL against each return element and considered with the conf\config.properties#NoPermissionDocumentHidden, RegardReadAsDownloadPermission
Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:
V3.0 HotFix_17

getDocOfLatestModifedGrantedOnly

List getDocOfLatestModifedGrantedOnly(String userID)
                                      throws RemoteException
Retrieve the latest published/revised documents within n days (Refer to conf\config.properties#daysOfLatestDocumentsToDisplayInMyDcc)

Parameters:
userID - to check the user's ACL against each return element.
Returns:
List each element is permission granted VirtualDocumentInfo
Throws:
RemoteException
Since:
V3.0 HotFix_17

getVDKeyByItsAtt

Vector getVDKeyByItsAtt(String attName,
                        String attValue)
                        throws RemoteException
Throws:
RemoteException

getRelatedLv4DocKeyList

Vector getRelatedLv4DocKeyList(String docKey)
                               throws RemoteException
Throws:
RemoteException

getRelatedNewLv4DocKeyList

Vector getRelatedNewLv4DocKeyList(String docKey)
                                  throws RemoteException
Throws:
RemoteException

reviveDocument

boolean reviveDocument(String docKey)
                       throws RemoteException
Throws:
RemoteException

reviveDocument

boolean reviveDocument(String userID,
                       String docKey)
                       throws RemoteException
Throws:
RemoteException

isAlive

boolean isAlive()
                throws RemoteException
Throws:
RemoteException

getInvalidAuthorDocument

Vector getInvalidAuthorDocument()
                                throws RemoteException
Throws:
RemoteException

getInvalidUpToDateDocument

Vector getInvalidUpToDateDocument()
                                  throws RemoteException
Throws:
RemoteException

getInvalidDocApprovingButTaskCompleteList

Vector getInvalidDocApprovingButTaskCompleteList()
                                                 throws RemoteException
Throws:
RemoteException

checkExpireIndex

boolean checkExpireIndex()
                         throws RemoteException
Throws:
RemoteException

addDocInfoLog

void addDocInfoLog(String docKey,
                   String userID,
                   String actionType,
                   String description)
                   throws RemoteException
Throws:
RemoteException

getIsCrossIndex

String getIsCrossIndex()
                       throws RemoteException
Throws:
RemoteException

forceObsoleteDocument

void forceObsoleteDocument(String userID,
                           String docKey)
                           throws RemoteException
Throws:
RemoteException

getWorkSpaceContentByUser

Vector getWorkSpaceContentByUser(String userID)
                                 throws RemoteException
Throws:
RemoteException

getWorkSpacecontentByLoginID

Vector getWorkSpacecontentByLoginID(String loginID)
                                    throws RemoteException
Throws:
RemoteException

createApproveData

boolean createApproveData(Vector APDataList)
                          throws RemoteException
Throws:
RemoteException

getApproveData

Vector getApproveData(String taskID)
                      throws RemoteException
Throws:
RemoteException

updateApproveData

boolean updateApproveData(String taskID,
                          String ActionType,
                          String documentKey)
                          throws RemoteException
Throws:
RemoteException

getApproveDataByKey

Vector getApproveDataByKey(String docKey)
                           throws RemoteException
Throws:
RemoteException

getApproveDataByDocKey

Vector getApproveDataByDocKey(String docKey)
                              throws RemoteException
Throws:
RemoteException

updateApproveDataAction

boolean updateApproveDataAction(Vector applist,
                                String updateField)
                                throws RemoteException
Throws:
RemoteException

deleteApproveData

boolean deleteApproveData(String mainKey,
                          String lv4Key)
                          throws RemoteException
Throws:
RemoteException

searchVDByDateCondition

Vector searchVDByDateCondition(HashMap map)
                               throws RemoteException
Throws:
RemoteException

VDNotModifyCondition

Vector VDNotModifyCondition(HashMap conMap)
                            throws RemoteException
This is not an open API.

Parameters:
conMap - condition map
Returns:
Vector each element is DocumentKey.
Throws:
RemoteException

isCheckOutAlone

boolean isCheckOutAlone()
                        throws RemoteException
Throws:
RemoteException

getIsNoPermissionFolderHidden

String getIsNoPermissionFolderHidden()
                                     throws RemoteException
Throws:
RemoteException

isNoPermissionDocumentHidden

boolean isNoPermissionDocumentHidden()
                                     throws RemoteException
Throws:
RemoteException

isNoPermissionDocAndFolderHiddenInSearchingResult

boolean isNoPermissionDocAndFolderHiddenInSearchingResult()
                                                          throws RemoteException
Users can perform document or folder searching, turn this flag to true to hide documents or folders in the search result list which having no permission assigned to users.

Returns:
Throws:
RemoteException
Since:
V3.0

getMultiApplyMode

Vector getMultiApplyMode()
                         throws RemoteException
Throws:
RemoteException

getInvalidMemberList

Vector getInvalidMemberList()
                            throws RemoteException
Throws:
RemoteException

getDocPublishVDInfoList

Vector getDocPublishVDInfoList(String timeString,
                               String showLevel)
                               throws RemoteException
Throws:
RemoteException

getVDKeyListByLikeName

Vector getVDKeyListByLikeName(String docName)
                              throws RemoteException
Throws:
RemoteException

getVDKeyByDocID

Vector getVDKeyByDocID(String docID,
                       String AttName,
                       String AttValue)
                       throws RemoteException
Retireve the up-to-date document keys (sorted by version id) according to the document id and given condition.

Parameters:
docID -
AttName -
AttValue -
Returns:
Throws:
RemoteException

getVDKeyByDocID

List getVDKeyByDocID(String docID)
                     throws RemoteException
Retrieve the document keys (sorted by version id) according to the document id.

Parameters:
docID -
Returns:
List each element is String representing the document key.
Throws:
RemoteException
Since:
V2.2 HotFix_105

getDocumentListOfDocID

List getDocumentListOfDocID(String docID)
                            throws RemoteException
Retrieve the VirtualDocumentInfo (sorted by version id) according to the document id.

Parameters:
docID -
Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:
V3.0

generateImportData

boolean generateImportData(HashMap VDInfoMap,
                           Vector fileList,
                           String parentFolderID,
                           String vdAttrtibuteID)
                           throws RemoteException
Throws:
RemoteException

getVDGenIDType

String getVDGenIDType()
                      throws RemoteException
Throws:
RemoteException

getPDFTemplateList

Vector getPDFTemplateList()
                          throws RemoteException
Retrieve all PDF watermark template configuration items.

Returns:
Vector each element is object of PDFTemplateInfo
Throws:
RemoteException

createPDFTemplate

String createPDFTemplate()
                         throws RemoteException
Create PDF watermark template configuration item.

Returns:
String PDFTemplateID
Throws:
RemoteException

addPDFTemplate

boolean addPDFTemplate(PDFTemplateItem item,
                       String key)
                       throws RemoteException
Throws:
RemoteException

updatePDFTemplate

boolean updatePDFTemplate(PDFTemplateItem item)
                          throws RemoteException
Throws:
RemoteException

deletePDFTemplate

boolean deletePDFTemplate(String PDFtemplateID)
                          throws RemoteException
Throws:
RemoteException

getPDFTemplate

PDFTemplateItem getPDFTemplate(String templateID)
                               throws RemoteException
Throws:
RemoteException

notifyDocRequest

void notifyDocRequest(DMSUser from,
                      VirtualDocumentInfo docinfo,
                      String subject,
                      HashMap info)
                      throws RemoteException
Throws:
RemoteException

notifyDocMail

void notifyDocMail(DMSUser from,
                   VirtualDocumentInfo docinfo,
                   String subject,
                   HashMap info)
                   throws RemoteException
Throws:
RemoteException

notifyAuditMail

void notifyAuditMail(DMSUser from,
                     VirtualDocumentInfo docinfo,
                     String subject,
                     HashMap info)
                     throws RemoteException
Throws:
RemoteException

notifyAclUpdateCompleteMail

void notifyAclUpdateCompleteMail(DMSUser to,
                                 String subject,
                                 HashMap info)
                                 throws RemoteException
Notify user about updating Folders' Acl.

Parameters:
to -
subject -
info -
Throws:
RemoteException
Since:
V3.0 HotFix_32

notifyExtNoDownloadFile

void notifyExtNoDownloadFile(HashMap info)
                             throws RemoteException
For customization API.

Throws:
RemoteException
Since:
V3.0 HotFix_31

getMainLoginURL

String getMainLoginURL(String docKey)
                       throws RemoteException
Throws:
RemoteException

getWebAgendaURL

String getWebAgendaURL(String docKey)
                       throws RemoteException
Throws:
RemoteException

getWebAgendaURL

String getWebAgendaURL()
                       throws RemoteException
Throws:
RemoteException

getViewVDURL

String getViewVDURL(String docKey)
                    throws RemoteException
Throws:
RemoteException

markSameCkOutUnitByCopiedKey

boolean markSameCkOutUnitByCopiedKey(DMSUser user,
                                     List copiedKeys)
                                     throws RemoteException
Mark checked-out documents as same checked-out unit to categorize them.

Parameters:
user -
copiedKeys - document keys
Returns:
boolean
Throws:
RemoteException

isCheckOutWithParent

boolean isCheckOutWithParent(String parentCopiedKey,
                             String childCopiedKey)
                             throws RemoteException
Check the child document whether is being checked out with parent document. Meanwhile, approval process is needed.

Parameters:
parentCopiedKey -
childCopiedKey -
Returns:
true/false
Throws:
RemoteException

isDocDeleteable

boolean isDocDeleteable(String docKey)
                        throws RemoteException
Check authorized user can delete the specifized document or not. Because VirtualDocument cannot be deleted which is not in status of 'Released'.

Parameters:
docKey -
Returns:
true if deleteable
Throws:
RemoteException

isDocumentPublishing

boolean isDocumentPublishing(String userID,
                             String docKey)
                             throws RemoteException
Throws:
RemoteException

recordDeleteDocument

void recordDeleteDocument(String docKey)
                          throws RemoteException
Throws:
RemoteException

genAttributeSerialNumber

String genAttributeSerialNumber(String attTypeID,
                                boolean onlyNumber)
                                throws RemoteException
Throws:
RemoteException

onePDocHasBeenDownloaded

boolean onePDocHasBeenDownloaded(String docKey,
                                 String memID)
                                 throws RemoteException
Throws:
RemoteException

createNewLV4Document

VirtualDocument createNewLV4Document(String originalKey,
                                     DMSUser user,
                                     String publishFolderKey)
                                     throws RemoteException
Create an new LV4 document.

Parameters:
originalKey - original document' docKey.
user -
publishFolderKey -
Returns:
Throws:
DMSException
RemoteException

restoreDocument

DMSResult restoreDocument(String userID,
                          String targetDocumentKey)
                          throws RemoteException
Restore a deleted document from the recycle bin.

Parameters:
userID -
targetDocumentKey -
Returns:
DMSResult
Throws:
RemoteException

getOpenFileInBrowser

String getOpenFileInBrowser()
                            throws RemoteException
Throws:
RemoteException

getOpenFileInBrowserExtension

String getOpenFileInBrowserExtension()
                                     throws RemoteException
Throws:
RemoteException

getDuplicateSerialIDVD

Vector getDuplicateSerialIDVD(String serialID,
                              String docKey)
                              throws RemoteException
Throws:
RemoteException

getC0289SerialIDCount

int getC0289SerialIDCount(String serialID)
                          throws RemoteException
Throws:
RemoteException

isCheckC0289SerialIDFormat

int isCheckC0289SerialIDFormat(String attributeTypeID)
                               throws RemoteException
Throws:
RemoteException

getDuplicateDocNameVD

Vector getDuplicateDocNameVD(String docKey,
                             String docName)
                             throws RemoteException
Throws:
RemoteException

getLatestSerialIDVD

Vector getLatestSerialIDVD(String docKey)
                           throws RemoteException
Throws:
RemoteException

getLatestSerialIDVDbyAttr

Vector getLatestSerialIDVDbyAttr(String docKey,
                                 String attID)
                                 throws RemoteException
Throws:
RemoteException

getColumnOfHistoryDoc

String getColumnOfHistoryDoc()
                             throws RemoteException
Returns:
Throws:
RemoteException
Since:
V2.2

isRegardReadAsDownloadPermission

boolean isRegardReadAsDownloadPermission()
                                         throws RemoteException
Regard read permission as download permission. If this is set to 'false', the system will allow the user to access all the Document Index Cards without permission checking. In this condition, the system will only check the permission while the user is trying to download the file(s) attached with the document.

Returns:
true/false
Throws:
RemoteException
Since:
V2.2

initViewDocLog

DMSResult initViewDocLog(String userID,
                         String documentKey)
                         throws RemoteException
Deprecated. V3.0 Moved to AccessControlService.initViewDocLog(String, String).

Throws:
RemoteException

isCheckSerialIDWhenPublishing

boolean isCheckSerialIDWhenPublishing()
                                      throws RemoteException
Throws:
RemoteException

getCopiedDocKey

String getCopiedDocKey(String docKey)
                       throws RemoteException
Throws:
RemoteException

getDuplicateDefineVID

Vector getDuplicateDefineVID(String defineVID,
                             String docKey)
                             throws RemoteException
Throws:
RemoteException

isCheckDefineVIDWhenPublishing

boolean isCheckDefineVIDWhenPublishing()
                                       throws RemoteException
Throws:
RemoteException

isFirstDocVersion

boolean isFirstDocVersion(String documentKey)
                          throws RemoteException
Throws:
RemoteException

getDocKeeperList

List getDocKeeperList(String documentKey)
                      throws RemoteException
Retrieve the document's keepers.

Parameters:
documentKey -
Returns:
List each element is DistributionMember
Throws:
RemoteException
Since:
V3.0

addDistributionMemberMarks

DistributionMemberMarks addDistributionMemberMarks(DistributionMemberMarks remark)
                                                   throws RemoteException
Write a remark for distribution record (document keeper).

Parameters:
remark -
Returns:
the added DistributionMemberMarks
Throws:
RemoteException
Since:
V3.0

getDistributionMemberMarks

List getDistributionMemberMarks(String disRecID)
                                throws RemoteException
Retrieve the remarks of distribution record (keeper record).

Parameters:
disRecID -
Returns:
List each element is DistributionMemberMarks
Throws:
RemoteException
Since:
V3.0

newDistributionMember

DistributionMember newDistributionMember(DistributionMember disMember)
                                         throws RemoteException
Add a new Dictribution Member.

Parameters:
disMember -
Returns:
DistributionMember
Throws:
RemoteException
Since:
V3.0

updateDistributionMember

DistributionMember updateDistributionMember(String disRecID,
                                            Map hmap)
                                            throws RemoteException
Update DistributionMember

Parameters:
disRecID -
hmap - filed to update
Returns:
the updated DistributionMember
Throws:
RemoteException

getDistributionMember

DistributionMember getDistributionMember(String disRecID)
                                         throws RemoteException
Retrieve a distribution record (document keeper).

Parameters:
disRecID -
Returns:
DistributionMember
Throws:
RemoteException
Since:
V3.0

getDistributionMemberByKeeper

List getDistributionMemberByKeeper(String memberID)
                                   throws RemoteException
Retrieve the DistributionMember list by keeper.

Parameters:
memberID - the keeper's member id.
Returns:
List each element is DistributionMember
Throws:
RemoteException
Since:
V3.0

transferDocKeeper

DMSResult transferDocKeeper(DMSUser byWhom,
                            String[] docKeys,
                            String keeperID,
                            String keeperDeptID)
                            throws RemoteException
Batch transfer the document's keeper/dept to another person/dept.

Parameters:
byWhom - who does the transfer
docKeys -
keeperID -
keeperDeptID -
Returns:
DMSResult
Throws:
RemoteException
Since:
V3.0

updateRelationRecord

void updateRelationRecord(RelationRecord rr)
                          throws RemoteException
ISODMS-1555, Add by Yaoming on 20100505

Parameters:
RelationRecord - Object
Throws:
RemoteException
Since:
V3.0
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.