MenuItemKey (webclient 8.0.0-0 API)

java.lang.Object
- java.lang.Enum<MenuItemKey>
- - com.saperion.ngc.resultset.MenuItemKey

All Implemented Interfaces:

Serializable, Comparable<MenuItemKey>
```
public enum MenuItemKey
extends Enum<MenuItemKey>
```
Keys that specify certain menu items that can be removed from a result list's context menu.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DOC_CHECKOUT` Item to checkout a document.
`DOC_CONTAINED` Item to open contained-in-folders-dialog.
`DOC_DELETE` Item to delete document.
`DOC_DOWNLOAD` Item to download document.
`DOC_EDIT` Item to edit annotations.
`DOC_EDIT_STRUCTURE` Item to edit the structure.
`DOC_HISTORY` Item to open workflow history dialog.
`DOC_INDEX` Item to edit index data.
`DOC_LAUNCH` Item to launch a workflow.
`DOC_NEW` Item to create a new document.
`DOC_PRINT` Item to print documents.
`DOC_RELEASE` Item to set released version.
`DOC_REVISION` Item to open revision history.
`DOC_SECURITY` Item to add or remove ACLs.
`DOC_SENDMAIL` Item to send files as mail.
`DOC_SENDMAIL_ATTACHMENT` Item to send files as attachment in mail.
`DOC_SENDMAIL_LINK` Item to send files as link in mail.
`DOC_SENDMAIL_PDF` Item to send files as PDF attachment in mail.
`DOC_UNDELETE` Item to undelete document.
`DOC_VIEW` Item to open viewer window.
`FOLDER_DELETE` Item to delete a folder.
`FOLDER_EDIT` Item to edit a folder's properties.
`FOLDER_OPEN` Item to open folder.
`FOLDER_WORKFLOW` Item to launch a workflow on a folder.
`LOOKUP_DELETE` Only for lookup tables: Delete item.
`LOOKUP_EDIT` Only for lookup tables: Edit item.
`LOOKUP_NEW` Only for lookup tables: Add new.
`WF_APPROVE` (Workflow inbox) Item to perform approve command.
`WF_CHANGE_OWNER` (Workflow inbox) Item to change workflow item's owner.
`WF_COMMENTS` (Workflow inbox) Item to show workflow comments dialog.
`WF_EDIT_DOCUMENT` (Workflow inbox) Item to edit the annotations of an attachment.
`WF_EDIT_DOCUMENT_INDEX` (Workflow inbox) Item to edit an attachment's index.
`WF_EDIT_WORKFLOW_INDEX` (Workflow inbox) Item to edit a workflow item's index.
`WF_ESCALATION` (Workflow inbox) Item to set escalation date.
`WF_FORWARD` (Workflow inbox) Item to perform forward command.
`WF_HISTORY` (Workflow inbox) Item to show workflow history dialog.
`WF_HOLD` (Workflow inbox) Item to set hold date.
`WF_NOT_RESPONSIBLE` (Workflow inbox) Item to perform not-responsible command.
`WF_PAUSE` (Workflow inbox) Item to perform pause command.
`WF_PUT_BACK` (Workflow inbox) Item to perform put-back command.
`WF_RESET_HOLD` (Workflow inbox) Item to reset hold date.
`WF_SET_USER` (Workflow inbox) Item to perform set-user command.
`WF_TAKE` (Workflow inbox) Item to perform take command.
`WF_TAKE_NOTICE` (Workflow inbox) Item to perform take notice action.
`WORKFLOW` (Workflow inbox) All workflow menu items shown in inbox.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static MenuItemKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static MenuItemKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - DOC_NEW
```
public static final MenuItemKey DOC_NEW
```
    Item to create a new document.
  - DOC_EDIT
```
public static final MenuItemKey DOC_EDIT
```
    Item to edit annotations.
  - DOC_EDIT_STRUCTURE
```
public static final MenuItemKey DOC_EDIT_STRUCTURE
```
    Item to edit the structure.
  - DOC_DELETE
```
public static final MenuItemKey DOC_DELETE
```
    Item to delete document.
  - DOC_UNDELETE
```
public static final MenuItemKey DOC_UNDELETE
```
    Item to undelete document.
  - DOC_INDEX
```
public static final MenuItemKey DOC_INDEX
```
    Item to edit index data.
  - DOC_VIEW
```
public static final MenuItemKey DOC_VIEW
```
    Item to open viewer window.
  - DOC_DOWNLOAD
```
public static final MenuItemKey DOC_DOWNLOAD
```
    Item to download document.
  - DOC_SENDMAIL
```
public static final MenuItemKey DOC_SENDMAIL
```
    Item to send files as mail.
  - DOC_SENDMAIL_LINK
```
public static final MenuItemKey DOC_SENDMAIL_LINK
```
    Item to send files as link in mail.
  - DOC_SENDMAIL_ATTACHMENT
```
public static final MenuItemKey DOC_SENDMAIL_ATTACHMENT
```
    Item to send files as attachment in mail.
  - DOC_SENDMAIL_PDF
```
public static final MenuItemKey DOC_SENDMAIL_PDF
```
    Item to send files as PDF attachment in mail.
  - DOC_SECURITY
```
public static final MenuItemKey DOC_SECURITY
```
    Item to add or remove ACLs.
  - DOC_REVISION
```
public static final MenuItemKey DOC_REVISION
```
    Item to open revision history.
  - DOC_CONTAINED
```
public static final MenuItemKey DOC_CONTAINED
```
    Item to open contained-in-folders-dialog.
  - DOC_LAUNCH
```
public static final MenuItemKey DOC_LAUNCH
```
    Item to launch a workflow.
  - DOC_HISTORY
```
public static final MenuItemKey DOC_HISTORY
```
    Item to open workflow history dialog.
  - DOC_CHECKOUT
```
public static final MenuItemKey DOC_CHECKOUT
```
    Item to checkout a document.
  - DOC_RELEASE
```
public static final MenuItemKey DOC_RELEASE
```
    Item to set released version.
  - DOC_PRINT
```
public static final MenuItemKey DOC_PRINT
```
    Item to print documents.
  - LOOKUP_NEW
```
public static final MenuItemKey LOOKUP_NEW
```
    Only for lookup tables: Add new.
  - LOOKUP_EDIT
```
public static final MenuItemKey LOOKUP_EDIT
```
    Only for lookup tables: Edit item.
  - LOOKUP_DELETE
```
public static final MenuItemKey LOOKUP_DELETE
```
    Only for lookup tables: Delete item.
  - WORKFLOW
```
public static final MenuItemKey WORKFLOW
```
    (Workflow inbox) All workflow menu items shown in inbox.
  - FOLDER_OPEN
```
public static final MenuItemKey FOLDER_OPEN
```
    Item to open folder.
  - FOLDER_EDIT
```
public static final MenuItemKey FOLDER_EDIT
```
    Item to edit a folder's properties.
  - FOLDER_DELETE
```
public static final MenuItemKey FOLDER_DELETE
```
    Item to delete a folder.
  - FOLDER_WORKFLOW
```
public static final MenuItemKey FOLDER_WORKFLOW
```
    Item to launch a workflow on a folder.
  - WF_EDIT_WORKFLOW_INDEX
```
public static final MenuItemKey WF_EDIT_WORKFLOW_INDEX
```
    (Workflow inbox) Item to edit a workflow item's index.
  - WF_EDIT_DOCUMENT_INDEX
```
public static final MenuItemKey WF_EDIT_DOCUMENT_INDEX
```
    (Workflow inbox) Item to edit an attachment's index.
  - WF_EDIT_DOCUMENT
```
public static final MenuItemKey WF_EDIT_DOCUMENT
```
    (Workflow inbox) Item to edit the annotations of an attachment.
  - WF_COMMENTS
```
public static final MenuItemKey WF_COMMENTS
```
    (Workflow inbox) Item to show workflow comments dialog.
  - WF_APPROVE
```
public static final MenuItemKey WF_APPROVE
```
    (Workflow inbox) Item to perform approve command.
  - WF_ESCALATION
```
public static final MenuItemKey WF_ESCALATION
```
    (Workflow inbox) Item to set escalation date.
  - WF_FORWARD
```
public static final MenuItemKey WF_FORWARD
```
    (Workflow inbox) Item to perform forward command.
  - WF_HISTORY
```
public static final MenuItemKey WF_HISTORY
```
    (Workflow inbox) Item to show workflow history dialog.
  - WF_PAUSE
```
public static final MenuItemKey WF_PAUSE
```
    (Workflow inbox) Item to perform pause command.
  - WF_HOLD
```
public static final MenuItemKey WF_HOLD
```
    (Workflow inbox) Item to set hold date.
  - WF_CHANGE_OWNER
```
public static final MenuItemKey WF_CHANGE_OWNER
```
    (Workflow inbox) Item to change workflow item's owner.
  - WF_SET_USER
```
public static final MenuItemKey WF_SET_USER
```
    (Workflow inbox) Item to perform set-user command.
  - WF_NOT_RESPONSIBLE
```
public static final MenuItemKey WF_NOT_RESPONSIBLE
```
    (Workflow inbox) Item to perform not-responsible command.
  - WF_TAKE
```
public static final MenuItemKey WF_TAKE
```
    (Workflow inbox) Item to perform take command.
  - WF_PUT_BACK
```
public static final MenuItemKey WF_PUT_BACK
```
    (Workflow inbox) Item to perform put-back command.
  - WF_RESET_HOLD
```
public static final MenuItemKey WF_RESET_HOLD
```
    (Workflow inbox) Item to reset hold date.
  - WF_TAKE_NOTICE
```
public static final MenuItemKey WF_TAKE_NOTICE
```
    (Workflow inbox) Item to perform take notice action.
- Method Detail
  - values
```
public static MenuItemKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (MenuItemKey c : MenuItemKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static MenuItemKey valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null

Enum MenuItemKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

DOC_NEW

DOC_EDIT

DOC_EDIT_STRUCTURE

DOC_DELETE

DOC_UNDELETE

DOC_INDEX

DOC_VIEW

DOC_DOWNLOAD

DOC_SENDMAIL

DOC_SENDMAIL_LINK

DOC_SENDMAIL_ATTACHMENT

DOC_SENDMAIL_PDF

DOC_SECURITY

DOC_REVISION

DOC_CONTAINED

DOC_LAUNCH

DOC_HISTORY

DOC_CHECKOUT

DOC_RELEASE

DOC_PRINT

LOOKUP_NEW

LOOKUP_EDIT

LOOKUP_DELETE

WORKFLOW

FOLDER_OPEN

FOLDER_EDIT

FOLDER_DELETE

FOLDER_WORKFLOW

WF_EDIT_WORKFLOW_INDEX

WF_EDIT_DOCUMENT_INDEX

WF_EDIT_DOCUMENT

WF_COMMENTS

WF_APPROVE

WF_ESCALATION

WF_FORWARD

WF_HISTORY

WF_PAUSE

WF_HOLD

WF_CHANGE_OWNER

WF_SET_USER

WF_NOT_RESPONSIBLE

WF_TAKE

WF_PUT_BACK

WF_RESET_HOLD

WF_TAKE_NOTICE

Method Detail

values

valueOf