ogre.dms.service
Interface AdminService

All Superinterfaces:

Remote

public interface AdminService
extends Remote

Version:

$Id: AdminService.java,v 1.2.2.10.2.17 2010/04/26 10:02:50 esso Exp $

Author:

Docpedia team.

Method Summary

String	addUnusualAutoAuditRule(UnusualAutoAuditRule item) add unusual-auto-audit-setting in UnusualAutoAuditRule table
void	clearIndexedPDocStatus() Clear the indexed data to reindex again.
String	createNewAMTRule()
boolean	createSift(Sift sift)
String	createVIDTemplate()
boolean	delBoard(String userID, String[] boardID)
boolean	deleteAMTRule(String AMTRuleID)
DMSResult	deleteAttributeType(String typeID, String parentID)
void	deleteDocument(String userID, String docKey) truly delete the target document from the system
void	deleteFolder(String userID, String fID) truly delete the target folder from the system
boolean	deletePasoPdfFile(String pasoID)
boolean	deleteSift(String key)
void	deleteUnusualAutoAuditRule(String entityID) delete UnusualAutoAuditRule table info
boolean	deleteUserIPMacAddress(String serialID) Delete user's ip/mac address setting.
Vector	deleteVIDTemplate(String[] vIDTemplateID)
BoardItem	editBoard(String userID, String boardID)
Vector	execApproveStatistics(ApproveFilter filter)
Vector	execApproveStatistics(String sql)
Vector	execApproveStatistics(String sql, Vector values)
Vector	execCombineSQL(FilterItem filter, int num, String operation, int rate)
Vector	execGeneralSQL(FilterItem filter)
Vector	execHitSQL(FilterItem filter, int num, String operation)
Vector	execReviewSQL(FilterItem filter, int rate)
Vector	execSQL(String sql)
boolean	generateCountNumber(String docKey, String operation)
Vector	getAdmMangementTools()
List	getAfdlOpLogs(String myK) Not comments.
List	getAfdlRecordByCondition(Map searchCondition)
Vector	getAllAuthorID()
List	getAllIndexablePDoc() Retrieve all PhysicalDocumentItem that can be indexed.
Vector	getAMTListByRuleID(String ruleID)
Vector	getAMTRule()
Vector	getAMTRuleByID(String ruleID)
Vector	getAMTRuleByUser(String memID)
Vector	getAMTUserByID(String ruleID)
HashMap	getAMTUserMap(String memID)
Vector	getAttributeDocumentList(String attID)
AttributeType	getAttributeType(String typeID)
Vector	getAuthorityRecordItem(String authorityId)
Vector	getAuthorityRecordItemByDocKey(String docKey)
Vector	getAuthorityRecordItemByDocKey(String[] docKey)
Vector	getBoard()
Vector	getCoSignMemberbyDept(String[] dept)
Vector	getCoSignMemberbyTimeRange(String[] dept, String startTime, String endTime)
String	getISODocVersion()
String	getMappingVID(String vIDTemplateID, String versionID)
String	getMappingVID(VirtualDocument vd, String versionID)
DMSUser	getOnLineUser(String loginId)
Map	getOnLineUsers()
String	getParentVerDocKey(String currentKey)
List	getPasoPdfInfo(String userID) Retrieve the paso-pdf-info list.
PasoPdfInfo	getPasoPdfInfoByID(String pasoID)
String	getSerilIDPointCount(String typeID) Retrieve the current serial id of document type (AttributeType).
Vector	getSift(String userId, String siftType)
List	getUnusualAutoAuditRuleList() Retrieve the list of unusual-auto-auditing rule.
UnusualAutoAuditRule	getUnusualAutoAuditRuleList(String entityID) Retrieve the unusual-auto-audit-rule-setting list.
UserIPMacAddress	getUserIPAddress(String ip) Retrieve user's ip address setting by given ip.
UserIPMacAddress	getUserIPMacAddressByDataValue(String macOrIP) Get user's ip/mac address information according to the given value
List	getUserIPMacAddressByMemID(String memID) Retrieve user's ip/mac address settings.
UserIPMacAddress	getUserIPMacAddressBySerialID(String serialID) Retrieve user's ip/mac address setting by given serial id.
List	getUserIPMacList() Retrieve all users' ip/mac address settings.
UserIPMacAddress	getUserMacAddress(String mac) Retrieve user's mac address setting by given mac id.
HashMap	getVIDTemplate(String vIDTemplateID)
Vector	getVIDTemplateList()
DMSResult	initRemoveFolder(String userID, String targetFolderID, boolean force)
boolean	insertAuthorityRecord(HashMap map)
boolean	isAlive()
boolean	isAMTUser(String memberID, String amtID) Check the user is authorized Aministrator Management Tool (AMT) user or not.
boolean	isAttrTypeDeletable(String typeID)
AttributeType	newAttributeType(HashMap hmap)
boolean	newBoard(String userID, HashMap info)
DMSResult	recoverDocument(String userID, String targetDocumentKey) recover the deleted document to its original parent folder
void	recoverDocument(String userID, String targetDocumentKey, String parentFolderID) recover the deleted document to specified parent folder
DMSResult	recoverFolder(String userID, String targetFolderID) Deprecated. Use FolderManagementService.restoreFolder(String, String) instead.
void	recoverFolder(String userID, String targetFolderID, String parentFolderID) Deprecated. Use ogre.dms.service.FolderManagementService#restoreFolder(String, String, String) instead.
void	registerOnLineUser(DMSUser user) Deprecated. V2.2 use AccessControlService.registerOnLineUser(DMSUser, InetAddress) instead
DMSResult	removeDocument(String userID, String targetDocumentID)
DMSResult	removeDocument(String userID, String[] docKey)
DMSResult	removeFolder(String userID, String targetFolderID, boolean force)
void	resetSerialNumber(String typeID) Reset the serial id to zero.
void	saveAfdlOpLogs(AfdlOpLogs opLogs) No comments.
DMSResult	saveUserIPMacAddress(UserIPMacAddress ipmac) Add/Update user's ip/mac address setting.
void	setVIDTemplate(String vIDTemplateID, HashMap mapping)
boolean	shutdownServer(String userID, String password)
boolean	transformAttribute(String oldType, String newType)
void	unregisterOnLineUser(String loginId) Deprecated. V2.2 use AccessControlService.unregisterOnLineUser(String) instead
boolean	updateAMTListByRule(String ruleID, Vector list)
boolean	updateAMTRule(AMTRuleItem amtRuleItem)
DMSResult	updateAttributeType(AttributeType attrType)
DMSResult	updateAttributeType(HashMap map) Deprecated. V2.2. Use updateAttributeType(AttributeType) instead.
boolean	updateBoard(String userID, String boardID, HashMap info)
void	updateMappingVID(String templateID)
boolean	updateSift(Sift sift)
void	updateUnusualAutoAuditRule(UnusualAutoAuditRule item) update UnusualAutoAuditRule table info
boolean	updateUserIPMacAddress(UserIPMacAddress ipmac) Update user's ip/mac address setting.
boolean	vIDTempalateIsUsed(String templateID)

Method Detail

deleteDocument

void deleteDocument(String userID,
                    String docKey)
                    throws RemoteException

truly delete the target document from the system

Throws:

RemoteException

deleteFolder

void deleteFolder(String userID,
                  String fID)
                  throws RemoteException

truly delete the target folder from the system

Throws:

RemoteException

recoverFolder

DMSResult recoverFolder(String userID,
                        String targetFolderID)
                        throws RemoteException

Deprecated. Use FolderManagementService.restoreFolder(String, String) instead.

recover the deleted folder to its original parent folder

Returns:

if the original folder is deleted, the activity would not be commited

Throws:

RemoteException

recoverFolder

void recoverFolder(String userID,
                   String targetFolderID,
                   String parentFolderID)
                   throws RemoteException

Deprecated. Use ogre.dms.service.FolderManagementService#restoreFolder(String, String, String) instead.

recover the deleted folder to specified parent folder

Throws:

RemoteException

recoverDocument

DMSResult recoverDocument(String userID,
                          String targetDocumentKey)
                          throws RemoteException

recover the deleted document to its original parent folder

Returns:

if the original folder is deleted, the activity would not be commited

Throws:

RemoteException

recoverDocument

void recoverDocument(String userID,
                     String targetDocumentKey,
                     String parentFolderID)
                     throws RemoteException

recover the deleted document to specified parent folder

Throws:

RemoteException

isAlive

boolean isAlive()
                throws RemoteException

Throws:

RemoteException

initRemoveFolder

DMSResult initRemoveFolder(String userID,
                           String targetFolderID,
                           boolean force)
                           throws RemoteException

Throws:

RemoteException

removeFolder

DMSResult removeFolder(String userID,
                       String targetFolderID,
                       boolean force)
                       throws RemoteException

Throws:

RemoteException

removeDocument

DMSResult removeDocument(String userID,
                         String targetDocumentID)
                         throws RemoteException

Throws:

RemoteException

removeDocument

DMSResult removeDocument(String userID,
                         String[] docKey)
                         throws RemoteException

Throws:

RemoteException

getBoard

Vector getBoard()
                throws RemoteException

Throws:

RemoteException

newBoard

boolean newBoard(String userID,
                 HashMap info)
                 throws RemoteException

Throws:

RemoteException

updateBoard

boolean updateBoard(String userID,
                    String boardID,
                    HashMap info)
                    throws RemoteException

Throws:

RemoteException

editBoard

BoardItem editBoard(String userID,
                    String boardID)
                    throws RemoteException

Throws:

RemoteException

delBoard

boolean delBoard(String userID,
                 String[] boardID)
                 throws RemoteException

Throws:

RemoteException

getAttributeType

AttributeType getAttributeType(String typeID)
                               throws RemoteException

Throws:

RemoteException

newAttributeType

AttributeType newAttributeType(HashMap hmap)
                               throws RemoteException

Throws:

RemoteException

deleteAttributeType

DMSResult deleteAttributeType(String typeID,
                              String parentID)
                              throws RemoteException

Throws:

RemoteException

updateAttributeType

DMSResult updateAttributeType(AttributeType attrType)
                              throws RemoteException

Throws:

RemoteException

updateAttributeType

DMSResult updateAttributeType(HashMap map)
                              throws RemoteException

Deprecated. V2.2. Use updateAttributeType(AttributeType) instead.

Parameters:

map -

Returns:

DMSResult

Throws:

RemoteException

isAttrTypeDeletable

boolean isAttrTypeDeletable(String typeID)
                            throws RemoteException

Throws:

RemoteException

resetSerialNumber

void resetSerialNumber(String typeID)
                       throws RemoteException

Reset the serial id to zero.

Parameters:

typeID -

Throws:

RemoteException

Since:

V3.0

getSerilIDPointCount

String getSerilIDPointCount(String typeID)
                            throws RemoteException

Retrieve the current serial id of document type (AttributeType).

Parameters:

typeID -

Throws:

RemoteException

Since:

V3.0

getParentVerDocKey

String getParentVerDocKey(String currentKey)
                          throws RemoteException

Throws:

RemoteException

getAuthorityRecordItemByDocKey

Vector getAuthorityRecordItemByDocKey(String[] docKey)
                                      throws RemoteException

Throws:

RemoteException

getAuthorityRecordItemByDocKey

Vector getAuthorityRecordItemByDocKey(String docKey)
                                      throws RemoteException

Throws:

RemoteException

getAuthorityRecordItem

Vector getAuthorityRecordItem(String authorityId)
                              throws RemoteException

Throws:

RemoteException

insertAuthorityRecord

boolean insertAuthorityRecord(HashMap map)
                              throws RemoteException

Throws:

RemoteException

getAttributeDocumentList

Vector getAttributeDocumentList(String attID)
                                throws RemoteException

Throws:

RemoteException

generateCountNumber

boolean generateCountNumber(String docKey,
                            String operation)
                            throws RemoteException

Throws:

RemoteException

execGeneralSQL

Vector execGeneralSQL(FilterItem filter)
                      throws RemoteException

Throws:

RemoteException

execHitSQL

Vector execHitSQL(FilterItem filter,
                  int num,
                  String operation)
                  throws RemoteException

Throws:

RemoteException

execReviewSQL

Vector execReviewSQL(FilterItem filter,
                     int rate)
                     throws RemoteException

Throws:

RemoteException

execCombineSQL

Vector execCombineSQL(FilterItem filter,
                      int num,
                      String operation,
                      int rate)
                      throws RemoteException

Throws:

RemoteException

getCoSignMemberbyDept

Vector getCoSignMemberbyDept(String[] dept)
                             throws RemoteException

Throws:

RemoteException

getCoSignMemberbyTimeRange

Vector getCoSignMemberbyTimeRange(String[] dept,
                                  String startTime,
                                  String endTime)
                                  throws RemoteException

Throws:

RemoteException

execApproveStatistics

Vector execApproveStatistics(String sql)
                             throws RemoteException

Throws:

RemoteException

execApproveStatistics

Vector execApproveStatistics(ApproveFilter filter)
                             throws RemoteException

Throws:

RemoteException

execApproveStatistics

Vector execApproveStatistics(String sql,
                             Vector values)
                             throws RemoteException

Throws:

RemoteException

createSift

boolean createSift(Sift sift)
                   throws RemoteException

Throws:

RemoteException

updateSift

boolean updateSift(Sift sift)
                   throws RemoteException

Throws:

RemoteException

deleteSift

boolean deleteSift(String key)
                   throws RemoteException

Throws:

RemoteException

getSift

Vector getSift(String userId,
               String siftType)
               throws RemoteException

Throws:

RemoteException

getISODocVersion

String getISODocVersion()
                        throws RemoteException

Throws:

RemoteException

getAMTRuleByUser

Vector getAMTRuleByUser(String memID)
                        throws RemoteException

Throws:

RemoteException

getAMTUserMap

HashMap getAMTUserMap(String memID)
                      throws RemoteException

Throws:

RemoteException

getAdmMangementTools

Vector getAdmMangementTools()
                            throws RemoteException

Throws:

RemoteException

getAMTRule

Vector getAMTRule()
                  throws RemoteException

Throws:

RemoteException

getAMTRuleByID

Vector getAMTRuleByID(String ruleID)
                      throws RemoteException

Throws:

RemoteException

getAMTUserByID

Vector getAMTUserByID(String ruleID)
                      throws RemoteException

Throws:

RemoteException

createNewAMTRule

String createNewAMTRule()
                        throws RemoteException

Throws:

RemoteException

updateAMTRule

boolean updateAMTRule(AMTRuleItem amtRuleItem)
                      throws RemoteException

Throws:

RemoteException

deleteAMTRule

boolean deleteAMTRule(String AMTRuleID)
                      throws RemoteException

Throws:

RemoteException

getAMTListByRuleID

Vector getAMTListByRuleID(String ruleID)
                          throws RemoteException

Throws:

RemoteException

updateAMTListByRule

boolean updateAMTListByRule(String ruleID,
                            Vector list)
                            throws RemoteException

Throws:

RemoteException

isAMTUser

boolean isAMTUser(String memberID,
                  String amtID)
                  throws RemoteException

Check the user is authorized Aministrator Management Tool (AMT) user or not.

Parameters:

memberID -

amtID -

Returns:

is ok or not

Throws:

RemoteException

execSQL

Vector execSQL(String sql)
               throws RemoteException

Throws:

RemoteException

getAllAuthorID

Vector getAllAuthorID()
                      throws RemoteException

Throws:

RemoteException

shutdownServer

boolean shutdownServer(String userID,
                       String password)
                       throws RemoteException

Throws:

RemoteException

transformAttribute

boolean transformAttribute(String oldType,
                           String newType)
                           throws RemoteException

Throws:

RemoteException

registerOnLineUser

void registerOnLineUser(DMSUser user)
                        throws RemoteException

Deprecated. V2.2 use AccessControlService.registerOnLineUser(DMSUser, InetAddress) instead

Store online user information.

Throws:

RemoteException

unregisterOnLineUser

void unregisterOnLineUser(String loginId)
                          throws RemoteException

Deprecated. V2.2 use AccessControlService.unregisterOnLineUser(String) instead

remove user from online storage.

Throws:

RemoteException

getOnLineUsers

Map getOnLineUsers()
                   throws RemoteException

Throws:

RemoteException

getOnLineUser

DMSUser getOnLineUser(String loginId)
                      throws RemoteException

Throws:

RemoteException

getVIDTemplate

HashMap getVIDTemplate(String vIDTemplateID)
                       throws RemoteException

Throws:

RemoteException

setVIDTemplate

void setVIDTemplate(String vIDTemplateID,
                    HashMap mapping)
                    throws RemoteException

Throws:

RemoteException

getMappingVID

String getMappingVID(String vIDTemplateID,
                     String versionID)
                     throws RemoteException

Throws:

RemoteException

getVIDTemplateList

Vector getVIDTemplateList()
                          throws RemoteException

Throws:

RemoteException

deleteVIDTemplate

Vector deleteVIDTemplate(String[] vIDTemplateID)
                         throws RemoteException

Throws:

RemoteException

createVIDTemplate

String createVIDTemplate()
                         throws RemoteException

Throws:

RemoteException

vIDTempalateIsUsed

boolean vIDTempalateIsUsed(String templateID)
                           throws RemoteException

Throws:

RemoteException

updateMappingVID

void updateMappingVID(String templateID)
                      throws RemoteException

Throws:

RemoteException

getMappingVID

String getMappingVID(VirtualDocument vd,
                     String versionID)
                     throws RemoteException

Throws:

RemoteException

getUserIPMacList

List getUserIPMacList()
                      throws RemoteException

Retrieve all users' ip/mac address settings.

Returns:

List each element is UserIPMacAddress

Throws:

RemoteException

Since:

V2.1

getUserIPMacAddressByMemID

List getUserIPMacAddressByMemID(String memID)
                                throws RemoteException

Retrieve user's ip/mac address settings.

Returns:

List each element is UserIPMacAddress

Throws:

RemoteException

Since:

V2.1

getUserMacAddress

UserIPMacAddress getUserMacAddress(String mac)
                                   throws RemoteException

Retrieve user's mac address setting by given mac id.

Parameters:

mac -

Returns:

UserIPMacAddress or null

Throws:

RemoteException

Since:

V2.1

getUserIPAddress

UserIPMacAddress getUserIPAddress(String ip)
                                  throws RemoteException

Retrieve user's ip address setting by given ip.

Parameters:

ip -

Returns:

UserIPMacAddress or null

Throws:

RemoteException

Since:

V2.1

getUserIPMacAddressBySerialID

UserIPMacAddress getUserIPMacAddressBySerialID(String serialID)
                                               throws RemoteException

Retrieve user's ip/mac address setting by given serial id.

Parameters:

serialID -

Returns:

UserIPMacAddress or null

Throws:

RemoteException

Since:

V2.1

saveUserIPMacAddress

DMSResult saveUserIPMacAddress(UserIPMacAddress ipmac)
                               throws RemoteException

Add/Update user's ip/mac address setting.

Parameters:

ipmac - setting

Returns:

DMSResult if DMSResult.getMessage(DMSResult.ERROR) returns nothing, it is ok; else you can use DMSResult.getRetValue(DMSResult.ERROR) to know what the error is.

Throws:

RemoteException

Since:

V2.1

updateUserIPMacAddress

boolean updateUserIPMacAddress(UserIPMacAddress ipmac)
                               throws RemoteException

Update user's ip/mac address setting.

Parameters:

ipmac - setting

Returns:

true/false

Throws:

RemoteException

Since:

V2.1

deleteUserIPMacAddress

boolean deleteUserIPMacAddress(String serialID)
                               throws RemoteException

Delete user's ip/mac address setting.

Parameters:

serialID -

Returns:

true/false

Throws:

RemoteException

Since:

V2.1

getUserIPMacAddressByDataValue

UserIPMacAddress getUserIPMacAddressByDataValue(String macOrIP)
                                                throws RemoteException

Get user's ip/mac address information according to the given value

Parameters:

macOrIP -

Returns:

UserIPMacAddress or null

Throws:

RemoteException

Since:

V2.1

saveAfdlOpLogs

void saveAfdlOpLogs(AfdlOpLogs opLogs)
                    throws RemoteException

No comments.

Parameters:

opLogs -

Throws:

RemoteException

Since:

V2.1

getAfdlOpLogs

List getAfdlOpLogs(String myK)
                   throws RemoteException

Not comments.

Parameters:

myK -

Returns:

Throws:

RemoteException

Since:

V2.1

getAfdlRecordByCondition

List getAfdlRecordByCondition(Map searchCondition)
                              throws RemoteException

Parameters:

-

Returns:

Throws:

RemoteException

Since:

V2.1

getAllIndexablePDoc

List getAllIndexablePDoc()
                         throws RemoteException

Retrieve all PhysicalDocumentItem that can be indexed.

Returns:

List each element is PhysicalDocumentItem

Throws:

RemoteException

Since:

V2.1

clearIndexedPDocStatus

void clearIndexedPDocStatus()
                            throws RemoteException

Clear the indexed data to reindex again.

Throws:

RemoteException

Since:

V2.2 HotFix_79

getUnusualAutoAuditRuleList

UnusualAutoAuditRule getUnusualAutoAuditRuleList(String entityID)
                                                 throws RemoteException

Retrieve the unusual-auto-audit-rule-setting list.

Parameters:

entityID -

Returns:

UnusualAutoAuditRule

Throws:

RemoteException

Since:

V3.0

getUnusualAutoAuditRuleList

List getUnusualAutoAuditRuleList()
                                 throws RemoteException

Retrieve the list of unusual-auto-auditing rule.

Returns:

List each element is UnusualAutoAuditRule

Throws:

RemoteException

Since:

V3.0

addUnusualAutoAuditRule

String addUnusualAutoAuditRule(UnusualAutoAuditRule item)
                               throws RemoteException

add unusual-auto-audit-setting in UnusualAutoAuditRule table

Parameters:

item - UnusualAutoAuditRule

Returns:

entityID when new a table

Throws:

RemoteException

Since:

V3.0

updateUnusualAutoAuditRule

void updateUnusualAutoAuditRule(UnusualAutoAuditRule item)
                                throws RemoteException

update UnusualAutoAuditRule table info

Parameters:

item - UnusualAutoAuditRule

Throws:

RemoteException

Since:

V3.0

deleteUnusualAutoAuditRule

void deleteUnusualAutoAuditRule(String entityID)
                                throws RemoteException

delete UnusualAutoAuditRule table info

Parameters:

entityID -

Throws:

RemoteException

Since:

V3.0

getPasoPdfInfo

List getPasoPdfInfo(String userID)
                    throws RemoteException

Retrieve the paso-pdf-info list.

Returns:

List each element is PasoPdfInfo

Throws:

RemoteException

Since:

V3.0

getPasoPdfInfoByID

PasoPdfInfo getPasoPdfInfoByID(String pasoID)
                               throws RemoteException

Throws:

RemoteException

deletePasoPdfFile

boolean deletePasoPdfFile(String pasoID)
                          throws RemoteException

Throws:

RemoteException