com.aspc.Layers.aspc_app.TimeSheet

Class TimeEntry

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.Layers.aspc_app.TimeSheet.TimeEntry

All Implemented Interfaces:

SecondaryCacheGroup

public class TimeEntry
extends DBObject

TimeEntry stores details about time spent on an activity Each TimeEntry is automatically assigned to a TimeSheet which holds liks to all TimeEntries for the week
Generic DBObject.

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

Since:

8 May 2002

Author:

Jason McGrath

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 TimeEntry
static java.lang.String	DBCLASS_NAME TimeEntry

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
TimeEntry(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static TimeEntry	create(MutableDataSource mds) Make a new instance of this class.
protected void	eventFieldUpdated(DBField field, java.lang.Object previous, GlobalKey previousKey, FldParams params) update dependent fields.
protected void	extCheckCreateAccess() Additional access checking for create access of this object.
protected void	extCheckDeleteAccess() Additional access checking for delete access of this object.
protected void	extCheckModifyAccess(DBField field) Additional access checking for write access of this object.
protected void	extFixUp() The extended fix up routine for known problems.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Calculate the derived value for this field.
protected void	extPreSaveRecord() OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for a particular field.
protected void	extValidateRecord(ValidationList list) Performs additional validations on this record.
Activity	findActivity(java.lang.String... args) Activity.
Person	findEmployee(java.lang.String... args) Employee.
Person	findEnteredBy(java.lang.String... args) Entered By.
InvoiceProductItem	findInvoiceItem(java.lang.String... args) invoice product item.
static TimeEntry	findKey(DataSource ds, int key) Find the target for this class by the primary key
Company	findOwnerBusUnit(java.lang.String... args) Business unit that owns this entry.
TimeSheet	findTimeSheet(java.lang.String... args) Time Sheet.
java.lang.Object	findTimeUnit(java.lang.String... args) Deprecated.
Activity	getActivity(java.lang.String... args)
double	getAdjHours(java.lang.String... args) Deprecated.
double	getCalcHours(java.lang.String... args) Deprecated.
double	getChargeAmtExTax(java.lang.String... args)
double	getChargeAmtIncTax(java.lang.String... args)
java.util.Date	getDay(java.lang.String... args)
double	getDurationInDays()
double	getDurationInHour(java.lang.String... args)
double	getDurationInHours()
double	getDurationInHours(boolean isActual)
Person	getEmployee(java.lang.String... args)
java.util.Date	getEndTime(java.lang.String... args)
Person	getEnteredBy(java.lang.String... args)
java.util.Date	getEnteredTime(java.lang.String... args)
double	getHours(java.lang.String... args)
int	getID(java.lang.String... args)
InvoiceProductItem	getInvoiceItem(java.lang.String... args)
int	getJiraWorklogId(java.lang.String... args)
java.lang.String	getNotes(java.lang.String... args)
Company	getOwnerBusUnit(java.lang.String... args)
double	getPercOfTask(java.lang.String... args)
java.util.Date	getStartTime(java.lang.String... args)
TimeSheet	getTimeSheet(java.lang.String... args)
java.lang.Object	getTimeUnit(java.lang.String... args) Deprecated.
double	getTotalCost(java.lang.String... args)
double	getTotalHours(java.lang.String... args)
boolean	isInvoiced(java.lang.String... args)
protected boolean	isModifiableWhenLocked(DBField field)
static DBQuery<TimeEntry>	makeQuery(DataSource ds) Make a new QUERY for this class.
TimeEntry	setActivity(com.aspc.dal.layers.aspc_app.task.Activity value, java.lang.String... args)
TimeEntry	setAdjHours(double value, java.lang.String... args) Deprecated.
TimeEntry	setChargeAmtExTax(double value, java.lang.String... args)
TimeEntry	setDay(java.util.Date value, java.lang.String... args)
TimeEntry	setEmployee(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
TimeEntry	setEndTime(java.util.Date value, java.lang.String... args)
TimeEntry	setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value, java.lang.String... args)
TimeEntry	setEnteredTime(java.util.Date value, java.lang.String... args)
TimeEntry	setHours(double value, java.lang.String... args)
TimeEntry	setID(int value, java.lang.String... args)
TimeEntry	setInvoiceItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value, java.lang.String... args)
TimeEntry	setJiraWorklogId(int value, java.lang.String... args)
TimeEntry	setNotes(java.lang.String value, java.lang.String... args)
TimeEntry	setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value, java.lang.String... args)
TimeEntry	setStartTime(java.util.Date value, java.lang.String... args)
TimeEntry	setTimeSheet(com.aspc.dal.layers.aspc_app.timesheet.TimeSheet value, java.lang.String... args)
TimeEntry	setTimeUnit(java.lang.Object value, java.lang.String... args) Deprecated.

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, extAutoEnterCreate, extCanDeleteDependantObject, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extGetDerivedGlobalKey, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreValidate, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, 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

TimeEntry

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

TimeEntry

Constructor Detail

TimeEntry

public TimeEntry(DBClass def,
                 DataSource dataSource)
          throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getID

@CheckReturnValue
public int getID(java.lang.String... args)

setID

@Nonnull
public TimeEntry setID(int value,
                                java.lang.String... args)
                         throws java.lang.Exception

Throws:

java.lang.Exception

getActivity

@CheckReturnValue
 @Nullable
public Activity getActivity(java.lang.String... args)

findActivity

@CheckReturnValue
 @Nonnull
public final Activity findActivity(java.lang.String... args)
                                                        throws NotFoundException

Activity.

--> Activity (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Activity

Throws:

NotFoundException - Activity was not found

setActivity

@Nonnull
public TimeEntry setActivity(com.aspc.dal.layers.aspc_app.task.Activity value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getAdjHours

@Deprecated
 @CheckReturnValue
public double getAdjHours(java.lang.String... args)

Deprecated.

setAdjHours

@Deprecated
 @Nonnull
public TimeEntry setAdjHours(double value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getCalcHours

@Deprecated
 @CheckReturnValue
public double getCalcHours(java.lang.String... args)

Deprecated.

getChargeAmtExTax

@CheckReturnValue
public double getChargeAmtExTax(java.lang.String... args)

setChargeAmtExTax

@Nonnull
public TimeEntry setChargeAmtExTax(double value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getChargeAmtIncTax

@CheckReturnValue
public double getChargeAmtIncTax(java.lang.String... args)

getDay

@CheckReturnValue
public java.util.Date getDay(java.lang.String... args)

setDay

@Nonnull
public TimeEntry setDay(java.util.Date value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getDurationInHour

@CheckReturnValue
public double getDurationInHour(java.lang.String... args)

getEmployee

@CheckReturnValue
 @Nullable
public Person getEmployee(java.lang.String... args)

findEmployee

@CheckReturnValue
 @Nonnull
public final Person findEmployee(java.lang.String... args)
                                                      throws NotFoundException

Employee.

--> Person (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEmployee

@Nonnull
public TimeEntry setEmployee(com.aspc.dal.layers.aspc_app.contact.Person value,
                                      java.lang.String... args)
                               throws java.lang.Exception

Throws:

java.lang.Exception

getEndTime

@CheckReturnValue
 @Nullable
public java.util.Date getEndTime(java.lang.String... args)

setEndTime

@Nonnull
public TimeEntry setEndTime(java.util.Date value,
                                     java.lang.String... args)
                              throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredBy

@CheckReturnValue
 @Nullable
public Person getEnteredBy(java.lang.String... args)

findEnteredBy

@CheckReturnValue
 @Nonnull
public final Person findEnteredBy(java.lang.String... args)
                                                       throws NotFoundException

Entered By.

--> Person (Integer, Mandatory, Searchable)

Parameters:

args - the optional arguments

Returns:

Contact

Throws:

NotFoundException - Person was not found

setEnteredBy

@Nonnull
public TimeEntry setEnteredBy(com.aspc.dal.layers.aspc_app.contact.Person value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getEnteredTime

@CheckReturnValue
 @Nullable
public java.util.Date getEnteredTime(java.lang.String... args)

setEnteredTime

@Nonnull
public TimeEntry setEnteredTime(java.util.Date value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

getHours

@CheckReturnValue
public double getHours(java.lang.String... args)

setHours

@Nonnull
public TimeEntry setHours(double value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getInvoiceItem

@CheckReturnValue
 @Nullable
public InvoiceProductItem getInvoiceItem(java.lang.String... args)

findInvoiceItem

@CheckReturnValue
 @Nonnull
public final InvoiceProductItem findInvoiceItem(java.lang.String... args)
                                                                     throws NotFoundException

invoice product item.

--> InvoiceProductItem (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

InvoiceProductItem

Throws:

NotFoundException - InvoiceProductItem was not found

setInvoiceItem

@Nonnull
public TimeEntry setInvoiceItem(com.aspc.dal.layers.aspc_app.invoice.InvoiceProductItem value,
                                         java.lang.String... args)
                                  throws java.lang.Exception

Throws:

java.lang.Exception

isInvoiced

@CheckReturnValue
public boolean isInvoiced(java.lang.String... args)

getJiraWorklogId

@CheckReturnValue
public int getJiraWorklogId(java.lang.String... args)

setJiraWorklogId

@Nonnull
public TimeEntry setJiraWorklogId(int value,
                                           java.lang.String... args)
                                    throws java.lang.Exception

Throws:

java.lang.Exception

getNotes

@CheckReturnValue
 @Nonnull
public java.lang.String getNotes(java.lang.String... args)

setNotes

@Nonnull
public TimeEntry setNotes(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getOwnerBusUnit

@CheckReturnValue
 @Nullable
public Company getOwnerBusUnit(java.lang.String... args)

findOwnerBusUnit

@CheckReturnValue
 @Nonnull
public final Company findOwnerBusUnit(java.lang.String... args)
                                                           throws NotFoundException

Business unit that owns this entry.

--> Business (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

Business Unit

Throws:

NotFoundException - Business was not found

setOwnerBusUnit

@Nonnull
public TimeEntry setOwnerBusUnit(com.aspc.dal.layers.aspc_app.contact.Business value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getPercOfTask

@CheckReturnValue
public double getPercOfTask(java.lang.String... args)

getStartTime

@CheckReturnValue
 @Nullable
public java.util.Date getStartTime(java.lang.String... args)

setStartTime

@Nonnull
public TimeEntry setStartTime(java.util.Date value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getTimeSheet

@CheckReturnValue
 @Nullable
public TimeSheet getTimeSheet(java.lang.String... args)

findTimeSheet

@CheckReturnValue
 @Nonnull
public final TimeSheet findTimeSheet(java.lang.String... args)
                                                          throws NotFoundException

Time Sheet.

--> TimeSheet (Integer, Searchable)

Parameters:

args - the optional arguments

Returns:

TimeSheet

Throws:

NotFoundException - TimeSheet was not found

setTimeSheet

@Nonnull
public TimeEntry setTimeSheet(com.aspc.dal.layers.aspc_app.timesheet.TimeSheet value,
                                       java.lang.String... args)
                                throws java.lang.Exception

Throws:

java.lang.Exception

getTimeUnit

@Deprecated
 @CheckReturnValue
 @Nullable
public java.lang.Object getTimeUnit(java.lang.String... args)

Deprecated.

findTimeUnit

@CheckReturnValue
 @Deprecated
 @Nonnull
public final java.lang.Object findTimeUnit(java.lang.String... args)
                                                                             throws NotFoundException

Deprecated.

Time unit for time entry.

--> ChargeUnitType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

ChargeUnitType

Throws:

NotFoundException - ChargeUnitType was not found

setTimeUnit

@Deprecated
 @Nonnull
public TimeEntry setTimeUnit(java.lang.Object value,
                                                   java.lang.String... args)
                                            throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getTotalCost

@CheckReturnValue
public double getTotalCost(java.lang.String... args)

getTotalHours

@CheckReturnValue
public double getTotalHours(java.lang.String... args)

create

@Nonnull
 @CheckReturnValue
public static TimeEntry create(@Nonnull
                                                           MutableDataSource mds)
                                                    throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<TimeEntry> makeQuery(@Nonnull
                                                                       DataSource ds)
                                                                throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static TimeEntry findKey(@Nonnull
                                                            DataSource ds,
                                                            int key)
                                                     throws NotFoundException,
                                                            java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Calculate the derived value for this field.

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The calculated value

Throws:

java.lang.Exception - A serious problem

extCheckDeleteAccess

protected void extCheckDeleteAccess()
                             throws DBAccessException

Additional access checking for delete access of this object.

Overrides:

extCheckDeleteAccess in class DBObject

Throws:

DBAccessException - No access to delete

extCheckCreateAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckCreateAccess()
                                                               throws DBAccessException

Additional access checking for create access of this object.

Overrides:

extCheckCreateAccess in class DBObject

Throws:

DBAccessException - No access to create

See Also:

DBObject.checkCreateAccess()

extCheckModifyAccess

@OverridingMethodsMustInvokeSuper
protected void extCheckModifyAccess(@Nonnull
                                                                      DBField field)
                                                               throws DBAccessException

Additional access checking for write access of this object.

Overrides:

extCheckModifyAccess in class DBObject

Parameters:

field - Can we change this field ?

Throws:

DBAccessException - No access to modify

extValidateRecord

@OverridingMethodsMustInvokeSuper
protected void extValidateRecord(@Nonnull
                                                                   ValidationList list)
                                                            throws java.lang.Exception

Performs additional validations on this record. Only ever called from MutableDataSource.

Overrides:

extValidateRecord in class DBObject

Parameters:

list - The validation list.

Throws:

java.lang.Exception - A serious problem

eventFieldUpdated

@OverridingMethodsMustInvokeSuper
protected void eventFieldUpdated(@Nonnull
                                                                   DBField field,
                                                                   @Nullable
                                                                   java.lang.Object previous,
                                                                   @Nullable
                                                                   GlobalKey previousKey,
                                                                   @Nullable
                                                                   FldParams params)
                                                            throws java.lang.Exception

update dependent fields.

Overrides:

eventFieldUpdated in class DBObject

Parameters:

field - The field updated.

previous - The previous value for this field.

previousKey - The previous key

params - The parameters used

Throws:

java.lang.Exception - a serious problem

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Additional validation for a particular field.

Overrides:

extValidateField in class DBObject

Parameters:

list - The validation list

field - The field to be validated

Returns:

The validation error

Throws:

java.lang.Exception - A serious problem

extFixUp

@OverridingMethodsMustInvokeSuper
protected void extFixUp()
                                                   throws java.lang.Exception

The extended fix up routine for known problems. This routine will be called by the method fixUp() in DBObject.

Overrides:

extFixUp in class DBObject

Throws:

java.lang.Exception - A serious problem

extPreSaveRecord

@OverridingMethodsMustInvokeSuper
protected void extPreSaveRecord()
                                                           throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE this method to add functionality to stSoftware BEFORE saving the record to the database. At this stage the final validation ( internally called by save) has NOT been performed. This is your chance to create other associated records etc. This method is called for all created and modified records NOT deleted. The database transaction has not been started yet. Your changes will NOT be rollback in case of failure.

Overrides:

extPreSaveRecord in class DBObject

Throws:

java.lang.Exception - A Serious problem

getDurationInHours

@CheckReturnValue
public double getDurationInHours()
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getDurationInHours

@CheckReturnValue
public double getDurationInHours(boolean isActual)
                                            throws java.lang.Exception

Throws:

java.lang.Exception

getDurationInDays

@CheckReturnValue
public double getDurationInDays()
                                           throws java.lang.Exception

Throws:

java.lang.Exception

isModifiableWhenLocked

@CheckReturnValue
protected boolean isModifiableWhenLocked(@Nullable
                                                           DBField field)

Parameters:

field - The field

Returns:

the value