com.aspc.file

Class DBFileOpened

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBUserAction

com.aspc.file.DBFileOpened

All Implemented Interfaces:

SecondaryCacheGroup

public class DBFileOpened
extends DBUserAction

records when a user has viewed a file. It is sufficient for a user to have opened a file to determine that the user has viewed the file.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

December 14, 2005

Author:

luke

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID records when a user has viewed a file.
static java.lang.String	DBCLASS_NAME records when a user has viewed a file.

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
DBFileOpened(DBClass def, DataSource ds) Creates a new DBFileOpened object

Method Summary

Modifier and Type	Method and Description
static DBFileOpened	create(DBFile file, Contact contact, DataSource ds) Creates a new DBFileOpened record for the given parameters, does not save the data source.
static DBFileOpened	create(DBFile file, Person person, DataSource ds) Creates a new DBFileOpened record for the given parameters, does not save the data source.
Contact	findContact(java.lang.String... args) The contact who opened the file.
DBFile	findFile(java.lang.String... args) the file that the user opened/viewed.
Contact	getContact(java.lang.String... args)
DBFile	getFile(java.lang.String... args)
DBFileOpened	setContact(com.aspc.dal.dbobj.contact.Contact value, java.lang.String... args)
DBFileOpened	setFile(com.aspc.dal.file.DBFile value, java.lang.String... args)

Methods inherited from class com.aspc.DBObj.DBUserAction

create, findKey, findPerson, findSession, getID, getPerson, getSession, getTime, makeQuery, setID, setPerson, setSession, setTime

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetDerivedGlobalKey, extGetDerivedValue, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateField, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeSearchPlan, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

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

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

records when a user has viewed a file. It is sufficient for a user to have opened a file to determine that the user has viewed the file.

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

records when a user has viewed a file. It is sufficient for a user to have opened a file to determine that the user has viewed the file.

Constructor Detail

DBFileOpened

public DBFileOpened(DBClass def,
                    DataSource ds)
             throws java.lang.Exception

Creates a new DBFileOpened object

Parameters:

def - the class definition

ds - the data source

Throws:

java.lang.Exception - a serious problem

Method Detail

getContact

@CheckReturnValue
 @Nullable
public Contact getContact(java.lang.String... args)

findContact

@CheckReturnValue
 @Nonnull
public final Contact findContact(java.lang.String... args)
                                                      throws NotFoundException

The contact who opened the file.
Can be person or a business

--> Contact (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Person/Business

Throws:

NotFoundException - Contact was not found

setContact

@Nonnull
public DBFileOpened setContact(com.aspc.dal.dbobj.contact.Contact value,
                                        java.lang.String... args)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getFile

@CheckReturnValue
 @Nullable
public DBFile getFile(java.lang.String... args)

findFile

@CheckReturnValue
 @Nonnull
public final DBFile findFile(java.lang.String... args)
                                                  throws NotFoundException

the file that the user opened/viewed.

--> DBFile (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

File

Throws:

NotFoundException - DBFile was not found

setFile

@Nonnull
public DBFileOpened setFile(com.aspc.dal.file.DBFile value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

create

public static DBFileOpened create(DBFile file,
                                  Person person,
                                  DataSource ds)
                           throws java.lang.Exception

Creates a new DBFileOpened record for the given parameters, does not save the data source.

Parameters:

ds - the datasource to use

file - the file that was opened

person - the person that opened the file

Returns:

DBFileOpened the newly created record

Throws:

java.lang.Exception - a serious problem

create

public static DBFileOpened create(DBFile file,
                                  Contact contact,
                                  DataSource ds)
                           throws java.lang.Exception

Creates a new DBFileOpened record for the given parameters, does not save the data source.

Parameters:

ds - the datasource to use

file - the file that was opened

contact - the contact that opened the file

Returns:

DBFileOpened the newly created record

Throws:

java.lang.Exception - a serious problem