Package com.saperion.ngc.resultset

Class ContextMenuVisibility

java.lang.Object

com.saperion.ngc.resultset.ContextMenuVisibility

public class ContextMenuVisibility
extends java.lang.Object

Computes if certain context menu items are visible or not.

Constructor Summary

Constructors

Constructor	Description
ContextMenuVisibility(ResultSetViewImpl view, User user)	Creates a new ContextMenuVisibility instance for items that do not need the result of the item analyzer.
ContextMenuVisibility(ResultSetViewImpl view, User user, ItemAnalyzeResult analyze)	Creates a new ContextMenuVisibility instance.

Method Summary

Modifier and Type	Method	Description
boolean	activateLitigationHold(boolean multiselect)
boolean	checkout(boolean multiselect)
boolean	checkoutWithShareBase(boolean multiselect)
boolean	containedInFolder(boolean multiselect)
boolean	delete(boolean multiselect)
boolean	deleteFolder(boolean multiselect)
boolean	deleteLookupItem(boolean multiselect)
boolean	docWfHistory(boolean multiselect)
boolean	download(boolean multiselect)
boolean	editAnnotations(boolean multiselect)
boolean	editFolder(boolean multiselect)
boolean	editLookupItem(boolean multiselect)
boolean	editStructure(boolean multiselect)
boolean	enableItemsThatRequireReadDocument()
boolean	indexData(boolean multiselect)
boolean	launch(boolean multiselect)
boolean	launchFolder(boolean multiselect)
boolean	mail(boolean multiselect)
boolean	newDocument(boolean multiselect)
boolean	newLookupItem(boolean multiselect)
boolean	oneDriveUpload(boolean multiselect)
boolean	openFolder(boolean multiselect)
boolean	printAsPdf(boolean multiselect)
boolean	prolongRetentionTime(boolean multiselect)
boolean	reduceDispositionTime(boolean multiselect)
boolean	release(boolean multiselect)
boolean	revisionHistory(boolean multiselect)
boolean	security(boolean multiselect)
boolean	securityForLookup(boolean multiselect)
boolean	shareBaseUpload(boolean multiselect)
boolean	unDelete(boolean multiselect)
boolean	viewDocument(boolean multiselect)
boolean	wfComments(boolean multiselect)
boolean	wfEditAnnotations(boolean multiSelect)
boolean	wfEditDocumentIndex(boolean multiselect)
boolean	wfEditWorkflowIndex(boolean multiselect)
boolean	workflowCommandNotRemovedByScript(com.saperion.constants.SaWFConstants.CommandId command, boolean multiSelect)	Checks if the menuitem for the specified command was disabled by script.
boolean	workflowMenu(boolean multiselect)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContextMenuVisibility

public ContextMenuVisibility(ResultSetViewImpl view,
                             User user,
                             ItemAnalyzeResult analyze)

Creates a new ContextMenuVisibility instance.

Parameters:

view - parent view of the menu

user - current user

analyze - result of item analyzer

ContextMenuVisibility

public ContextMenuVisibility(ResultSetViewImpl view,
                             User user)

Creates a new ContextMenuVisibility instance for items that do not need the result of the item analyzer.

Parameters:

view - parent view of menu

user - current user

Method Detail

newLookupItem

public boolean newLookupItem(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if new lookup item menu is visible

editLookupItem

public boolean editLookupItem(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if edit lookup item menu is visible

deleteLookupItem

public boolean deleteLookupItem(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if delete lookup item menu is visible

newDocument

public boolean newDocument(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if new document menu is visible

viewDocument

public boolean viewDocument(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if view document menu is visible

revisionHistory

public boolean revisionHistory(boolean multiselect)
                        throws NgcUiException,
                               AuthenticationException

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if revision history menu is visible

Throws:

NgcUiException - exception to be handled by view

AuthenticationException - re-logon required

containedInFolder

public boolean containedInFolder(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if contained in folder menu is visible

download

public boolean download(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if download menu is visible

shareBaseUpload

public boolean shareBaseUpload(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if upload menu is visible

oneDriveUpload

public boolean oneDriveUpload(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if upload menu is visible

mail

public boolean mail(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if mail menu is visible

printAsPdf

public boolean printAsPdf(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if mail menu is visible

indexData

public boolean indexData(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if index data menu is visible

delete

public boolean delete(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if delete menu is visible

unDelete

public boolean unDelete(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if undelete menu is visible

editAnnotations

public boolean editAnnotations(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if edit annotations menu is visible

editStructure

public boolean editStructure(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if edit annotations menu is visible

security

public boolean security(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if new document menu is visible

securityForLookup

public boolean securityForLookup(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if new document menu is visible

launch

public boolean launch(boolean multiselect)
               throws NgcUiException

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if launch menu is visible

Throws:

NgcUiException - exception to be handled by view

docWfHistory

public boolean docWfHistory(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if document workflow history menu is visible

checkout

public boolean checkout(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if checkout menu is visible

checkoutWithShareBase

public boolean checkoutWithShareBase(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if checkout menu is visible

release

public boolean release(boolean multiselect)
                throws NgcUiException,
                       AuthenticationException

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if release menu is visible

Throws:

NgcUiException - exception to be handled by view

AuthenticationException - re-logon required

openFolder

public boolean openFolder(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if open folder menu is visible

deleteFolder

public boolean deleteFolder(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if delete folder menu is visible

editFolder

public boolean editFolder(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if edit folder menu is visible

launchFolder

public boolean launchFolder(boolean multiselect)

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if launch folder menu is visible

workflowMenu

public boolean workflowMenu(boolean multiselect)
                     throws NgcUiException

Parameters:

multiselect - whether multiple items were selected or not

Returns:

if workflow menu is visible

Throws:

NgcUiException - exception to be handled by view

enableItemsThatRequireReadDocument

public boolean enableItemsThatRequireReadDocument()

Returns:

whether to enable items that need to read content of the document

wfEditAnnotations

public boolean wfEditAnnotations(boolean multiSelect)

Parameters:

multiSelect - multiple items selected or not

Returns:

whether edit annotations item in workflow inbox should be shown

wfEditWorkflowIndex

public boolean wfEditWorkflowIndex(boolean multiselect)

Parameters:

multiselect - multiple items selected or not

Returns:

whether edit workflow index item in workflow inbox should be shown

wfEditDocumentIndex

public boolean wfEditDocumentIndex(boolean multiselect)

Parameters:

multiselect - multiple items selected or not

Returns:

whether edit workflow index item in workflow inbox should be shown

wfComments

public boolean wfComments(boolean multiselect)

Parameters:

multiselect - multiple items selected or not

Returns:

whether show comments dialog item in workflow inbox shoult be shown

prolongRetentionTime

public boolean prolongRetentionTime(boolean multiselect)
                             throws NgcUiException

Throws:

NgcUiException

reduceDispositionTime

public boolean reduceDispositionTime(boolean multiselect)
                              throws NgcUiException

Throws:

NgcUiException

activateLitigationHold

public boolean activateLitigationHold(boolean multiselect)
                               throws NgcUiException

Throws:

NgcUiException

workflowCommandNotRemovedByScript

public boolean workflowCommandNotRemovedByScript(com.saperion.constants.SaWFConstants.CommandId command,
                                                 boolean multiSelect)

Checks if the menuitem for the specified command was disabled by script.

Parameters:

command - command-id

multiSelect - multiple items selected or not

Returns:

whether the menu item was disabled