Package org.compiere.model

Class MRecentItem

java.lang.Object

org.compiere.model.PO

org.compiere.model.X_AD_RecentItem

org.compiere.model.MRecentItem

All Implemented Interfaces:

Serializable, Cloneable, Comparator<Object>, I_AD_RecentItem, I_Persistent, Evaluatee, ImmutablePOSupport

public class MRecentItem
extends X_AD_RecentItem
implements ImmutablePOSupport

Recent Item model

Author:

Carlos Ruiz - GlobalQSS

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ON_RECENT_ITEM_CHANGED_TOPIC

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_RecentItem

accessLevel, COLUMNNAME_AD_Client_ID, COLUMNNAME_AD_Org_ID, COLUMNNAME_AD_RecentItem_ID, COLUMNNAME_AD_RecentItem_UU, COLUMNNAME_AD_Role_ID, COLUMNNAME_AD_Tab_ID, COLUMNNAME_AD_Table_ID, COLUMNNAME_AD_User_ID, COLUMNNAME_AD_Window_ID, COLUMNNAME_Created, COLUMNNAME_CreatedBy, COLUMNNAME_IsActive, COLUMNNAME_Record_ID, COLUMNNAME_Record_UU, COLUMNNAME_Updated, COLUMNNAME_UpdatedBy, Model, Table_ID, Table_Name

Constructor Summary

Constructors

Constructor	Description
MRecentItem(Properties ctx, int AD_RecentItem_ID, String trxName)	Standard Constructor
MRecentItem(Properties ctx, String AD_RecentItem_UU, String trxName)	UUID based Constructor
MRecentItem(Properties ctx, ResultSet rs, String trxName)	Load Constructor
MRecentItem(Properties ctx, MRecentItem copy)	Copy constructor
MRecentItem(Properties ctx, MRecentItem copy, String trxName)	Copy constructor
MRecentItem(MRecentItem copy)	Copy constructor

Method Summary

Modifier and Type	Method	Description
static void	addModifiedField(Properties ctx, int AD_Table_ID, int Record_ID, String Record_UU, int AD_User_ID, int AD_Role_ID, int AD_Window_ID, int AD_Tab_ID)	addModifiedField / method to be called when a field is modified on a window. It adds a record in recent item, or touches the record if it was added before.
static void	clearLabel(int AD_Table_ID, int Record_ID, String Record_UU)	Clear the label (to display) cache in a recent item instance.
static MRecentItem	get(Properties ctx, int AD_RecentItem_ID)	Get from Cache using ID (immutable)
static MRecentItem	get(Properties ctx, int AD_Table_ID, int Record_ID, String Record_UU, int AD_User_ID)	Get Recent Item from Cache using table+recordID (immutable)
static MRecentItem	getCopy(Properties ctx, int AD_RecentItem_ID, String trxName)	Get updateable copy of MRecentItem from cache
static List<MRecentItem>	getFromUser(Properties ctx, int AD_User_ID)	Get the recent items from user - for performance obtain the ids and then get the MRecentItem from cache
String	getLabel()	Build label for this item from window name and title logic.
MRecentItem	markImmutable()	mark PO as immutable
static void	postOnChangedEvent(int AD_User_ID)	Post ON_RECENT_ITEM_CHANGED_TOPIC OSGi event.
static void	publishChangedEvent(int AD_User_ID)	Publish ON_RECENT_ITEM_CHANGED_TOPIC message to message service. If message service is not available, fall back to postOnChangedEvent(int).
String	toString()	String representation
static void	touchUpdatedRecord(Properties ctx, int AD_Table_ID, int Record_ID, String Record_UU, int AD_User_ID)	touchUpdatedRecord / method to be called when a record is saved or updated in database. It touches the record added before. Also delete recent items beyond the number of records allowed per user.

Methods inherited from class org.compiere.model.X_AD_RecentItem

get_AccessLevel, getAD_RecentItem_ID, getAD_RecentItem_UU, getAD_Role, getAD_Role_ID, getAD_Tab, getAD_Tab_ID, getAD_Table, getAD_Table_ID, getAD_User, getAD_User_ID, getAD_Window, getAD_Window_ID, getRecord_ID, getRecord_UU, initPO, setAD_RecentItem_ID, setAD_RecentItem_UU, setAD_Role_ID, setAD_Tab_ID, setAD_Table_ID, setAD_User_ID, setAD_Window_ID, setRecord_ID, setRecord_UU

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_TableAttribute, get_TableAttributeAsBoolean, get_TableAttributeAsInt, get_TableAttributes, 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, validForeignKeysEx

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_RecentItem

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

ON_RECENT_ITEM_CHANGED_TOPIC

public static final String ON_RECENT_ITEM_CHANGED_TOPIC

See Also:

• Constant Field Values

Constructor Details

MRecentItem

public MRecentItem(Properties ctx,
 String AD_RecentItem_UU,
 String trxName)

UUID based Constructor

Parameters:

ctx - Context

AD_RecentItem_UU - UUID key

trxName - Transaction

MRecentItem

public MRecentItem(Properties ctx,
 int AD_RecentItem_ID,
 String trxName)

Standard Constructor

Parameters:

ctx - context

AD_RecentItem_ID - id

trxName - transaction

MRecentItem

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

Load Constructor

Parameters:

ctx - ctx

rs - result set

trxName - transaction

MRecentItem

public MRecentItem(MRecentItem copy)

Copy constructor

Parameters:

copy -

MRecentItem

public MRecentItem(Properties ctx,
 MRecentItem copy)

Copy constructor

Parameters:

ctx -

copy -

MRecentItem

public MRecentItem(Properties ctx,
 MRecentItem copy,
 String trxName)

Copy constructor

Parameters:

ctx -

copy -

trxName -

Method Details

get

public static MRecentItem get(Properties ctx,
 int AD_RecentItem_ID)

Get from Cache using ID (immutable)

Parameters:

ctx - context

AD_RecentItem_ID - id

Returns:

recent item

getCopy

public static MRecentItem getCopy(Properties ctx,
 int AD_RecentItem_ID,
 String trxName)

Get updateable copy of MRecentItem from cache

Parameters:

ctx -

AD_RecentItem_ID -

trxName -

Returns:

MRecentItem

get

public static MRecentItem get(Properties ctx,
 int AD_Table_ID,
 int Record_ID,
 String Record_UU,
 int AD_User_ID)

Get Recent Item from Cache using table+recordID (immutable)

Parameters:

ctx - context

AD_Table_ID - tableID

Record_ID - record ID

Record_UU - record UUID

Returns:

recent item

addModifiedField

public static void addModifiedField(Properties ctx,
 int AD_Table_ID,
 int Record_ID,
 String Record_UU,
 int AD_User_ID,
 int AD_Role_ID,
 int AD_Window_ID,
 int AD_Tab_ID)

addModifiedField / method to be called when a field is modified on a window.
It adds a record in recent item, or touches the record if it was added before.

Parameters:

ctx -

AD_Table_ID -

Record_ID -

Record_UU -

AD_User_ID -

AD_Role_ID -

AD_Window_ID -

AD_Tab_ID -

publishChangedEvent

public static void publishChangedEvent(int AD_User_ID)

Publish ON_RECENT_ITEM_CHANGED_TOPIC message to message service.
If message service is not available, fall back to postOnChangedEvent(int).

Parameters:

AD_User_ID -

postOnChangedEvent

public static void postOnChangedEvent(int AD_User_ID)

Post ON_RECENT_ITEM_CHANGED_TOPIC OSGi event.

Parameters:

AD_User_ID -

touchUpdatedRecord

public static void touchUpdatedRecord(Properties ctx,
 int AD_Table_ID,
 int Record_ID,
 String Record_UU,
 int AD_User_ID)

touchUpdatedRecord / method to be called when a record is saved or updated in database.
It touches the record added before.
Also delete recent items beyond the number of records allowed per user.

Parameters:

ctx -

AD_Table_ID -

Record_UU -

AD_User_ID -

getFromUser

public static List<MRecentItem> getFromUser(Properties ctx,
 int AD_User_ID)

Get the recent items from user - for performance obtain the ids and then get the MRecentItem from cache

Parameters:

ctx -

AD_User_ID -

Returns:

list of recent item record

getLabel

public String getLabel()

Build label for this item from window name and title logic. Fall back to record identifier if title logic is not available.

Returns:

label

clearLabel

public static void clearLabel(int AD_Table_ID,
 int Record_ID,
 String Record_UU)

Clear the label (to display) cache in a recent item instance.

Parameters:

AD_Table_ID -

Record_ID -

Record_UU -

markImmutable

public MRecentItem markImmutable()

Description copied from interface: ImmutablePOSupport

mark PO as immutable

Specified by:

markImmutable in interface ImmutablePOSupport

Returns:

PO

toString

public String toString()

Description copied from class: PO

String representation

Overrides:

toString in class X_AD_RecentItem

Returns:

String representation