ogre.dms.service
Interface SystemService

All Superinterfaces:

Remote

public interface SystemService
extends Remote

SystemService is an interface which provides seriveces for setup some system parameters.

Version:

$Id: SystemService.java,v 1.1.1.1.2.2.2.19 2010/04/26 10:02:51 esso Exp $

Author:

Hwai-jung Hsu, e-mail:hjhsu@csie.nctu.edu.tw, Ogre Team

Method Summary

void	addCategory(String userID, CategoryItem item)
void	addVDKeywordItem(VDKeywordItem[] items)
Keyword	createKeyword(String ckey, String name)
KeywordCategory	createKeywordCategory(String pkey, String name)
void	deleteCategory(String userID, String catKey)
void	deleteKeyword(String[] kKey)
void	deleteKeyword(String userID, String kwKey)
void	deleteKeywordCategory(String[] cKey)
void	delVDKeywordItem(String[] kKey)
void	delVDKeywordItem(String[] kKey, String docKey)
boolean	displayDocIsDownloaded()
void	dumpCacheInfo() Dump server cache information.
String	getDefinedColumnOfDocumentList() Retrieve the defined columns that will be displayed while document listing.
List	getDistributionSiteInfo() Retrieve the distribution storage sites.
String	getEnableSearch()
DMSSystemEnvironment	getEnvironment() Get the system environment configuration object.
DMSFile	getLocalFile(String path)
int	getMaxMultiSelect() Retrieve the 'maxMutliSelect' number of document(s) to 'Add multiple files'
String	getNoticeBoardIndex()
String	getPrintDocFooter()
String	getPrintDocHeader()
Vector	getPrintDocTab()
String	getProductVerType() Retrieve the version type of the Docpedia License.
SystemInfo	getSystemInfo() Retrieve the system information.
SystemInfo	getSystemInfoWithDiskInfo() Retrieve the system information with disk usage infomation.
boolean	isAlive()
boolean	isAutoVueModuleEnable() Enable AutoVue Module.
boolean	isBoardListEnabled() Flag to display the Bulletin Board in MyDcc page.
boolean	isColumnToDisplayShortcutCreateddateInDocShare()
boolean	isDistStorageModuleEnable() Enable Distribution Storage Module.
boolean	isEnableMobileDevice() Authorize users to access Document Management System through mobile device.
boolean	isExtReaderACL() isExtReaderACL is enabled or not.
boolean	isFullTextSearchModuleEnable() Enable Full Text Searching Module.
boolean	isLimitDCCtoOwnedDocumentType()
boolean	isLogoutLinkEnable()
boolean	isMobileDownloadModuleEnable() Enable Mobile Device Module.
boolean	isPasoPdfConversionModuleEnable() Enable Paso PDF Conversion Module.
boolean	isPdfConversionModuleEnable() Enable PDF Conversion Module.
boolean	isPdfSecurityDownloadModuleEnabled() PDF SecuVue Solution Module Purchased.
boolean	isTrustviewModuleEnable() Enable Trustview Module.
void	setCategoryOrder(String CategoryName, int setKeyValue)
void	setKeywordOrder(String KeywordName, int setKeyValue)
void	sortKeyword(String[] kKey)
void	sortKeyword(String key, int order)
void	sortKeyword(String key, int order, String keyName)
void	sortKeywordCategory(String[] cKey)
void	sortKeywordCategory(String key, int order)
void	updateCategory(String userID, String catKey, CategoryItem item)
void	updateKeywordCategory(String key, Vector cols, Vector values)
void	updateKeywordDisabled(String[] keys, String disabled)

Method Detail

setKeywordOrder

void setKeywordOrder(String KeywordName,
                     int setKeyValue)
                     throws RemoteException

Throws:

RemoteException

setCategoryOrder

void setCategoryOrder(String CategoryName,
                      int setKeyValue)
                      throws RemoteException

Throws:

RemoteException

addCategory

void addCategory(String userID,
                 CategoryItem item)
                 throws RemoteException

Throws:

RemoteException

updateCategory

void updateCategory(String userID,
                    String catKey,
                    CategoryItem item)
                    throws RemoteException

Throws:

RemoteException

deleteCategory

void deleteCategory(String userID,
                    String catKey)
                    throws RemoteException

Throws:

RemoteException

deleteKeyword

void deleteKeyword(String userID,
                   String kwKey)
                   throws RemoteException

Throws:

RemoteException

getLocalFile

DMSFile getLocalFile(String path)
                     throws RemoteException

Throws:

RemoteException

getNoticeBoardIndex

String getNoticeBoardIndex()
                           throws RemoteException

Throws:

RemoteException

getEnableSearch

String getEnableSearch()
                       throws RemoteException

Throws:

RemoteException

createKeyword

Keyword createKeyword(String ckey,
                      String name)
                      throws RemoteException

Throws:

RemoteException

createKeywordCategory

KeywordCategory createKeywordCategory(String pkey,
                                      String name)
                                      throws RemoteException

Throws:

RemoteException

deleteKeyword

void deleteKeyword(String[] kKey)
                   throws RemoteException

Throws:

RemoteException

deleteKeywordCategory

void deleteKeywordCategory(String[] cKey)
                           throws RemoteException

Throws:

RemoteException

sortKeyword

void sortKeyword(String[] kKey)
                 throws RemoteException

Throws:

RemoteException

sortKeyword

void sortKeyword(String key,
                 int order)
                 throws RemoteException

Throws:

RemoteException

sortKeyword

void sortKeyword(String key,
                 int order,
                 String keyName)
                 throws RemoteException

Throws:

RemoteException

updateKeywordDisabled

void updateKeywordDisabled(String[] keys,
                           String disabled)
                           throws RemoteException

Throws:

RemoteException

sortKeywordCategory

void sortKeywordCategory(String[] cKey)
                         throws RemoteException

Throws:

RemoteException

sortKeywordCategory

void sortKeywordCategory(String key,
                         int order)
                         throws RemoteException

Throws:

RemoteException

updateKeywordCategory

void updateKeywordCategory(String key,
                           Vector cols,
                           Vector values)
                           throws RemoteException

Throws:

RemoteException

addVDKeywordItem

void addVDKeywordItem(VDKeywordItem[] items)
                      throws RemoteException

Throws:

RemoteException

delVDKeywordItem

void delVDKeywordItem(String[] kKey)
                      throws RemoteException

Throws:

RemoteException

delVDKeywordItem

void delVDKeywordItem(String[] kKey,
                      String docKey)
                      throws RemoteException

Throws:

RemoteException

isAlive

boolean isAlive()
                throws RemoteException

Throws:

RemoteException

getEnvironment

DMSSystemEnvironment getEnvironment()
                                    throws RemoteException

Get the system environment configuration object.

Returns:

DMSSystemEnvironment

Throws:

RemoteException

getSystemInfo

SystemInfo getSystemInfo()
                         throws RemoteException

Retrieve the system information.

Returns:

SystemInfo

Throws:

RemoteException

Since:

V2.2 HotFix_67

getSystemInfoWithDiskInfo

SystemInfo getSystemInfoWithDiskInfo()
                                     throws RemoteException

Retrieve the system information with disk usage infomation. Retrieving disk usage information depends on IO response time, it may take times.

Returns:

SystemInfo

Throws:

RemoteException

Since:

V3.0

See Also:

getSystemInfo()

dumpCacheInfo

void dumpCacheInfo()
                   throws RemoteException

Dump server cache information.

Throws:

RemoteException

displayDocIsDownloaded

boolean displayDocIsDownloaded()
                               throws RemoteException

Throws:

RemoteException

Since:

V2.1

isPdfSecurityDownloadModuleEnabled

boolean isPdfSecurityDownloadModuleEnabled()
                                           throws RemoteException

PDF SecuVue Solution Module Purchased.

Returns:

true/false

Throws:

RemoteException

Since:

V2.1

isTrustviewModuleEnable

boolean isTrustviewModuleEnable()
                                throws RemoteException

Enable Trustview Module.

Returns:

Throws:

RemoteException

Since:

V2.1

isAutoVueModuleEnable

boolean isAutoVueModuleEnable()
                              throws RemoteException

Enable AutoVue Module.

Returns:

Throws:

RemoteException

Since:

V2.1

isFullTextSearchModuleEnable

boolean isFullTextSearchModuleEnable()
                                     throws RemoteException

Enable Full Text Searching Module.

Returns:

Throws:

RemoteException

Since:

V2.1

isPdfConversionModuleEnable

boolean isPdfConversionModuleEnable()
                                    throws RemoteException

Enable PDF Conversion Module.

Returns:

Throws:

RemoteException

Since:

V2.1

isPasoPdfConversionModuleEnable

boolean isPasoPdfConversionModuleEnable()
                                        throws RemoteException

Enable Paso PDF Conversion Module.

Returns:

Throws:

RemoteException

Since:

V3.0

isEnableMobileDevice

boolean isEnableMobileDevice()
                             throws RemoteException

Authorize users to access Document Management System through mobile device. isMobileDownloadModuleEnable()

Returns:

Throws:

RemoteException

Since:

V2.1

isMobileDownloadModuleEnable

boolean isMobileDownloadModuleEnable()
                                     throws RemoteException

Enable Mobile Device Module. isEnableMobileDevice()

Returns:

Throws:

RemoteException

Since:

V2.1

isDistStorageModuleEnable

boolean isDistStorageModuleEnable()
                                  throws RemoteException

Enable Distribution Storage Module.

Returns:

true/false

Throws:

RemoteException

Since:

V2.2

getDistributionSiteInfo

List getDistributionSiteInfo()
                             throws RemoteException

Retrieve the distribution storage sites.

Returns:

List each element is DistSiteInfo

Throws:

RemoteException

Since:

V2.2

getPrintDocHeader

String getPrintDocHeader()
                         throws RemoteException

Throws:

RemoteException

getPrintDocFooter

String getPrintDocFooter()
                         throws RemoteException

Throws:

RemoteException

getPrintDocTab

Vector getPrintDocTab()
                      throws RemoteException

Throws:

RemoteException

isLogoutLinkEnable

boolean isLogoutLinkEnable()
                           throws RemoteException

Throws:

RemoteException

getProductVerType

String getProductVerType()
                         throws RemoteException

Retrieve the version type of the Docpedia License.

Returns:

versionType

Throws:

RemoteException

Since:

V3.0

getDefinedColumnOfDocumentList

String getDefinedColumnOfDocumentList()
                                      throws RemoteException

Retrieve the defined columns that will be displayed while document listing.

Returns:

defined columns

Throws:

RemoteException

Since:

V3.0

getMaxMultiSelect

int getMaxMultiSelect()
                      throws RemoteException

Retrieve the 'maxMutliSelect' number of document(s) to 'Add multiple files'

Throws:

RemoteException

Since:

V3.0

isBoardListEnabled

boolean isBoardListEnabled()
                           throws RemoteException

Flag to display the Bulletin Board in MyDcc page.

Returns:

true/false

Throws:

RemoteException

Since:

V3.0

isLimitDCCtoOwnedDocumentType

boolean isLimitDCCtoOwnedDocumentType()
                                      throws RemoteException

Returns:

true/false

Throws:

RemoteException

Since:

V3.0

isColumnToDisplayShortcutCreateddateInDocShare

boolean isColumnToDisplayShortcutCreateddateInDocShare()
                                                       throws RemoteException

Throws:

RemoteException

Since:

V3.0 HotFix_21

isExtReaderACL

boolean isExtReaderACL()
                       throws RemoteException

isExtReaderACL is enabled or not. Default value is false

Returns:

boolean

Throws:

RemoteException

Since:

V3.0 HotFix_21