|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DataBinder
A DataBinder is the Data Model Object used for Content Server communication. It encapsulates a set of local properties, a collection of result sets and option list values.
Method Summary | |
---|---|
void |
addFile(java.lang.String name, java.io.File file) Add a file for a given file name. |
void |
addFile(java.lang.String name, TransferFile file) Add a file for a given file name |
void |
addOptionList(java.lang.String name, java.util.List<java.lang.String> values) Add an option list with a given name |
void |
addResultSet(java.lang.String name, DataResultSet resultSet) Add a result set with a given name |
boolean |
containsFiles() Check if there are files |
java.lang.String |
getFieldType(java.lang.String name) Retrieve the field type for a given field name. |
java.util.Collection<java.lang.String> |
getFieldTypeNames() Retrieve all field names |
TransferFile |
getFile(java.lang.String name) Retrieve a file for a given file name |
java.util.Collection<java.lang.String> |
getFileNames() Retrieve all file names |
java.lang.String |
getLocal(java.lang.String name) Shortcut for getLocalData().get(name) |
DataObject |
getLocalData() Retrieve the local data |
java.util.List<java.lang.String> |
getOptionList(java.lang.String name) Retrieve a specific option list by name |
java.util.Collection<java.lang.String> |
getOptionListNames() Retrieve all option list names |
DataResultSet |
getResultSet(java.lang.String name) Retrieve the result set by name |
java.util.Collection<java.lang.String> |
getResultSetNames() Retrieve all result set names |
java.util.Map<java.lang.String,DataResultSet> |
getResultSets() Retrieve a map representation of the result sets, indexed by result set name. |
void |
merge(DataBinder source) This will merge copies of all the data from the source binder into this binder, overwriting existing values and result sets, if they exist. |
void |
putLocal(java.lang.String name, java.lang.String value) Shortcut for getLocalData().put(name,value) |
void |
removeFieldType(java.lang.String name) Remove the field type mapping for a given field name |
void |
removeFile(java.lang.String name) Remove a file for a given file name |
void |
removeOptionList(java.lang.String name) Remove an option list for a given name |
void |
removeResultSet(java.lang.String name) Remove the result set for a given name |
void |
setFieldType(java.lang.String name, java.lang.String type) Set a field type for a given field name |
Method Detail |
---|
DataObject getLocalData()
java.lang.String getFieldType(java.lang.String name)
name
- the field namevoid setFieldType(java.lang.String name, java.lang.String type)
name
- the field nametype
- the new typejava.util.Collection<java.lang.String> getFieldTypeNames()
void removeFieldType(java.lang.String name)
name
- the field name to remove from the mappings tablejava.util.Collection<java.lang.String> getFileNames()
TransferFile getFile(java.lang.String name)
name
- the file namevoid addFile(java.lang.String name, java.io.File file) throws java.io.IOException
addFile (name, new TransferStream (file));
name
- the file namefile
- the file objectjava.io.IOException
- if the file cannot be readaddFile(String, TransferFile)
void addFile(java.lang.String name, TransferFile file)
name
- the file namefile
- the file streamvoid removeFile(java.lang.String name)
name
- the file nameboolean containsFiles()
java.lang.String getLocal(java.lang.String name)
getLocalData().get(name)
name
- the local property namevoid putLocal(java.lang.String name, java.lang.String value)
getLocalData().put(name,value)
name
- the local property namevalue
- the local property valueDataResultSet getResultSet(java.lang.String name)
name
- the result set namejava.util.Map<java.lang.String,DataResultSet> getResultSets()
addResultSet(String, DataResultSet)
and removeResultSet(String)
methods.addResultSet(String, DataResultSet)
, removeResultSet(String)
, getResultSetNames()
java.util.Collection<java.lang.String> getResultSetNames()
void addResultSet(java.lang.String name, DataResultSet resultSet)
name
- the result set nameresultSet
- the result setvoid removeResultSet(java.lang.String name)
name
- the result set name to removejava.util.List<java.lang.String> getOptionList(java.lang.String name)
name
- the list namejava.util.Collection<java.lang.String> getOptionListNames()
void addOptionList(java.lang.String name, java.util.List<java.lang.String> values)
name
- the option list namevalues
- the valuesvoid removeOptionList(java.lang.String name)
name
- the option list namevoid merge(DataBinder source)
source
- the source databinder
|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |