DMSTableHandler ( @enterprise 10.0 API)

All Known Implementing Classes:

DMSTableAdapter
```
public interface DMSTableHandler
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTACH_NOTE` key for the action 'Attach Note'
`static String`	`CHANGE_TYPE` key for the action 'Change type'
`static String`	`CHANGED_AT` key for the column holding the date of the last change of the DMSObject
`static String`	`CLIPBOARD` key for the action 'Clipboard'
`static String`	`COPY` key for the action 'Copy'
`static String`	`CREATE_VERSION` key for the action 'Create Version'
`static String`	`CUT` key for the action 'Cut'
`static String`	`DELETE` key for the action 'Delete'
`static String`	`DOWNLOAD` key for the action 'Download'
`static String`	`FOLDER_FORM` key for the action 'Folder properties'
`static String`	`FOLDER_PROPS` key for the action 'Folder properties'
`static String`	`FORM` key for the column holding the form link of the DMSObject
`static String`	`INFO` key for the column holding the link to the detailed information of the DMSObject
`static String`	`LINK` key for the action 'Link'
`static String`	`NAME` key for the column holding the name of the DMSObject and the link to its content
`static String`	`NEW` key for the action 'New'
`static String`	`NOTES` key for the column holding the link to the attached notes of the DMSObject
`static String`	`OID` key for the column holding the oid of the DMSObject
`static String`	`PASTE` key for the action 'Paste'
`static String`	`REFRESH` key for the action 'Refresh'
`static String`	`REPLACE` key for the action 'Replace'
`static int`	`RO` Determines that the user has only view right for the folder.
`static int`	`RO_REC` Deprecated. will not be used and supported since version 8.0
`static int`	`RW` Determines that the user has edit right for the folder.
`static String`	`SEARCH` key for triggering the search
`static String`	`SEARCH_ALL` key for clearing the search (= shows all entries)
`static String`	`SEARCH_FIELD` key for search input field
`static String`	`SEND_TO` key for the action 'Send to'
`static String`	`SIGN` key for the action 'Sign'
`static String`	`SIZE` key for the column holding the size of the DMSObject
`static String`	`SPACE` key for the action separator
`static String`	`START_PROCESS` key for the action 'Start process'
`static String`	`STATUS` key for the column holding the status of the DMSObject
`static String`	`TYPE` key for the column holding the formtype of the DMSObject
`static String`	`UPWARD` key for the action 'Upward'
`static String`	`VERSIONS` key for the column holding the link to the versions of the DMSObject
`static String`	`WEBFOLDER` key for the action 'Web-Folder'

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default List<DMSObject>`	`getList(List<DMSObject> objects)` Your chance to modify the list of the table entries and to collect additional data for them.
`default void`	`init(HttpServletRequest req, DMSFolder folder, User u, int mode)` You can init your class with the request
`default String`	`lineStyle(DMSObject obj, String style)` Change the style of the line by returning the name of the style class to use.
`default void`	`modifyActions(List<Pair<String,Object>> actions)` Your chance to modify the set of provided actions, called for each table line.
`default void`	`modifyColumns(List<ColumnDescription> colDescs)` You get the columns as we suggest it as a list of `ColumnDescription` (see the corresponding statics defined in this interface as values for the ids of the ColumnDescriptions, e.g.
`default void`	`modifyTableLine(DMSObject obj, Map<String,Object> line)` Your chance to modify the line, called for each table line.

- Field Detail
  - RW
```
static final int RW
```
    Determines that the user has edit right for the folder.
    
    See Also:
    
    Constant Field Values
  - RO
```
static final int RO
```
    Determines that the user has only view right for the folder.
    
    See Also:
    
    Constant Field Values
  - RO_REC
```
@Deprecated
static final int RO_REC
```
    Deprecated. will not be used and supported since version 8.0
    
    Determines that the user has only view right for the folder and all its content elements.
    
    See Also:
    
    Constant Field Values
  - OID
```
static final String OID
```
    key for the column holding the oid of the DMSObject
    
    See Also:
    
    Constant Field Values
  - NAME
```
static final String NAME
```
    key for the column holding the name of the DMSObject and the link to its content
    
    See Also:
    
    Constant Field Values
  - FORM
```
static final String FORM
```
    key for the column holding the form link of the DMSObject
    
    See Also:
    
    Constant Field Values
  - TYPE
```
static final String TYPE
```
    key for the column holding the formtype of the DMSObject
    
    See Also:
    
    Constant Field Values
  - SIZE
```
static final String SIZE
```
    key for the column holding the size of the DMSObject
    
    See Also:
    
    Constant Field Values
  - CHANGED_AT
```
static final String CHANGED_AT
```
    key for the column holding the date of the last change of the DMSObject
    
    See Also:
    
    Constant Field Values
  - STATUS
```
static final String STATUS
```
    key for the column holding the status of the DMSObject
    
    See Also:
    
    Constant Field Values
  - INFO
```
static final String INFO
```
    key for the column holding the link to the detailed information of the DMSObject
    
    See Also:
    
    Constant Field Values
  - VERSIONS
```
static final String VERSIONS
```
    key for the column holding the link to the versions of the DMSObject
    
    See Also:
    
    Constant Field Values
  - NOTES
```
static final String NOTES
```
    key for the column holding the link to the attached notes of the DMSObject
    
    See Also:
    
    Constant Field Values
  - SPACE
```
static final String SPACE
```
    key for the action separator
    
    See Also:
    
    Constant Field Values
  - NEW
```
static final String NEW
```
    key for the action 'New'
    
    See Also:
    
    Constant Field Values
  - CUT
```
static final String CUT
```
    key for the action 'Cut'
    
    See Also:
    
    Constant Field Values
  - COPY
```
static final String COPY
```
    key for the action 'Copy'
    
    See Also:
    
    Constant Field Values
  - PASTE
```
static final String PASTE
```
    key for the action 'Paste'
    
    See Also:
    
    Constant Field Values
  - LINK
```
static final String LINK
```
    key for the action 'Link'
    
    See Also:
    
    Constant Field Values
  - DELETE
```
static final String DELETE
```
    key for the action 'Delete'
    
    See Also:
    
    Constant Field Values
  - REFRESH
```
static final String REFRESH
```
    key for the action 'Refresh'
    
    See Also:
    
    Constant Field Values
  - SEND_TO
```
static final String SEND_TO
```
    key for the action 'Send to'
    
    See Also:
    
    Constant Field Values
  - START_PROCESS
```
static final String START_PROCESS
```
    key for the action 'Start process'
    
    See Also:
    
    Constant Field Values
  - CHANGE_TYPE
```
static final String CHANGE_TYPE
```
    key for the action 'Change type'
    
    See Also:
    
    Constant Field Values
  - REPLACE
```
static final String REPLACE
```
    key for the action 'Replace'
    
    See Also:
    
    Constant Field Values
  - CREATE_VERSION
```
static final String CREATE_VERSION
```
    key for the action 'Create Version'
    
    See Also:
    
    Constant Field Values
  - ATTACH_NOTE
```
static final String ATTACH_NOTE
```
    key for the action 'Attach Note'
    
    See Also:
    
    Constant Field Values
  - SIGN
```
static final String SIGN
```
    key for the action 'Sign'
    
    See Also:
    
    Constant Field Values
  - FOLDER_PROPS
```
static final String FOLDER_PROPS
```
    key for the action 'Folder properties'
    
    See Also:
    
    Constant Field Values
  - FOLDER_FORM
```
static final String FOLDER_FORM
```
    key for the action 'Folder properties'
    
    See Also:
    
    Constant Field Values
  - WEBFOLDER
```
static final String WEBFOLDER
```
    key for the action 'Web-Folder'
    
    See Also:
    
    Constant Field Values
  - UPWARD
```
static final String UPWARD
```
    key for the action 'Upward'
    
    See Also:
    
    Constant Field Values
  - CLIPBOARD
```
static final String CLIPBOARD
```
    key for the action 'Clipboard'
    
    See Also:
    
    Constant Field Values
  - DOWNLOAD
```
static final String DOWNLOAD
```
    key for the action 'Download'
    
    See Also:
    
    Constant Field Values
  - SEARCH_FIELD
```
static final String SEARCH_FIELD
```
    key for search input field
    
    See Also:
    
    Constant Field Values
  - SEARCH
```
static final String SEARCH
```
    key for triggering the search
    
    See Also:
    
    Constant Field Values
  - SEARCH_ALL
```
static final String SEARCH_ALL
```
    key for clearing the search (= shows all entries)
    
    See Also:
    
    Constant Field Values
- Method Detail
  - init
```
default void init(HttpServletRequest req,
                  DMSFolder folder,
                  User u,
                  int mode)
```
    You can init your class with the request
    
    Parameters:
    
    req - the request
    
    folder - the folder
    
    u - the user
    
    mode - is RW or RO
  - getList
```
default List<DMSObject> getList(List<DMSObject> objects)
```
    Your chance to modify the list of the table entries and to collect additional data for them.
    
    Returns:
    
    Default returns passed objects unmodified.
  - modifyColumns
```
default void modifyColumns(List<ColumnDescription> colDescs)
```
    You get the columns as we suggest it as a list of ColumnDescription (see the corresponding statics defined in this interface as values for the ids of the ColumnDescriptions, e.g. NAME) You can change these columns as you like. The resulting column list is used to build the table: for all system definied columns we add the corresponding column value, for other ids we add "null" elements.
    
    Parameters:
    
    colDescs - a list of column descriptions
  - modifyTableLine
```
default void modifyTableLine(DMSObject obj,
                             Map<String,Object> line)
```
    Your chance to modify the line, called for each table line. Making the list empty removes the item from the worklist.
    
    Parameters:
    
    obj - the DMSObject
    
    line - the line as map holding the ids and values of the columns
  - modifyActions
```
default void modifyActions(List<Pair<String,Object>> actions)
```
    Your chance to modify the set of provided actions, called for each table line.
    
    Parameters:
    
    actions - a list of pairs holding the set of actions. Pair.first holds the identifier of the action (see Programming Guide), Pair.second holds the action
  - lineStyle
```
default String lineStyle(DMSObject obj,
                         String style)
```
    Change the style of the line by returning the name of the style class to use.
    
    Returns:
    
    Default returns the passed style.

Interface DMSTableHandler

Field Summary

Method Summary

Field Detail

RW

RO

RO_REC

OID

NAME

FORM

TYPE

SIZE

CHANGED_AT

STATUS

INFO

VERSIONS

NOTES

SPACE

NEW

CUT

COPY

PASTE

LINK

DELETE

REFRESH

SEND_TO

START_PROCESS

CHANGE_TYPE

REPLACE

CREATE_VERSION

ATTACH_NOTE

SIGN

FOLDER_PROPS

FOLDER_FORM

WEBFOLDER

UPWARD

CLIPBOARD

DOWNLOAD

SEARCH_FIELD

SEARCH

SEARCH_ALL

Method Detail

init

getList

modifyColumns

modifyTableLine

modifyActions

lineStyle