Package com.emc.d2fs.interfaces
Interface IDictionaryService
- All Superinterfaces:
ID2fsService
Dictionary management services.
-
Method Summary
Modifier and TypeMethodDescriptionexportDictionary
(Context context, String dictionaryName, String format, String separator) Export dictionary -- Use getExportDictionaryUrl() when using SOAP.getDictionaryNumberValue
(Context context, String objectId) Get dictionary number valuegetExportDictionaryUrl
(Context context, String dictionaryName, String format, String separator) Get export dictionary urlgetImportDictionaryUrl
(Context context, String dictionaryName, String separator, boolean overwrite) Get import dictionary urlvoid
importDictionary
(Context context, String dictionaryName, String format, String separator, DataHandler file) Import dictionary into docbase -- Use getImportDictionaryUrl() when using SOAP.importVersionDictionary
(Context context, String objectId, List<Attribute> attributes) Import dictionary versionperformOperations
(Context context, String dictionaryName, List<DictionaryOperation> operations) Perform dictionary operations on specified elementrequestDocbaseUpdate
(Context context, String objectId, List<Attribute> attributes) Request docbase updatesaveVersionDictionary
(Context context, String objectId, List<Attribute> attributes) Save dictionary versionvoid
setBaseUrl
(String url) Set server base url used to build the url forgetExportDictionaryUrl
orgetImportDictionaryUrl
Methods inherited from interface com.emc.d2fs.interfaces.ID2fsService
isRemote, setRemote
-
Method Details
-
performOperations
List<DictionaryOperationResult> performOperations(Context context, String dictionaryName, List<DictionaryOperation> operations) throws D2fsException Perform dictionary operations on specified element- Parameters:
context
-Context
object containing informations about client/sessiondictionaryName
- String value of dictionary nameoperations
-DictionaryOperation
list of operations- Returns:
DictionaryOperationResult
list of result- Throws:
D2fsException
- Since:
- 4.0.1
-
importDictionary
void importDictionary(Context context, String dictionaryName, String format, String separator, DataHandler file) throws D2fsException Import dictionary into docbase -- Use getImportDictionaryUrl() when using SOAP.- Parameters:
context
-Context
object containing informations about client/sessiondictionaryName
- String value of dictionary nameformat
- String value of dictionary formatseparator
- String value of data separator valuefile
-DataHandler
object of file data- Throws:
D2fsException
- Since:
- 4.0.1
-
exportDictionary
DataHandler exportDictionary(Context context, String dictionaryName, String format, String separator) throws D2fsException Export dictionary -- Use getExportDictionaryUrl() when using SOAP.- Parameters:
context
-Context
object containing informations about client/sessiondictionaryName
- String value of dictionary nameformat
- String value of dictionary formatseparator
- String value of data separator value- Returns:
DataHandler
object of file data- Throws:
D2fsException
- Since:
- 4.0.1
-
setBaseUrl
Set server base url used to build the url forgetExportDictionaryUrl
orgetImportDictionaryUrl
- Parameters:
url
- String value of base url- Since:
- 4.1.0
-
getExportDictionaryUrl
String getExportDictionaryUrl(Context context, String dictionaryName, String format, String separator) throws Exception Get export dictionary url- Parameters:
context
-Context
object containing informations about client/sessiondictionaryName
- String Name of the dictionary to exportformat
- String value of dictionary formatseparator
- String value of data separator value- Returns:
- String value of export url
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-
getImportDictionaryUrl
String getImportDictionaryUrl(Context context, String dictionaryName, String separator, boolean overwrite) throws Exception Get import dictionary url- Parameters:
context
-Context
object containing informations about client/sessiondictionaryName
- String Name of the dictionary to importseparator
- String value of data separator valueoverwrite
- boolean value for overwrite option, append if false- Returns:
- String value of import url
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-
getDictionaryNumberValue
Get dictionary number value- Parameters:
context
-Context
object containing informations about client/sessionobjectId
- String value of dictionary name- Returns:
- String value of object name and value count
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-
saveVersionDictionary
String saveVersionDictionary(Context context, String objectId, List<Attribute> attributes) throws Exception Save dictionary version- Parameters:
context
-Context
object containing informations about client/sessionobjectId
- String value of dictionary nameattributes
- List ofAttribute
as params- Returns:
- String value of xmlContent as result
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-
importVersionDictionary
String importVersionDictionary(Context context, String objectId, List<Attribute> attributes) throws Exception Import dictionary version- Parameters:
context
-Context
object containing informations about client/sessionobjectId
- String value of dictionary nameattributes
- List ofAttribute
as params- Returns:
- String value of xmlContent as result
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-
requestDocbaseUpdate
String requestDocbaseUpdate(Context context, String objectId, List<Attribute> attributes) throws Exception Request docbase update- Parameters:
context
-Context
object containing informations about client/sessionobjectId
- String value of dictionary nameattributes
- List ofAttribute
as params- Returns:
- String value of xmlContent as result
- Throws:
D2fsException
Exception
- Since:
- 4.1.0
-