Package org.compiere.model

Class MToolBarButtonRestrict

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_ToolBarButtonRestrict

org.compiere.model.MToolBarButtonRestrict

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_ToolBarButtonRestrict, I_Persistent, Evaluatee

public class MToolBarButtonRestrict
extends X_AD_ToolBarButtonRestrict

ToolBar and Button Restriction

Author:

Nicolas Micoud

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SQL_IS_TOOLBAR_BTN_EXCLUDED

Fields inherited from class org.compiere.model.X_AD_ToolBarButtonRestrict

ACTION_AD_Reference_ID, ACTION_Detail, ACTION_Form, ACTION_Info, ACTION_Process, ACTION_Report, ACTION_Task, ACTION_Window, ACTION_Workbench, ACTION_WorkFlow

Fields inherited from class org.compiere.model.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, LOCAL_TRX_PREFIX, log, p_ctx, p_info, UUID_NEW_RECORD, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Fields inherited from interface org.compiere.model.I_AD_ToolBarButtonRestrict

accessLevel, COLUMNNAME_Action, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_Process_ID, COLUMNNAME_AD_Role_ID, COLUMNNAME_AD_Tab_ID, COLUMNNAME_AD_ToolBarButton_ID, COLUMNNAME_AD_ToolBarButtonRestrict_ID, COLUMNNAME_AD_ToolBarButtonRestrict_UU, COLUMNNAME_AD_Window_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_IsActive, COLUMNNAME_IsExclude, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MToolBarButtonRestrict(Properties ctx, int AD_ToolBarButtonRestrict_ID, String trxName)	Standard Constructor
MToolBarButtonRestrict(Properties ctx, String AD_ToolBarButtonRestrict_UU, String trxName)	UUID based Constructor
MToolBarButtonRestrict(Properties ctx, ResultSet rs, String trxName)	Load Constructor

Method Summary

Modifier and Type	Method	Description
static int[]	getOfReport(Properties ctx, int AD_Role_ID, int AD_Process_ID, String trxName)	Get list of button with restrictions to be applied according to the role, the report/process ...
static int[]	getOfTab(Properties ctx, int AD_Role_ID, int AD_Window_ID, int AD_Tab_ID, String trxName)	Get list of button with restrictions to be applied according to the role, the tab of the window ...
static int[]	getOfWindow(Properties ctx, int AD_Role_ID, int AD_Window_ID, boolean reportViewer, String trxName)	Get list of button with restrictions to be applied according to role and window
static int[]	getProcessButtonOfTab(Properties ctx, int AD_Role_ID, int AD_Tab_ID, String trxName)	Get list of process button (with AD_Process_ID) with restrictions to be applied according to role and tab
static boolean	isNewButtonRestricted(int windowID)	Check access for "New Record" Toolbar button
static boolean	isNewButtonRestricted(int windowID, int tabID)	Check access for "New Record" Toolbar button
static boolean	isToolbarButtonRestricted(int windowID, int tabID, int toolbarBtnID)	Check toolbar button restriction
String	toString()	String Representation

Methods inherited from class org.compiere.model.X_AD_ToolBarButtonRestrict

get_AccessLevel, getAction, getAD_Process, getAD_Process_ID, getAD_Role, getAD_Role_ID, getAD_Tab, getAD_Tab_ID, getAD_ToolBarButton, getAD_ToolBarButton_ID, getAD_ToolBarButtonRestrict_ID, getAD_ToolBarButtonRestrict_UU, getAD_Window, getAD_Window_ID, initPO, isExclude, setAction, setAD_Process_ID, setAD_Role_ID, setAD_Tab_ID, setAD_ToolBarButton_ID, setAD_ToolBarButtonRestrict_ID, setAD_ToolBarButtonRestrict_UU, setAD_Window_ID, setIsExclude

Methods inherited from class org.compiere.model.PO

afterDelete, afterSave, beforeDelete, beforeSave, buildInsertSQL, checkImmutable, clearCrossTenantSafe, clone, columnExists, columnExists, compare, copyPO, copyValues, copyValues, createAttachment, delete, delete, delete_Accounting, delete_Tree, deleteEx, deleteEx, dump, dump, equals, get_Attribute, get_Attributes, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_HashMap, get_ID, get_IDOld, get_KeyColumns, get_Logger, get_OptimisticLockingColumns, get_Table_ID, get_TableName, get_Translation, get_Translation, get_Translation, get_Translation, get_Translation, get_TrxName, get_UUID, get_Value, get_Value, get_ValueAsBoolean, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueE, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_WhereClause, get_WhereClause, get_xmlDocument, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getDoc, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getUUIDColumnName, getUUIDColumnName, hashCode, insert_Accounting, insert_Tree, insert_Tree, is_Changed, is_Immutable, is_new, is_UseOptimisticLocking, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, isReplication, load, load, load, load, loadByUU, loadComplete, loadDefaults, loadPO, loadSpecial, lock, makeImmutable, postDelete, retrieveIdOfParentValue, retrieveIdOfParentValue, save, save, saveCrossTenantSafe, saveCrossTenantSafeEx, saveCrossTenantSafeEx, saveEx, saveEx, saveNew_afterSetID, saveNew_getID, saveNewSpecial, saveReplica, saveUpdate, set_Attribute, set_ColumnUpdateable, set_CustomColumn, set_CustomColumnReturningBoolean, set_OptimisticLockingColumns, set_TrxName, set_TrxName, set_UseOptimisticLocking, set_Value, set_Value, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueOfColumn, set_ValueOfColumnReturningBoolean, set_ValueOfColumnReturningBoolean, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setCrossTenantSafe, setDoc, setDocWorkflowMgr, setIsActive, setProcessedOn, setReplication, setStandardDefaults, setUpdateable, setUpdatedBy, toInsertSQL, unlock, update_Tree, validForeignKeys

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

reversed, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Methods inherited from interface org.compiere.model.I_AD_ToolBarButtonRestrict

getAD_Client_ID, getAD_Org_ID, getCreated, getCreatedBy, getUpdated, getUpdatedBy, isActive, setAD_Org_ID, setIsActive

Methods inherited from interface org.compiere.model.I_Persistent

save

Field Details

SQL_IS_TOOLBAR_BTN_EXCLUDED

public static final String SQL_IS_TOOLBAR_BTN_EXCLUDED

See Also:

• Constant Field Values

Constructor Details

MToolBarButtonRestrict

public MToolBarButtonRestrict(Properties ctx,
 String AD_ToolBarButtonRestrict_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_ToolBarButtonRestrict_UU - UUID key

trxName - Transaction

MToolBarButtonRestrict

public MToolBarButtonRestrict(Properties ctx,
 int AD_ToolBarButtonRestrict_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

AD_ToolBarButtonRestrict_ID - id

trxName - transaction

MToolBarButtonRestrict

public MToolBarButtonRestrict(Properties ctx,
 ResultSet rs,
 String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Details

getOfWindow

public static int[] getOfWindow(Properties ctx,
 int AD_Role_ID,
 int AD_Window_ID,
 boolean reportViewer,
 String trxName)

Get list of button with restrictions to be applied according to role and window

Parameters:

ctx -

AD_Role_ID -

AD_Window_ID -

reportViewer - true for report viewer, false for window (i.e Action=R or W)

trxName -

Returns:

array of AD_ToolBarButton_ID

getOfTab

public static int[] getOfTab(Properties ctx,
 int AD_Role_ID,
 int AD_Window_ID,
 int AD_Tab_ID,
 String trxName)

Get list of button with restrictions to be applied according to the role, the tab of the window ...

Parameters:

ctx -

AD_Role_ID -

AD_Window_ID -

AD_Tab_ID -

trxName -

Returns:

array of AD_ToolBarButton_ID

getOfReport

public static int[] getOfReport(Properties ctx,
 int AD_Role_ID,
 int AD_Process_ID,
 String trxName)

Get list of button with restrictions to be applied according to the role, the report/process ...

Parameters:

ctx -

AD_Role_ID -

AD_Process_ID -

trxName -

Returns:

array of AD_ToolBarButton_ID

getProcessButtonOfTab

public static int[] getProcessButtonOfTab(Properties ctx,
 int AD_Role_ID,
 int AD_Tab_ID,
 String trxName)

Get list of process button (with AD_Process_ID) with restrictions to be applied according to role and tab

Parameters:

ctx -

AD_Role_ID -

AD_Tab_ID -

trxName -

Returns:

array of AD_ToolBarButton_ID

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_ToolBarButtonRestrict

Returns:

info

isNewButtonRestricted

public static boolean isNewButtonRestricted(int windowID)

Check access for "New Record" Toolbar button

Parameters:

windowID - - AD_Window_ID

Returns:

True if Toolbar button is restricted

isNewButtonRestricted

public static boolean isNewButtonRestricted(int windowID,
 int tabID)

Check access for "New Record" Toolbar button

Parameters:

windowID - - AD_Window_ID

tabID - - AD_Tab_ID

Returns:

True if Toolbar button is restricted

isToolbarButtonRestricted

public static boolean isToolbarButtonRestricted(int windowID,
 int tabID,
 int toolbarBtnID)

Check toolbar button restriction

Parameters:

windowID - - AD_Window_ID

tabID - - AD_Tab_ID

toolbarBtnID - - Toolbar button ID (AD_ToolBarButton_ID)

Returns:

True if Toolbar button is restricted