com.groiss.dms
Interface DMSTableHandler

All Known Implementing Classes:

DMSTableAdapter

public interface DMSTableHandler

Field Summary

static java.lang.String	ATTACH_NOTE key for the action 'Attach Note'
static java.lang.String	CHANGE_TYPE key for the action 'Change type'
static java.lang.String	CHANGED_AT key for the column holding the date of the last change of the DMSObject
static java.lang.String	CLIPBOARD key for the action 'Clipboard'
static java.lang.String	COPY key for the action 'Copy'
static java.lang.String	CREATE_VERSION key for the action 'Create Version'
static java.lang.String	CUT key for the action 'Cut'
static java.lang.String	DELETE key for the action 'Delete'
static java.lang.String	DOWNLOAD key for the action 'Download'
static java.lang.String	FOLDER_FORM key for the action 'Folder properties'
static java.lang.String	FOLDER_PROPS key for the action 'Folder properties'
static java.lang.String	FORM key for the column holding the form link of the DMSObject
static java.lang.String	INFO key for the column holding the link to the detailed information of the DMSObject
static java.lang.String	LINK key for the action 'Link'
static java.lang.String	NAME key for the column holding the name of the DMSObject and the link to its content
static java.lang.String	NEW key for the action 'New'
static java.lang.String	NOTES key for the column holding the link to the attached notes of the DMSObject
static java.lang.String	OID key for the column holding the oid of the DMSObject
static java.lang.String	PASTE key for the action 'Paste'
static java.lang.String	REFRESH key for the action 'Refresh'
static java.lang.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 java.lang.String	SEARCH key for triggering the search
static java.lang.String	SEARCH_ALL key for clearing the search (= shows all entries)
static java.lang.String	SEARCH_FIELD key for search input field
static java.lang.String	SEND_TO key for the action 'Send to'
static java.lang.String	SIGN key for the action 'Sign'
static java.lang.String	SIZE key for the column holding the size of the DMSObject
static java.lang.String	SPACE key for the action separator
static java.lang.String	START_PROCESS key for the action 'Start process'
static java.lang.String	STATUS key for the column holding the status of the DMSObject
static java.lang.String	TYPE key for the column holding the formtype of the DMSObject
static java.lang.String	UPWARD key for the action 'Upward'
static java.lang.String	VERSIONS key for the column holding the link to the versions of the DMSObject
static java.lang.String	WEBFOLDER key for the action 'Web-Folder'

Method Summary

HTMLPage	getHTMLPage() replace the standard page or return null.
java.util.List<DMSObject>	getList(java.util.List<DMSObject> objects) Your chance to modify the list of the table entries and to collect additional data for them
java.lang.String	getTitle() non null overwrites the title.
void	init(javax.servlet.http.HttpServletRequest req, DMSFolder folder, User u, int mode) You can init your class with the request
java.lang.String	lineStyle(DMSObject obj, java.lang.String style) Change the style of the line by returning the name of the style class to use.
void	modifyActions(java.util.List<Pair<java.lang.String,java.lang.Object>> actions) Your chance to modify the set of provided actions, called for each table line.
void	modifyColumns(java.util.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.
void	modifyTableHeader(java.util.List<Pair<java.lang.String,java.lang.Object>> header) Deprecated. since ep 8.0, implement modifyColumns(List) instead
void	modifyTableLine(DMSObject obj, java.util.Map<java.lang.String,java.lang.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 java.lang.String OID

key for the column holding the oid of the DMSObject

See Also:

Constant Field Values

NAME

static final java.lang.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 java.lang.String FORM

key for the column holding the form link of the DMSObject

See Also:

Constant Field Values

TYPE

static final java.lang.String TYPE

key for the column holding the formtype of the DMSObject

See Also:

Constant Field Values

SIZE

static final java.lang.String SIZE

key for the column holding the size of the DMSObject

See Also:

Constant Field Values

CHANGED_AT

static final java.lang.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 java.lang.String STATUS

key for the column holding the status of the DMSObject

See Also:

Constant Field Values

INFO

static final java.lang.String INFO

key for the column holding the link to the detailed information of the DMSObject

See Also:

Constant Field Values

VERSIONS

static final java.lang.String VERSIONS

key for the column holding the link to the versions of the DMSObject

See Also:

Constant Field Values

NOTES

static final java.lang.String NOTES

key for the column holding the link to the attached notes of the DMSObject

See Also:

Constant Field Values

SPACE

static final java.lang.String SPACE

key for the action separator

See Also:

Constant Field Values

NEW

static final java.lang.String NEW

key for the action 'New'

See Also:

Constant Field Values

CUT

static final java.lang.String CUT

key for the action 'Cut'

See Also:

Constant Field Values

COPY

static final java.lang.String COPY

key for the action 'Copy'

See Also:

Constant Field Values

PASTE

static final java.lang.String PASTE

key for the action 'Paste'

See Also:

Constant Field Values

LINK

static final java.lang.String LINK

key for the action 'Link'

See Also:

Constant Field Values

DELETE

static final java.lang.String DELETE

key for the action 'Delete'

See Also:

Constant Field Values

REFRESH

static final java.lang.String REFRESH

key for the action 'Refresh'

See Also:

Constant Field Values

SEND_TO

static final java.lang.String SEND_TO

key for the action 'Send to'

See Also:

Constant Field Values

START_PROCESS

static final java.lang.String START_PROCESS

key for the action 'Start process'

See Also:

Constant Field Values

CHANGE_TYPE

static final java.lang.String CHANGE_TYPE

key for the action 'Change type'

See Also:

Constant Field Values

REPLACE

static final java.lang.String REPLACE

key for the action 'Replace'

See Also:

Constant Field Values

CREATE_VERSION

static final java.lang.String CREATE_VERSION

key for the action 'Create Version'

See Also:

Constant Field Values

ATTACH_NOTE

static final java.lang.String ATTACH_NOTE

key for the action 'Attach Note'

See Also:

Constant Field Values

SIGN

static final java.lang.String SIGN

key for the action 'Sign'

See Also:

Constant Field Values

FOLDER_PROPS

static final java.lang.String FOLDER_PROPS

key for the action 'Folder properties'

See Also:

Constant Field Values

FOLDER_FORM

static final java.lang.String FOLDER_FORM

key for the action 'Folder properties'

See Also:

Constant Field Values

WEBFOLDER

static final java.lang.String WEBFOLDER

key for the action 'Web-Folder'

See Also:

Constant Field Values

UPWARD

static final java.lang.String UPWARD

key for the action 'Upward'

See Also:

Constant Field Values

CLIPBOARD

static final java.lang.String CLIPBOARD

key for the action 'Clipboard'

See Also:

Constant Field Values

DOWNLOAD

static final java.lang.String DOWNLOAD

key for the action 'Download'

See Also:

Constant Field Values

SEARCH_FIELD

static final java.lang.String SEARCH_FIELD

key for search input field

See Also:

Constant Field Values

SEARCH

static final java.lang.String SEARCH

key for triggering the search

See Also:

Constant Field Values

SEARCH_ALL

static final java.lang.String SEARCH_ALL

key for clearing the search (= shows all entries)

See Also:

Constant Field Values

Method Detail

init

void init(javax.servlet.http.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

getHTMLPage

HTMLPage getHTMLPage()

replace the standard page or return null. As basis for your customized html page

getTitle

java.lang.String getTitle()

non null overwrites the title.

getList

java.util.List<DMSObject> getList(java.util.List<DMSObject> objects)

Your chance to modify the list of the table entries and to collect additional data for them

modifyTableHeader

@Deprecated
void modifyTableHeader(java.util.List<Pair<java.lang.String,java.lang.Object>> header)

Deprecated. since ep 8.0, implement modifyColumns(List) instead

You get the header as we suggest it, a list of reserved keywords (see the corresponding statics defined in this interface, e.g. NAME You can change this header as you like. The resulting header is used to build the table lines: for the keywords we add the corresponding column, for other names we add "null" elements.

Parameters:

header - a list of pairs with keyword and label

modifyColumns

void modifyColumns(java.util.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

void modifyTableLine(DMSObject obj,
                     java.util.Map<java.lang.String,java.lang.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

void modifyActions(java.util.List<Pair<java.lang.String,java.lang.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

java.lang.String lineStyle(DMSObject obj,
                           java.lang.String style)

Change the style of the line by returning the name of the style class to use.