QueryService (Docpedia JavaDoc API)

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 QueryService

All Superinterfaces:: Remote

public interface QueryService
extends Remote
extends Remote

QueryService is an interface which provides seriveces for responding the basic need of request of data or data list from client application

Version:: $Id: QueryService.java,v 1.9.2.20.2.34 2010/07/06 10:42:12 karo Exp $
Author:: Docpedia team

Method Summary
`boolean`	`addUserHomeLink(HashMap map, String loginID)`
`int[]`	`batchUpdateValue(String[] sqls)` Adds the given SQL command to the current list of commmands for this `Statement` object.
`Vector`	`checkLv4RelatedDocStatus(String sourceDocKey)`
`void`	`clearCache()`
`void`	`clearCache(String type)`
`Vector`	`getACL(String subject)` Retrieve a list of AccessControlItem which describes the Access Control List of the item figured by subject.
`String`	`getAdvancedConfigLog(String logDocID)`
`pe.pase.Company`	`getAFCompany()`
`pe.pase.Department`	`getAFDepartment(String dID)`
`pe.pase.MemberRecord`	`getAFMember(String mID)`
`pe.pase.MemberRecord`	`getAFMemberByLoginID(String loginID)`
`pe.pase.Role`	`getAFRole(String rID)`
`List`	`getAllAFMember()` Retrieve all Agentflow member.
`List`	`getAllAttributeTypeList()` Retrieve all document types.
`Vector`	`getAllFolderItems(String folderID, String orderField, boolean order, String type)`
`Vector`	`getAllParentAttributeIDList(String attributeTypeID)` For DCC Process V.3.0.0 HotFix_20
`Vector`	`getAllSubscriberListBySubject(String subject)` get all the user subscribing the list, return the list of DMSUser
`List`	`getAllVirtualFolderInfo()` Retrieve all folder information.
`Vector`	`getApproveRequestList(String userID)` get the approve request submitted by a user
`Vector`	`getApproveRequestListByDocument(String documentKey)` get all the approve requests related to the target document
`ApproveRequest`	`getApproveRequestRegistrationByTaskID(String taskID)`
`String`	`getAttAttachFileTypeAuto(String attID)`
`String`	`getAttIsISODocAuto(String attID)`
`String`	`getAttIsoLevelAuto(String attID)`
`String`	`getAttMaxFileSizeAuto(String attID)`
`String`	`getAttPublishFolderAuto(String attID)` Deprecated. Since V2.2 AttributeType can specify more than one default publish folder, so it cannot be decided by system.
`Vector`	`getAttributeIDList()`
`Vector`	`getAttributeList(String parentAttributeTypeID)` Retrieve Sub `AttributeType` by `parentAttributeTypeID`
`AttributeType`	`getAttributeType(String typeID)` Retrieve the `AttributeType` instance.
`AttributeType`	`getAttributeTypeByPublishFolder(String typeID, String publishFolder)` Retrieve the `AttributeType` instance.
`List`	`getAttributeTypeIDByName(String typeName)` Retrieve the `AttributeType`'s id by the given `AttributeType`'s name.
`List`	`getAttributeTypesOfFolder(String folderID)` Retrieve folder's related Document Type.
`String`	`getAttSerialFormatAuto(String attID)`
`String`	`getAttSerialTypeIDAuto(String attID)`
`String`	`getAttTempleteIDAuto(String attID)`
`Vector`	`getAttTypeListByPublishFolder(String folderID, String isDepAtt)`
`CategoryItem`	`getCategoryItem(String CategoryKey)` get category item by key
`Vector`	`getCategoryItemList(String documentKey)` get the list of the categories (CategoryItem) of some virtual document with document key as "System", the system category item list would be obtained
`Vector`	`getCategoryList()` get the list of the categories defined for target is "system"
`Vector`	`getCategoryList(String repositoryID)` get the list of the categories (CategoryItem) defined for target repository
`String`	`getCheckInMode(String docKey, String keyType)` get the check in mode of the specified checked out document
`CheckOutRecord`	`getCheckOutRecord(String key, String keyType)` Get the check out record
`Vector`	`getChildGroupInfoList(String groupID)` Get the child group of some group
`Vector`	`getChildUserList(String groupID)` get the child users of some group
`Vector`	`getComIDListOfMember(String mID)`
`String`	`getComIdOfDep(String dID)`
`String`	`getComIdOfRole(String rID)`
`List`	`getCurrentARList(HashMap searchMap)` Retrieve the `ApproveRequest` of `APPROVE_TYPE_PUBLISH`/ `APPROVE_TYPE_CHECKIN`/ `APPROVE_TYPE_OBSOLETE` which are still on going.
`ApproveRequest`	`getCurrentCheckInAR(String documentKey)` Retrieve the current checking in `ApproveRequest` by document key.
`ApproveRequest`	`getCurrentObsoleteAR(String documentKey)` Retrieve the current obsoleting `ApproveRequest` by document key.
`List`	`getCurrentObsoleteAROfUser(String userID)` Retrieve the current obsoleting `ApproveRequest`s of the user.
`ApproveRequest`	`getCurrentPublishAR(String documentKey)` Retrieve the current publishing `ApproveRequest` by document key.
`Vector`	`getDeletingRecordList()` get all the deleting record about documents and folders
`Vector`	`getDeptContributionListObject(HashMap SearchMap, String showLevel)`
`Vector`	`getDistributionRecordObject(HashMap conhMap)`
`DMSCompany`	`getDMSCompany(String cID)`
`Vector`	`getDocAppreciationData(HashMap conMap, String showLevel)`
`Vector`	`getDocLogInfo(HashMap condition)`
`List`	`getDocumentKeysByKeyword(String keyword)` Get DocumentKeys by Keyword
`List`	`getDocumentListByFuzzyKey(int limitResultCnt, String keyType, String partialKey, boolean onlyUpToDate)` Retrieve the `VirtualDocumentInfo list by partial of the DocumentKey, DocumentID or SerialID.`
`DocumentTemplate`	`getDocumentTemplate(String documentTemplateID)` Get a DocumentTemplate by id, if the template is not existent return null
`Vector`	`getDocumentTemplateList()` Get all the Document Template on the DMS
`Vector`	`getEffectiveGroupIDs(String groupID)` Get a list of all the Group IDs which is effective as the specified GroupID.
`Vector`	`getEffectiveOrgIDs(String userID)` Get a list of all the organization ids (GroupID and UserID) which is effective as the specified userID
`List`	`getExpiryDocument(ExpiryDocSearchItem criteria)` Retrieve the `VirtualDocumentInfo`(s) which are going to be or has been expired, according to the query criteria.
`List`	`getExtDraftDocListByUser(String extUserID)` Retrieve the draft document in external's workspace.
`List`	`getExternalDocListByFuzzyName(String externalUserID, int limitResultCnt, String searchKeyword, int rtnType)`
`Vector`	`getExternalSubscriberOfExtFolder(String folderId)` Retrieve external subscribers of external folder.
`DMSGroup`	`getExtGroupByID(String groupID)` Get a external group by external group ID.
`Vector`	`getExtLogStatisticCountObject(HashMap SearchMap, String showLevel)`
`Vector`	`getExtLogStatisticFileCountObject(HashMap SearchMap, String showLevel)`
`Vector`	`getExtLogStatisticUserObject(HashMap conhMap)`
`Vector`	`getExtraFeatureList(String docTpID)` get extra features of a DocumentTemplate
`Vector`	`getExtUserNotDownload(HashMap map)` Deprecated. v2.2 HotFix_91 use `getExtUserNotDownloadPDoc(Map)` instead
`Map`	`getExtUserNotDownloadPDoc(Map map)` Retrieve the `VirtualDocument`s which has not been downloaed by external user.
`VirtualFolder`	`getExtVirtualFolder(String userID, String folderID)` Retrieve the external `VirtualFolder` instance with permission check.
`int`	`getFailedEncodePDCount(String moduleKey)` Retrieve the rows of files which are failed to be encoded/encrypted by Neevia/TrustView.
`List`	`getFailedEncodePDList(String moduleKey)` Retrieve the row count of files which are failed to be encoded/encrypted by Neevia/TrustView.
`Vector`	`getFavoriteItem(String userID)`
`List`	`getFolderIDListByName(String folderName)` Retrieve folder ids by given `folderName` which status is not `DMSUnit.FOLDER_STATUS_DELETED`
`List`	`getFolderIDListByName(String parentFolderID, String folderName)` Retrieve folder ids by given `folderName` which status is not `DMSUnit.FOLDER_STATUS_DELETED` and in the given `parentFolderId`.
`List`	`getFolderIDListExactlyMatchedByName(String folderName)` Retrieve folder ids which exactly mathed the given `folderName` which status is not `DMSUnit.FOLDER_STATUS_DELETED`
`List`	`getFolderIDListExactlyMatchedByName(String parentFolderID, String folderName)` Retrieve folder ids which exactly mathed the given `folderName` which status is not `DMSUnit.FOLDER_STATUS_DELETED` and in the given `parentFolderId`.
`DMSGroup`	`getGroupByID(String groupID)` Get a group by group ID.
`Vector`	`getGroupList()` Get all the groups.
`Vector`	`getGroupList(String sort)` get sort all the groups.
`String[]`	`getGroupsOfUser(String userID)` Retrieve all group id associated to the given user id.
`Vector`	`getIntegrateQuantity(HashMap conMap, Vector depList)`
`Vector`	`getInternalSubscriberOfExtFolder(String folderId)` Retrieve internal subscribers of external folder.
`Map`	`getISODocQuantity(HashMap conMap, Vector depList)`
`Vector`	`getItemList(String parentFolderID, String type)` get the unit item list according to different purpose
`Keyword`	`getKeyword(String kkey)`
`Vector`	`getKeywordCategory(String ckey)`
`Vector`	`getKeywordCategory(String ckey, boolean all)`
`Vector`	`getKeywordItemList(String documentKey)` get the list of the keywords (KeywordItem) of some virtual document with document key as "System", the system category item list would be obtained
`Vector`	`getLogStatisticCountObject(HashMap SearchMap, String showLevel)`
`Vector`	`getLogStatisticFileCountObject(HashMap SearchMap, String showLevel)`
`Vector`	`getLogStatisticsConfig(String behaviorName, String behaviorAcction)`
`Vector`	`getLogStatisticUserObject(HashMap conhMap)`
`AttributeType`	`getLv4DocType()` Deprecated. DO NOT CALL THIS METHOD. IT' A OUT OF DATE FUNCTION. SHOULD BE REMOVED. 2006/09/18 shihwei
`AttributeType`	`getMixAttributeTypeByPublishFolder(String typeID, String publishFolder)`
`List`	`getMyDccExpiryDocument(String userID)` Retrieve the given `userID`'s expiring/expired document.
`Vector`	`getNewDocumentReleased(String currentdate)` Deprecated. by shihwei 2006/12/21
`Vector`	`getNewPublishDocumentKeyList(int num)` Get top `num` rows of the new published document key.
`Vector`	`getParentFolderNameBySubject(String subject)` get ParentFolderName by DocumentID
`PhysicalDocumentItem`	`getPhysicalDocumentItem(String physicalDocumentKey)` Retrieve the `PhysicalDocumentItem` by `physicalDocumentKey`.
`PhysicalDocumentItem`	`getPhysicalDocumentItem(String userID, String physicalDocumentKey)` Retrieve the `PhysicalDocumentItem` by `physicalDocumentKey`.
`List`	`getPhysicalDocumentItemList(String docKey)` Retrieve all `PhysicalDocumentItem`s by `DocumentKey`.
`Vector`	`getPrincipals(String subject, Vector permissions)` Get all principals which have permissions on subject.
`Vector`	`getPrincipals(String subject, Vector permissions, String type)` Get all the principals which have permissions on subject
`Vector`	`getPublishDocList(HashMap conMap)`
`HashMap`	`getPublishQuantityQuery(HashMap conMap, Vector depList)`
`Vector`	`getPublishsortMap(HashMap checkMap)`
`Vector`	`getQuanityQuery(HashMap conMap, Vector depList)`
`int`	`getQueuedEncodePDCount(String moduleKey)` Retrieve the row count of files which are queued to be encoded/encrypted by Neevia/TrustView.
`List`	`getQueuedEncodePDList(String moduleKey)` Retrieve the rows of files which are queued to be encoded/encrypted by Neevia/TrustView.
`Vector`	`getRelationList(String key, String keyType)`
`Vector`	`getRelationList(String key, String keyType, String relationType)`
`Vector`	`getRelationListByDocKey(String sourceKey, String targetKey)`
`Vector`	`getRelationListBySourceKey(String sourceKey, String relationType)`
`Vector`	`getRelationRecordList(String key)` Retrieve the UpToDate document(s) which the given document (key) is relating to.
`Vector`	`getRelationRecordList(String key, String relationType)`
`Vector`	`getRelationRecordListBySourceKey(String key)`
`Vector`	`getRelationRecordListByTarget(String key)` Retrieve the UpToDate document(s) which the given document (key) is related by.
`Repository`	`getRepository(String repositoryKey)` Get a repository specified by RepositoryKey on DMS server
`Vector`	`getRepositoryList()` Get all the repository on DMS server.
`Vector`	`getReviewList(String documentKey)`
`ReviewListItem`	`getReviewListItem(String reviewKey)`
`Vector`	`getRootAttributeList()` get Root AttributeList
`Vector`	`getRootPathFolderItemList(String folderID)` Retrieve a list of folders which contains all folders on the path from root to the folder pointed by folderID.
`Shortcut`	`getShortcut(String userID, String shortcutID)` Retrieve the `getShortcut` instance.
`List`	`getShortcutListByTarget(String targetKey)` Retrieve the `Shortcut`(s) by target.
`Vector`	`getSignRecordList(String docKey)`
`Vector`	`getSubscriberIDListBySubject(String subject)` get all the user subscribing the list, return the list of userIDs in DMSUser
`HashMap`	`getSubscribingListByUser(String userID)` Get a DocumentTemplate by id
`Vector`	`getSystemCategoryItemList(String repositoryID)` get the list of the categories (CategoryItem) defined for target repository by system
`String`	`getSystemPolicy(String key)` We do not recommend you to use this API.
`Vector`	`getTreeFolderIDList(String targetFolderID)` get the IDs of all the sub folder of the target folder, notice the list would include the target folder itself
`UnitItem`	`getUnitItem(String userID, String unitKey, String unitType)` Return single UnitItem for display
`VirtualDocumentInfo`	`getUpToDateDocument(String documentID)` get UpToDate VirtualDocumetInfo From DocumentID
`VirtualDocumentInfo`	`getUpToDateDocumentByDocKey(String documentKey)`
`HashMap`	`getURLActionNMappingData()`
`DMSUser`	`getUserByID(String userID)` Get User by userID.
`DMSUser`	`getUserByLoginID(String loginID)` Get User by loginID
`Vector`	`getUserList()` Get a list of all users.
`Vector`	`getUserListByStatus(String status)` Get a list of all users with the specified status.
`Vector`	`getUserListByType(String type)` Get list of all users with the specified type.
`Vector`	`getVDKeywordItem(String key)`
`Vector`	`getVDTemplate()` Retrieve the `VDTemplate` list.
`Vector`	`getVFConfigInfo()` Deprecated. V3.0
`VirtualDocument`	`getVirtualDocument(String documentKey)` Retrieve the `VirtualDocument`.
`VirtualDocument`	`getVirtualDocument(String userID, String documentKey)` Retrieve the `VirtualDocument` instance with permission check.
`VirtualDocumentInfo`	`getVirtualDocumentInfo(String documentKey)` Retrieve the `VirtualDocumentInfo`.
`VirtualDocumentInfo`	`getVirtualDocumentInfo(String userID, String documentKey)` Retrieve the `VirtualDocumentInfo` instance with permission check.
`VirtualDocumentInfo`	`getVirtualDocumentInfoByPDocKey(String pdocKey)` Retrieve `VirtualDocumentInfo` by `PhysicalDocumentItem`'s physicalDocumentKey.
`VirtualFolder`	`getVirtualFolder(String folderID)` Retrieve the `VirtualFolder` instance.
`VirtualFolder`	`getVirtualFolder(String userID, String folderID)` Retrieve the `VirtualFolder` instance with permission check.
`VirtualFolderInfo`	`getVirtualFolderInfo(String folderID)` Retrieve the `VirtualFolderInfo` instance.
`VirtualFolderInfo`	`getVirtualFolderInfo(String userID, String folderID)` Retrieve the `VirtualFolderInfo` instance with permission check.
`int`	`getWaitEncodePDCount(String moduleKey)` Retrieve the row count of files which are waiting to be encoded/encrypted by Neevia/TrustView.
`List`	`getWaitEncodePDList(String moduleKey)` Retrieve the rows of files which are waiting to be encoded/encrypted by Neevia/TrustView.
`String`	`IDhasExisted(String subjectKey)` add a function to judge doc/folder whether it has existed in 2004/12/24
`DMSResult`	`initFavorites(String userID, String targetKey, String favoriteType)` Deprecated. V3.0 Moved to `AccessControlService.initFavorites(String, String, String)`.
`DMSResult`	`initGetDocument(String userID, String docKey)` Deprecated. V3.0 Moved to `AccessControlService.initGetDocument(String, String)`.
`DMSResult`	`initGetFolder(String userID, String folderID)` Deprecated. V3.0 Moved to `AccessControlService.initGetFolder(String, String)`.
`boolean`	`isExternalDownloadEnable()` Is the optional 'External Download Module' enabled.
`boolean`	`isHaveSubDocument(String folderID)` check if there's any sub-document in the target folder specified by folderID
`boolean`	`isHaveSubFolder(String folderID)` check if there's any sub-folder in the target folder specified by folderID
`boolean`	`isTheFolderRelateByOnlyOneAttr(String folderID)`
`Vector`	`loadValue(String sql)` select sql to DMS DB
`void`	`preCacheAll()`
`List`	`searchDeptByName(String keyword)` Search department by query string.
`List`	`searchMemberByName(String keyword)` Search member by query string.
`List`	`searchRoleByName(String keyword)` Search role by query string.
`boolean`	`setExtLogStatisticData(HashMap LOMap)`
`boolean`	`setLogStatisticData(HashMap LOMap)`
`boolean`	`updatePhysicalDocumentItem(PhysicalDocumentItem item)` Deprecated. Moved to `PhysicalDocumentAccessService.updatePhysicalDocumentItem(PhysicalDocumentItem)`
`boolean`	`updateValue(String sql)` update,insert,delete sql to DMS DB

Method Detail

getPhysicalDocumentItem

PhysicalDocumentItem getPhysicalDocumentItem(String userID,
                                             String physicalDocumentKey)
                                             throws RemoteException

Retrieve the PhysicalDocumentItem by physicalDocumentKey.

Parameters:: userID -; physicalDocumentKey -
Returns:: PhysicalDocumentItem
Throws:: RemoteException

getPhysicalDocumentItem

PhysicalDocumentItem getPhysicalDocumentItem(String physicalDocumentKey)
                                             throws RemoteException

Retrieve the PhysicalDocumentItem by physicalDocumentKey.

Parameters:: physicalDocumentKey -
Returns:: PhysicalDocumentItem
Throws:: RemoteException

getPhysicalDocumentItemList

List getPhysicalDocumentItemList(String docKey)
                                 throws RemoteException

Retrieve all PhysicalDocumentItems by DocumentKey.

Parameters:: docKey - VirtualDocumentInfo's DocumentKey
Returns:: List each element is PhysicalDocumentItem
Throws:: RemoteException
Since:: V3.0

getUnitItem

UnitItem getUnitItem(String userID,
                     String unitKey,
                     String unitType)
                     throws RemoteException

Return single UnitItem for display

Parameters:: userID -; unitKey - according to the unitType, key could be 'DocKet_0123456789', 'Folder_0000000001', or 'Shortcut_0000000001'.; unitType - DMSUnit.UNIT_TYPE_FOLDER, DMSUnit.UNIT_TYPE_DOCUMENT, DMSUnit.UNIT_TYPE_SHORTCUT
Returns:: UnitItem
Throws:: RemoteException

getVirtualDocument

VirtualDocument getVirtualDocument(String userID,
                                   String documentKey)
                                   throws RemoteException

Retrieve the VirtualDocument instance with permission check.

Parameters:: userID -; documentKey -
Returns:: VirtualDocument
Throws:: RemoteException

getVirtualDocument

VirtualDocument getVirtualDocument(String documentKey)
                                   throws RemoteException

Retrieve the VirtualDocument.

Parameters:: documentKey -
Returns:: VirtualDocument
Throws:: RemoteException
Since:: V3.0 HotFix_32

getVirtualDocumentInfo

VirtualDocumentInfo getVirtualDocumentInfo(String userID,
                                           String documentKey)
                                           throws RemoteException

Retrieve the VirtualDocumentInfo instance with permission check.

Parameters:: userID -; documentKey -
Returns:: VirtualDocumentInfo
Throws:: RemoteException

getVirtualDocumentInfo

VirtualDocumentInfo getVirtualDocumentInfo(String documentKey)
                                           throws RemoteException

Retrieve the VirtualDocumentInfo.

Parameters:: documentKey -
Returns:: VirtualDocumentInfo
Throws:: RemoteException
Since:: V3.0 HotFix_32

getVirtualDocumentInfoByPDocKey

VirtualDocumentInfo getVirtualDocumentInfoByPDocKey(String pdocKey)
                                                    throws RemoteException

Retrieve VirtualDocumentInfo by PhysicalDocumentItem's physicalDocumentKey.

Parameters:: pdocKey -
Returns:: VirtualDocumentInfo
Throws:: RemoteException
Since:: V2.2 HotFix_91

getDocumentListByFuzzyKey

List getDocumentListByFuzzyKey(int limitResultCnt,
                               String keyType,
                               String partialKey,
                               boolean onlyUpToDate)
                               throws RemoteException

Retrieve the

VirtualDocumentInfo list by partial of the DocumentKey, DocumentID or SerialID.



Parameters:
limitResultCnt - specify the result row counts.
keyType - identify the partialKey: byDocKey, byDocID, bySerialID
partialKey - it could starts with the DocumentKey, DocumentID or SerialID.
Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:

  V3.0





getExternalDocListByFuzzyName
List getExternalDocListByFuzzyName(String externalUserID,
                                   int limitResultCnt,
                                   String searchKeyword,
                                   int rtnType)
                                   throws RemoteException





Parameters:
externalUserID - external user id
limitResultCnt - specify the result row counts.
keyType - 
searchKeyword - 
rtnType - 0 or 1
Returns:
List if rtnType=0, then each element is Document Name,
         else if rtnType=1, then each element is VirtualDocumentInfo,
         else each element is VirtualDocumentInfo.
Throws:
RemoteException





getVirtualFolder
VirtualFolder getVirtualFolder(String userID,
                               String folderID)
                               throws RemoteException

Retrieve the VirtualFolder instance with permission check.





Parameters:
userID - 
folderID - 
Returns:
VirtualFolder null if not exists or user has no permission to this folder.
Throws:
RemoteException





getVirtualFolder
VirtualFolder getVirtualFolder(String folderID)
                               throws RemoteException

Retrieve the VirtualFolder instance.





Parameters:
folderID - 
Returns:
VirtualFolder
Throws:
RemoteException





getExtVirtualFolder
VirtualFolder getExtVirtualFolder(String userID,
                                  String folderID)
                                  throws RemoteException

Retrieve the external VirtualFolder instance with permission check.





Parameters:
userID - 
folderID - 
Returns:
VirtualFolder null if not exists or user has no permission to this folder.
Throws:
RemoteException





getVirtualFolderInfo
VirtualFolderInfo getVirtualFolderInfo(String userID,
                                       String folderID)
                                       throws RemoteException

Retrieve the VirtualFolderInfo instance with permission check.





Parameters:
userID - 
folderID - 
Returns:
VirtualFolderInfo null if not exists or user has no permission to this folder.
Throws:
RemoteException





getVirtualFolderInfo
VirtualFolderInfo getVirtualFolderInfo(String folderID)
                                       throws RemoteException

Retrieve the VirtualFolderInfo instance.





Parameters:
folderID - 
Returns:
VirtualFolderInfo
Throws:
RemoteException
Since:
  V3.0 HotFix_32






getShortcut
Shortcut getShortcut(String userID,
                     String shortcutID)
                     throws RemoteException

Retrieve the getShortcut instance.





Parameters:
userID - 
shortcutID - 
Returns:
getShortcut
Throws:
RemoteException





getShortcutListByTarget
List getShortcutListByTarget(String targetKey)
                             throws RemoteException

Retrieve the Shortcut(s) by target.





Parameters:
targetKey - can be DocumentKey or FolderID
Returns:
List each element is Shortcut
Throws:
RemoteException
Since:
  V3.0






getAttributeType
AttributeType getAttributeType(String typeID)
                               throws RemoteException

Retrieve the AttributeType instance.





Parameters:
typeID - 
Returns:
AttributeType
Throws:
RemoteException





getAttributeTypeByPublishFolder
AttributeType getAttributeTypeByPublishFolder(String typeID,
                                              String publishFolder)
                                              throws RemoteException

Retrieve the AttributeType instance.
 
 

  We do not recommend you to use this API. This API is going to be deprecated.





Parameters:
typeID - 
publishFolder - 
Returns:

Throws:
RemoteException





getVDTemplate
Vector getVDTemplate()
                     throws RemoteException

Retrieve the VDTemplate list.






Returns:
Vector each element is Hashtable. 
         Keys are 'TemplateID', 'TemplateName', and 'TemplateDescription'.
Throws:
RemoteException





getACL
Vector getACL(String subject)
              throws RemoteException

Retrieve a list of AccessControlItem which describes the Access Control List
 of the item figured by subject.





Parameters:
subject - for a document: DocumentKey, for a folder: FolderID
Returns:
Vector each element is AccessControlItem
Throws:
RemoteException





getSystemPolicy
String getSystemPolicy(String key)
                       throws RemoteException

 We do not recommend you to use this API. 





Parameters:
key - 
Returns:

Throws:
RemoteException





getRootPathFolderItemList
Vector getRootPathFolderItemList(String folderID)
                                 throws RemoteException

Retrieve a list of folders which contains all folders on the
 path from root to the folder pointed by folderID.





Parameters:
folderID - the folderID of the leaf folder in the root path
Returns:
Vector each element is HashMap of VirtualFolderInfo.getTinyMap()
Throws:
RemoteException





getRepositoryList
Vector getRepositoryList()
                         throws RemoteException

Get all the repository on DMS server.
 
 There are two respositories on this time (Root & External repository.)
 The caller method should handle the limitation of visibility of each repository.
 For example, 'External Download Repository' is not visible for customers who does not
 buy the optional 'External Download Module'.






Returns:
Vector each element is Repository
Throws:
RemoteException





getRepository
Repository getRepository(String repositoryKey)
                         throws RemoteException

Get a repository specified by RepositoryKey on DMS server





Parameters:
repositoryKey - 
Returns:
- return the specified Repository or null if there is no such repository.
Throws:
RemoteException





getUserByID
DMSUser getUserByID(String userID)
                    throws RemoteException

Get User by userID.





Parameters:
userID - Agentflow member id.
Returns:
DMSUser
Throws:
RemoteException





getUserByLoginID
DMSUser getUserByLoginID(String loginID)
                         throws RemoteException

Get User by loginID





Parameters:
loginID - 
Returns:
DMSUser
Throws:
RemoteException





getUserList
Vector getUserList()
                   throws RemoteException

Get a list of all users.
 
 We do not recommend you to use this API. Unless you know what the table 'UserList' means.






Returns:
Vector each element is DMSUser in the table 'UserList'.
Throws:
RemoteException





getUserListByStatus
Vector getUserListByStatus(String status)
                           throws RemoteException

Get a list of all users with the specified status.
 
 We do not recommend you to use this API. Unless you know what the table 'UserList' means.






Returns:
Vector each element is DMSUser in the table 'UserList'.
Throws:
RemoteException





getUserListByType
Vector getUserListByType(String type)
                         throws RemoteException

Get list of all users with the specified type.
 
 We do not recommend you to use this API. Unless you know what the table 'UserList' means.





Parameters:
type - 
Returns:
Vector each element is DMSUser in the table 'UserList'.
Throws:
RemoteException





getGroupByID
DMSGroup getGroupByID(String groupID)
                      throws RemoteException

Get a group by group ID.





Parameters:
groupID - 
Returns:
DMSGroup
Throws:
RemoteException





getExtGroupByID
DMSGroup getExtGroupByID(String groupID)
                         throws RemoteException

Get a external group by external group ID.





Parameters:
groupID - 
Returns:
DMSGroup
Throws:
RemoteException





getChildGroupInfoList
Vector getChildGroupInfoList(String groupID)
                             throws RemoteException

Get the child group of some group





Parameters:
groupID - 
Returns:
Vector each element is DMSGroupInfo of all sub-groups of the specified group
Throws:
RemoteException





getChildUserList
Vector getChildUserList(String groupID)
                        throws RemoteException

get the child users of some group






Returns:
a vector with DMSUser of all sub-users of the specified group
Throws:
RemoteException





getGroupList
Vector getGroupList()
                    throws RemoteException

Get all the groups.






Returns:
Vector each element is DMSGroup
Throws:
RemoteException





getGroupList
Vector getGroupList(String sort)
                    throws RemoteException

get sort all the groups.






Returns:
Vector each element is DMSGroup
Throws:
RemoteException





getGroupsOfUser
String[] getGroupsOfUser(String userID)
                         throws RemoteException

Retrieve all group id associated to the given user id.





Parameters:
userID - 
Returns:
group id in String array
Throws:
RemoteException
Since:
  V3.0






getPrincipals
Vector getPrincipals(String subject,
                     Vector permissions)
                     throws RemoteException

Get all principals which have permissions on subject.





Parameters:
subject - target DocumentKey or FolderID
permissions - list of required permissions (roles)
Returns:
the Vector with IDs of all the principals
Throws:
RemoteException





getPrincipals
Vector getPrincipals(String subject,
                     Vector permissions,
                     String type)
                     throws RemoteException

Get all the principals which have permissions on subject





Parameters:
subject - target DocumentKey or FolderID
permissions - list of required permissions (roles)
type - ["", DMSUnit.DB_KEYHEADER_PHYSICALDOCUMENTKEY]
Returns:
the Vector with IDs of all the principals
Throws:
RemoteException





getEffectiveOrgIDs
Vector getEffectiveOrgIDs(String userID)
                          throws RemoteException

Get a list of all the organization ids (GroupID and UserID) which is effective as the specified userID





Parameters:
userID - 
Returns:
Vector each element is role id, dept id, member id, and group id.
Throws:
RemoteException





getEffectiveGroupIDs
Vector getEffectiveGroupIDs(String groupID)
                            throws RemoteException

Get a list of all the Group IDs which is effective as the specified GroupID.





Parameters:
groupID - 
Returns:
Vector each element is group id.
Throws:
RemoteException





getDocumentTemplateList
Vector getDocumentTemplateList()
                               throws RemoteException

Get all the Document Template on the DMS






Throws:
RemoteException





getDocumentTemplate
DocumentTemplate getDocumentTemplate(String documentTemplateID)
                                     throws RemoteException

Get a DocumentTemplate by id, if the template is not existent return null






Throws:
RemoteException





getSubscribingListByUser
HashMap getSubscribingListByUser(String userID)
                                 throws RemoteException

Get a DocumentTemplate by id






Throws:
RemoteException





getSubscriberIDListBySubject
Vector getSubscriberIDListBySubject(String subject)
                                    throws RemoteException

get all the user subscribing the list, return the list of userIDs in DMSUser






Throws:
RemoteException





getAllSubscriberListBySubject
Vector getAllSubscriberListBySubject(String subject)
                                     throws RemoteException

get all the user subscribing the list, return the list of DMSUser






Throws:
RemoteException





getExternalSubscriberOfExtFolder
Vector getExternalSubscriberOfExtFolder(String folderId)
                                        throws RemoteException

Retrieve external subscribers of external folder.





Parameters:
folderId - 
Returns:
Vector each element is String of ids.
Throws:
RemoteException





getInternalSubscriberOfExtFolder
Vector getInternalSubscriberOfExtFolder(String folderId)
                                        throws RemoteException

Retrieve internal subscribers of external folder.





Parameters:
folderId - 
Returns:
Vector each element is String of ids.
Throws:
RemoteException





getParentFolderNameBySubject
Vector getParentFolderNameBySubject(String subject)
                                    throws RemoteException

get ParentFolderName by DocumentID






Throws:
RemoteException





getExtraFeatureList
Vector getExtraFeatureList(String docTpID)
                           throws RemoteException

get extra features of a DocumentTemplate






Throws:
RemoteException





getCheckOutRecord
CheckOutRecord getCheckOutRecord(String key,
                                 String keyType)
                                 throws RemoteException

Get the check out record





Parameters:
key - the document key of the original checked out document or the copied document
keyType - figuring out what type of the document the key is repsenting.
            It could be DMSUnit.DOCUMENT_TYPE_ORIGINAL 
            or DMSUnit.DOCUMENT_TYPE_CHECKEDOUTCOPY .
Returns:
if the record is not existed, return null
Throws:
RemoteException





getTreeFolderIDList
Vector getTreeFolderIDList(String targetFolderID)
                           throws RemoteException

get the IDs of all the sub folder of the target folder, notice the list would include the target folder
 itself






Throws:
RemoteException





IDhasExisted
String IDhasExisted(String subjectKey)
                    throws RemoteException

add a function to judge doc/folder whether it has existed in 2004/12/24





Parameters:
subjectKey - String
Returns:
String
Throws:
RemoteException





getItemList
Vector getItemList(String parentFolderID,
                   String type)
                   throws RemoteException

get the unit item list according to different purpose





Parameters:
type - figure out what kind of unit items is required to be included in the list 

        Folder_Normal: get all the normal items in the specified folder 

        Folder_Deleted: get all the deleted items in the specified folder 

    Folder_Expired: get all the expired items in the specified folder 

        Folder_All: get all the items in the specified folder 

        All_Normal: get all the normal items in the system 

        All_Deleted: get all the deleted items in the system 

    All_Expired: get all the expired items in the system 

        All_All: get all the items in the system 

Throws:
RemoteException





getApproveRequestList
Vector getApproveRequestList(String userID)
                             throws RemoteException

get the approve request submitted by a user






Throws:
RemoteException





getApproveRequestListByDocument
Vector getApproveRequestListByDocument(String documentKey)
                                       throws RemoteException

get all the approve requests related to the target document






Throws:
RemoteException





initGetFolder
DMSResult initGetFolder(String userID,
                        String folderID)
                        throws RemoteException

Deprecated. V3.0 Moved to AccessControlService.initGetFolder(String, String).






Throws:
RemoteException





initGetDocument
DMSResult initGetDocument(String userID,
                          String docKey)
                          throws RemoteException

Deprecated. V3.0 Moved to AccessControlService.initGetDocument(String, String).






Throws:
RemoteException





getCheckInMode
String getCheckInMode(String docKey,
                      String keyType)
                      throws RemoteException

get the check in mode of the specified checked out document





Parameters:
docKey - the document key of the checked out document or the copy of the checked doccyment
keyType - figuring out if the document specified by the docKey is the checked out original document
        or a copy
Throws:
RemoteException





getCategoryList
Vector getCategoryList(String repositoryID)
                       throws RemoteException

get the list of the categories (CategoryItem) defined for target repository






Throws:
RemoteException





getCategoryList
Vector getCategoryList()
                       throws RemoteException

get the list of the categories defined for target is "system"






Throws:
RemoteException





getSystemCategoryItemList
Vector getSystemCategoryItemList(String repositoryID)
                                 throws RemoteException

get the list of the categories (CategoryItem) defined for target repository by system






Throws:
RemoteException





getCategoryItemList
Vector getCategoryItemList(String documentKey)
                           throws RemoteException

get the list of the categories (CategoryItem) of some virtual document
 with document key as "System", the system category item list would be obtained






Throws:
RemoteException





getKeywordItemList
Vector getKeywordItemList(String documentKey)
                          throws RemoteException

get the list of the keywords (KeywordItem) of some virtual document
 with document key as "System", the system category item list would be obtained






Throws:
RemoteException





getCategoryItem
CategoryItem getCategoryItem(String CategoryKey)
                             throws RemoteException

get category item by key






Throws:
RemoteException





getDeletingRecordList
Vector getDeletingRecordList()
                             throws RemoteException

get all the deleting record about documents and folders






Throws:
RemoteException





isHaveSubFolder
boolean isHaveSubFolder(String folderID)
                        throws RemoteException

check if there's any sub-folder in the target folder specified by folderID






Throws:
RemoteException





isHaveSubDocument
boolean isHaveSubDocument(String folderID)
                          throws RemoteException

check if there's any sub-document in the target folder specified by folderID






Throws:
RemoteException





getNewDocumentReleased
Vector getNewDocumentReleased(String currentdate)
                              throws RemoteException

Deprecated. by shihwei 2006/12/21





Parameters:
currentdate - 
Returns:

Throws:
RemoteException





getAFCompany
pe.pase.Company getAFCompany()
                             throws RemoteException






Throws:
RemoteException





getDMSCompany
DMSCompany getDMSCompany(String cID)
                         throws RemoteException






Throws:
RemoteException
Since:
  V3.0 HotFix_20






getComIDListOfMember
Vector getComIDListOfMember(String mID)
                            throws RemoteException






Throws:
RemoteException
Since:
  V3.0 HotFix_20






getComIdOfDep
String getComIdOfDep(String dID)
                     throws RemoteException






Throws:
RemoteException
Since:
  V3.0 HotFix_20






getComIdOfRole
String getComIdOfRole(String rID)
                      throws RemoteException






Throws:
RemoteException
Since:
  V3.0 HotFix_20






getAFMember
pe.pase.MemberRecord getAFMember(String mID)
                                 throws RemoteException






Throws:
RemoteException





getAFRole
pe.pase.Role getAFRole(String rID)
                       throws RemoteException






Throws:
RemoteException





getAFDepartment
pe.pase.Department getAFDepartment(String dID)
                                   throws RemoteException






Throws:
RemoteException





getAFMemberByLoginID
pe.pase.MemberRecord getAFMemberByLoginID(String loginID)
                                          throws RemoteException






Throws:
RemoteException





getVFConfigInfo
Vector getVFConfigInfo()
                       throws RemoteException

Deprecated. V3.0






Returns:

Throws:
RemoteException





getAllAttributeTypeList
List getAllAttributeTypeList()
                             throws RemoteException

Retrieve all document types.






Returns:
List each element is AttributeType
Throws:
RemoteException





getAttributeList
Vector getAttributeList(String parentAttributeTypeID)
                        throws RemoteException

Retrieve Sub AttributeType by parentAttributeTypeID






Returns:
Vector each element is AttributeType
Throws:
RemoteException





getAttributeTypeIDByName
List getAttributeTypeIDByName(String typeName)
                              throws RemoteException

Retrieve the AttributeType's id by the given AttributeType's name.






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






getAttributeIDList
Vector getAttributeIDList()
                          throws RemoteException






Returns:
Vector each element is String[] 0: type id, 1: type name.
Throws:
RemoteException





getAllParentAttributeIDList
Vector getAllParentAttributeIDList(String attributeTypeID)
                                   throws RemoteException

For DCC  Process V.3.0.0 HotFix_20






Returns:
Vector each element is AttributeType
Throws:
RemoteException
Since:
  V3.0 HotFix_26






getRootAttributeList
Vector getRootAttributeList()
                            throws RemoteException

get Root AttributeList






Returns:
Vector
Throws:
RemoteException





getAttTempleteIDAuto
String getAttTempleteIDAuto(String attID)
                            throws RemoteException






Throws:
RemoteException





getAttPublishFolderAuto
String getAttPublishFolderAuto(String attID)
                               throws RemoteException

Deprecated. Since V2.2 AttributeType can specify more than one default publish folder, 
             so it cannot be decided by system.





Parameters:
attID - 
Returns:

Throws:
RemoteException





getAttSerialTypeIDAuto
String getAttSerialTypeIDAuto(String attID)
                              throws RemoteException






Throws:
RemoteException





getAttSerialFormatAuto
String getAttSerialFormatAuto(String attID)
                              throws RemoteException






Throws:
RemoteException





getAttMaxFileSizeAuto
String getAttMaxFileSizeAuto(String attID)
                             throws RemoteException






Throws:
RemoteException





getAttAttachFileTypeAuto
String getAttAttachFileTypeAuto(String attID)
                                throws RemoteException






Throws:
RemoteException





getAttIsISODocAuto
String getAttIsISODocAuto(String attID)
                          throws RemoteException






Throws:
RemoteException





getAttIsoLevelAuto
String getAttIsoLevelAuto(String attID)
                          throws RemoteException






Throws:
RemoteException





getReviewList
Vector getReviewList(String documentKey)
                     throws RemoteException






Throws:
RemoteException





getReviewListItem
ReviewListItem getReviewListItem(String reviewKey)
                                 throws RemoteException






Throws:
RemoteException





getRelationRecordList
Vector getRelationRecordList(String key)
                             throws RemoteException

Retrieve the UpToDate document(s) which the given document (key) is relating to.





Parameters:
key - could be the document key or document id.
Returns:
Vector each element is RelationRecord
Throws:
RemoteException





getRelationRecordListByTarget
Vector getRelationRecordListByTarget(String key)
                                     throws RemoteException

Retrieve the UpToDate document(s) which the given document (key) is related by.





Parameters:
key - could be the document key or document id.
Returns:
Vector each element is RelationRecord
Throws:
RemoteException





getRelationRecordList
Vector getRelationRecordList(String key,
                             String relationType)
                             throws RemoteException






Throws:
RemoteException





getRelationRecordListBySourceKey
Vector getRelationRecordListBySourceKey(String key)
                                        throws RemoteException






Throws:
RemoteException





getRelationList
Vector getRelationList(String key,
                       String keyType)
                       throws RemoteException






Throws:
RemoteException





getRelationList
Vector getRelationList(String key,
                       String keyType,
                       String relationType)
                       throws RemoteException






Throws:
RemoteException





getRelationListBySourceKey
Vector getRelationListBySourceKey(String sourceKey,
                                  String relationType)
                                  throws RemoteException






Throws:
RemoteException





getRelationListByDocKey
Vector getRelationListByDocKey(String sourceKey,
                               String targetKey)
                               throws RemoteException






Throws:
RemoteException





getKeyword
Keyword getKeyword(String kkey)
                   throws RemoteException






Throws:
RemoteException





getKeywordCategory
Vector getKeywordCategory(String ckey)
                          throws RemoteException






Throws:
RemoteException





getKeywordCategory
Vector getKeywordCategory(String ckey,
                          boolean all)
                          throws RemoteException






Throws:
RemoteException





getVDKeywordItem
Vector getVDKeywordItem(String key)
                        throws RemoteException






Throws:
RemoteException





getSignRecordList
Vector getSignRecordList(String docKey)
                         throws RemoteException






Throws:
RemoteException





getLv4DocType
AttributeType getLv4DocType()
                            throws RemoteException

Deprecated. DO NOT CALL THIS METHOD. IT' A OUT OF DATE FUNCTION. SHOULD BE REMOVED. 2006/09/18 shihwei






Throws:
RemoteException





getFavoriteItem
Vector getFavoriteItem(String userID)
                       throws RemoteException






Throws:
RemoteException





getCurrentARList
List getCurrentARList(HashMap searchMap)
                      throws RemoteException

Retrieve the ApproveRequest of 
 APPROVE_TYPE_PUBLISH/
 APPROVE_TYPE_CHECKIN/
 APPROVE_TYPE_OBSOLETE 
 which are still on going.






Returns:
List each element is ApproveRequest
Throws:
RemoteException





getCurrentPublishAR
ApproveRequest getCurrentPublishAR(String documentKey)
                                   throws RemoteException

Retrieve the current publishing ApproveRequest by document key.





Parameters:
documentKey - 
Returns:
ApproveRequest
Throws:
RemoteException





getCurrentCheckInAR
ApproveRequest getCurrentCheckInAR(String documentKey)
                                   throws RemoteException

Retrieve the current checking in ApproveRequest by document key.





Parameters:
documentKey - this the copied document key
Returns:
ApproveRequest
Throws:
RemoteException
Since:
  V3.0 + V2.2 HotFix_63






getCurrentObsoleteAR
ApproveRequest getCurrentObsoleteAR(String documentKey)
                                    throws RemoteException

Retrieve the current obsoleting ApproveRequest by document key.





Parameters:
documentKey - 
Returns:
ApproveRequest
Throws:
RemoteException
Since:
  V3.0 + V2.2 HotFix_63






getCurrentObsoleteAROfUser
List getCurrentObsoleteAROfUser(String userID)
                                throws RemoteException

Retrieve the current obsoleting ApproveRequests of the user.





Parameters:
userID - who request the obsolete approval workflow.
Returns:
List each element is ApproveRequest
Throws:
RemoteException
Since:
  V3.0 + V2.2 HotFix_63






getApproveRequestRegistrationByTaskID
ApproveRequest getApproveRequestRegistrationByTaskID(String taskID)
                                                     throws RemoteException






Throws:
RemoteException





checkLv4RelatedDocStatus
Vector checkLv4RelatedDocStatus(String sourceDocKey)
                                throws RemoteException






Throws:
RemoteException





initFavorites
DMSResult initFavorites(String userID,
                        String targetKey,
                        String favoriteType)
                        throws RemoteException

Deprecated. V3.0 Moved to AccessControlService.initFavorites(String, String, String).






Throws:
RemoteException





loadValue
Vector loadValue(String sql)
                 throws RemoteException

select sql to DMS DB





Parameters:
sql - String
Returns:
Vector
Throws:
RemoteException





updateValue
boolean updateValue(String sql)
                    throws RemoteException

update,insert,delete  sql to DMS DB





Parameters:
sql - String
Returns:
boolean
Throws:
RemoteException





batchUpdateValue
int[] batchUpdateValue(String[] sqls)
                       throws RemoteException

Adds the given SQL command to the current list of commmands for this
 Statement object. The commands in this list can be
 executed as a batch by calling the method executeBatch.





Parameters:
sqls - 
Returns:
an array of update counts containing one element for each
 command in the batch.  The elements of the array are ordered according 
 to the order in which commands were added to the batch.
Throws:
RemoteException
Since:
  V3.0 HotFix_27






getUpToDateDocument
VirtualDocumentInfo getUpToDateDocument(String documentID)
                                        throws RemoteException

get UpToDate VirtualDocumetInfo From DocumentID





Parameters:
docKey - String
Returns:
VirtualDocumentInfo
Throws:
RemoteException





getUpToDateDocumentByDocKey
VirtualDocumentInfo getUpToDateDocumentByDocKey(String documentKey)
                                                throws RemoteException






Throws:
RemoteException





getURLActionNMappingData
HashMap getURLActionNMappingData()
                                 throws RemoteException






Throws:
RemoteException





setLogStatisticData
boolean setLogStatisticData(HashMap LOMap)
                            throws RemoteException






Throws:
RemoteException





getLogStatisticCountObject
Vector getLogStatisticCountObject(HashMap SearchMap,
                                  String showLevel)
                                  throws RemoteException






Throws:
RemoteException





getLogStatisticFileCountObject
Vector getLogStatisticFileCountObject(HashMap SearchMap,
                                      String showLevel)
                                      throws RemoteException






Throws:
RemoteException





getLogStatisticUserObject
Vector getLogStatisticUserObject(HashMap conhMap)
                                 throws RemoteException






Throws:
RemoteException





getDistributionRecordObject
Vector getDistributionRecordObject(HashMap conhMap)
                                   throws RemoteException






Throws:
RemoteException





getDeptContributionListObject
Vector getDeptContributionListObject(HashMap SearchMap,
                                     String showLevel)
                                     throws RemoteException






Throws:
RemoteException





getDocAppreciationData
Vector getDocAppreciationData(HashMap conMap,
                              String showLevel)
                              throws RemoteException






Throws:
RemoteException





getLogStatisticsConfig
Vector getLogStatisticsConfig(String behaviorName,
                              String behaviorAcction)
                              throws RemoteException






Throws:
RemoteException





addUserHomeLink
boolean addUserHomeLink(HashMap map,
                        String loginID)
                        throws RemoteException






Throws:
RemoteException





getDocLogInfo
Vector getDocLogInfo(HashMap condition)
                     throws RemoteException






Throws:
RemoteException





getAdvancedConfigLog
String getAdvancedConfigLog(String logDocID)
                            throws RemoteException






Throws:
RemoteException





getPublishDocList
Vector getPublishDocList(HashMap conMap)
                         throws RemoteException






Throws:
RemoteException





getPublishQuantityQuery
HashMap getPublishQuantityQuery(HashMap conMap,
                                Vector depList)
                                throws RemoteException






Throws:
RemoteException





getQuanityQuery
Vector getQuanityQuery(HashMap conMap,
                       Vector depList)
                       throws RemoteException






Throws:
RemoteException





getIntegrateQuantity
Vector getIntegrateQuantity(HashMap conMap,
                            Vector depList)
                            throws RemoteException






Throws:
RemoteException





getISODocQuantity
Map getISODocQuantity(HashMap conMap,
                      Vector depList)
                      throws RemoteException





Parameters:
conMap: - (Map) Condition parameter, include queryType, checkBoxSelected etc.
depList: - (Vector) The query based on Departments of a Company
Returns:
(Map) 1.totalISODoc: All ISODoc Quantity presently 2.yearlyISODoc: The yearly ISODoc Quantity
Throws:
RemoteException
Since:
  V3.0






getPublishsortMap
Vector getPublishsortMap(HashMap checkMap)
                         throws RemoteException






Throws:
RemoteException





clearCache
void clearCache()
                throws RemoteException






Throws:
RemoteException





clearCache
void clearCache(String type)
                throws RemoteException






Throws:
RemoteException





preCacheAll
void preCacheAll()
                 throws RemoteException






Throws:
RemoteException





getMixAttributeTypeByPublishFolder
AttributeType getMixAttributeTypeByPublishFolder(String typeID,
                                                 String publishFolder)
                                                 throws RemoteException






Throws:
RemoteException





getAttTypeListByPublishFolder
Vector getAttTypeListByPublishFolder(String folderID,
                                     String isDepAtt)
                                     throws RemoteException






Throws:
RemoteException





getAttributeTypesOfFolder
List getAttributeTypesOfFolder(String folderID)
                               throws RemoteException

Retrieve folder's related Document Type.





Parameters:
folderID - 
Returns:
List each element is AttributeType
Throws:
RemoteException
Since:
  V2.2






isTheFolderRelateByOnlyOneAttr
boolean isTheFolderRelateByOnlyOneAttr(String folderID)
                                       throws RemoteException






Throws:
RemoteException





setExtLogStatisticData
boolean setExtLogStatisticData(HashMap LOMap)
                               throws RemoteException






Throws:
RemoteException





getExtLogStatisticUserObject
Vector getExtLogStatisticUserObject(HashMap conhMap)
                                    throws RemoteException






Throws:
RemoteException





getExtLogStatisticCountObject
Vector getExtLogStatisticCountObject(HashMap SearchMap,
                                     String showLevel)
                                     throws RemoteException






Throws:
RemoteException





getExtLogStatisticFileCountObject
Vector getExtLogStatisticFileCountObject(HashMap SearchMap,
                                         String showLevel)
                                         throws RemoteException






Throws:
RemoteException





getExtUserNotDownload
Vector getExtUserNotDownload(HashMap map)
                             throws RemoteException

Deprecated. v2.2 HotFix_91 use getExtUserNotDownloadPDoc(Map) instead

Retrieve the VirtualDocuments which has not been downloaed by external user.





Parameters:
map - contains key: 'userID' - the external user id, 
                      'startDate' & 'endDate' the time period in long format.
Returns:
Vector each element is VirtualDocument
Throws:
RemoteException





getExtUserNotDownloadPDoc
Map getExtUserNotDownloadPDoc(Map map)
                              throws RemoteException

Retrieve the VirtualDocuments which has not been downloaed by external user.





Parameters:
map - contains key: 'userID' - the external user id, 
                      'startDate' & 'endDate' the time period in long format.
Returns:
map content is [key:value] - [extUserId, pdocKey] 
         means not-download pdockeys of the external user
Throws:
RemoteException
Since:
  V2.2 HotFix_91






isExternalDownloadEnable
boolean isExternalDownloadEnable()
                                 throws RemoteException

Is the optional 'External Download Module' enabled.






Returns:
true if it's enabled.
Throws:
RemoteException





getNewPublishDocumentKeyList
Vector getNewPublishDocumentKeyList(int num)
                                    throws RemoteException

Get top num rows of the new published document key.





Parameters:
num - 
Returns:
Vector each element is document key.
Throws:
RemoteException





updatePhysicalDocumentItem
boolean updatePhysicalDocumentItem(PhysicalDocumentItem item)
                                   throws RemoteException

Deprecated. Moved to PhysicalDocumentAccessService.updatePhysicalDocumentItem(PhysicalDocumentItem)





Parameters:
item - PhysicalDocumentItem
Returns:
true/false
Throws:
RemoteException





getAllAFMember
List getAllAFMember()
                    throws RemoteException

Retrieve all Agentflow member.






Returns:
Vector each element is pe.pase.MemberRecord.
Throws:
RemoteException





getAllVirtualFolderInfo
List getAllVirtualFolderInfo()
                             throws RemoteException

Retrieve all folder information.
 This will exclude the 'Workspace' & external folders.






Returns:
List each element is VirtualFolderInfo
Throws:
RemoteException
Since:
  V2.2






getWaitEncodePDCount
int getWaitEncodePDCount(String moduleKey)
                         throws RemoteException

Retrieve the row count of files which are waiting to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
row count
Throws:
RemoteException
Since:
  V3.0






getWaitEncodePDList
List getWaitEncodePDList(String moduleKey)
                         throws RemoteException

Retrieve the rows of files which are waiting to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
List each element is PhysicalDocumentItem
Throws:
RemoteException
Since:
  V3.0






getFailedEncodePDList
List getFailedEncodePDList(String moduleKey)
                           throws RemoteException

Retrieve the row count of files which are failed to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
List each element is PhysicalDocumentItem
Throws:
RemoteException
Since:
  V3.0






getFailedEncodePDCount
int getFailedEncodePDCount(String moduleKey)
                           throws RemoteException

Retrieve the rows of files which are failed to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
row count
Throws:
RemoteException
Since:
  V3.0






getQueuedEncodePDCount
int getQueuedEncodePDCount(String moduleKey)
                           throws RemoteException

Retrieve the row count of files which are queued to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
row count
Throws:
RemoteException
Since:
  V3.0






getQueuedEncodePDList
List getQueuedEncodePDList(String moduleKey)
                           throws RemoteException

Retrieve the rows of files which are queued to be encoded/encrypted by Neevia/TrustView.





Parameters:
moduleKey - only accept DMSUnit.SYSTEM_PDF_CONVERSION_MODULE_ENABLE
                              DMSUnit.SYSTEM_TRUSTVIEW_MODULE_ENABLE
Returns:
List each element is PhysicalDocumentItem
Throws:
RemoteException
Since:
  V3.0






searchMemberByName
List searchMemberByName(String keyword)
                        throws RemoteException

Search member by query string.





Parameters:
keyword - it can be user's name or loginid
Returns:
List each element is MemberRecord
Throws:
RemoteException
Since:
  V3.0






searchRoleByName
List searchRoleByName(String keyword)
                      throws RemoteException

Search role by query string.





Parameters:
keyword - it can be role's name
Returns:
List each element is Role
Throws:
RemoteException
Since:
  V3.0






searchDeptByName
List searchDeptByName(String keyword)
                      throws RemoteException

Search department by query string.





Parameters:
keyword - it can be department's name
Returns:
List each element is Department
Throws:
RemoteException
Since:
  V3.0






getExtDraftDocListByUser
List getExtDraftDocListByUser(String extUserID)
                              throws RemoteException

Retrieve the draft document in external's workspace. [DocShare module]





Parameters:
extUserID - external user's id
Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:
  V3.0






getDocumentKeysByKeyword
List getDocumentKeysByKeyword(String keyword)
                              throws RemoteException

Get DocumentKeys by Keyword





Parameters:
keyword - 
Returns:
List each element is DocumentKey
Throws:
RemoteException





getFolderIDListByName
List getFolderIDListByName(String folderName)
                           throws RemoteException

Retrieve folder ids by given folderName which status is not DMSUnit.FOLDER_STATUS_DELETED





Parameters:
folderName - 
Returns:
List each element is folder id.
Throws:
RemoteException
Since:
  V3.0






getFolderIDListByName
List getFolderIDListByName(String parentFolderID,
                           String folderName)
                           throws RemoteException

Retrieve folder ids by given folderName which status is not DMSUnit.FOLDER_STATUS_DELETED 
 and in the given parentFolderId.





Parameters:
folderName - 
Returns:
List each element is folder id.
Throws:
RemoteException
Since:
  V3.0 HotFix_06






getFolderIDListExactlyMatchedByName
List getFolderIDListExactlyMatchedByName(String folderName)
                                         throws RemoteException

Retrieve folder ids which exactly mathed the given folderName which status is not DMSUnit.FOLDER_STATUS_DELETED





Parameters:
folderName - 
Returns:
List each element is folder id.
Throws:
RemoteException
Since:
  V3.0 HotFix_06






getFolderIDListExactlyMatchedByName
List getFolderIDListExactlyMatchedByName(String parentFolderID,
                                         String folderName)
                                         throws RemoteException

Retrieve folder ids which exactly mathed the given folderName which status is not DMSUnit.FOLDER_STATUS_DELETED
 and in the given parentFolderId.





Parameters:
folderName - 
Returns:
List each element is folder id.
Throws:
RemoteException
Since:
  V3.0 HotFix_06






getMyDccExpiryDocument
List getMyDccExpiryDocument(String userID)
                            throws RemoteException

Retrieve the given userID's expiring/expired document.





Parameters:
userID - 
Returns:
List each element is VirtualDocumentInfo which auhtor or keeper is the userID
Throws:
RemoteException
Since:
  V3.0






getExpiryDocument
List getExpiryDocument(ExpiryDocSearchItem criteria)
                       throws RemoteException

Retrieve the VirtualDocumentInfo(s) which are going to be or has been expired, 
 according to the query criteria.





Parameters:
criteria - query condition
Returns:
List each element is VirtualDocumentInfo
Throws:
RemoteException
Since:
  V3.0






getAllFolderItems
Vector getAllFolderItems(String folderID,
                         String orderField,
                         boolean order,
                         String type)
                         throws RemoteException






Throws:
RemoteException














  
      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.

ogre.dms.service Interface QueryService

getPhysicalDocumentItem

getPhysicalDocumentItem

getPhysicalDocumentItemList

getUnitItem

getVirtualDocument

getVirtualDocument

getVirtualDocumentInfo

getVirtualDocumentInfo

getVirtualDocumentInfoByPDocKey

getDocumentListByFuzzyKey

getExternalDocListByFuzzyName

getVirtualFolder

getVirtualFolder

getExtVirtualFolder

getVirtualFolderInfo

getVirtualFolderInfo

getShortcut

getShortcutListByTarget

getAttributeType

getAttributeTypeByPublishFolder

getVDTemplate

getACL

getSystemPolicy

getRootPathFolderItemList

getRepositoryList

getRepository

getUserByID

getUserByLoginID

getUserList

getUserListByStatus

getUserListByType

getGroupByID

getExtGroupByID

getChildGroupInfoList

getChildUserList

getGroupList

getGroupList

getGroupsOfUser

getPrincipals

getPrincipals

getEffectiveOrgIDs

getEffectiveGroupIDs

getDocumentTemplateList

getDocumentTemplate

getSubscribingListByUser

getSubscriberIDListBySubject

getAllSubscriberListBySubject

getExternalSubscriberOfExtFolder

getInternalSubscriberOfExtFolder

getParentFolderNameBySubject

getExtraFeatureList

getCheckOutRecord

getTreeFolderIDList

IDhasExisted

getItemList

getApproveRequestList

getApproveRequestListByDocument

initGetFolder

initGetDocument

getCheckInMode

getCategoryList

getCategoryList

getSystemCategoryItemList

getCategoryItemList

getKeywordItemList

getCategoryItem

getDeletingRecordList

isHaveSubFolder

isHaveSubDocument

getNewDocumentReleased

getAFCompany

getDMSCompany

getComIDListOfMember

getComIdOfDep

getComIdOfRole

getAFMember

getAFRole

getAFDepartment

getAFMemberByLoginID

ogre.dms.service
Interface QueryService