org.kuali.kpme.tklm.api.time.clocklog

Interface ClockLogContract

All Superinterfaces:

org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.PersistableBusinessObject, Serializable, org.kuali.rice.core.api.mo.common.Versioned

All Known Implementing Classes:

ClockLog

public interface ClockLogContract
extends org.kuali.rice.krad.bo.PersistableBusinessObject

ClockLogContract interface

Method Summary

Methods

Modifier and Type	Method and Description
String	getClockAction() The clockAction associated with the ClockLog
org.joda.time.DateTime	getClockDateTime() The clockTimestamp associated with the ClockLog
Timestamp	getClockTimestamp() The clockTimestamp associated with the ClockLog
String	getClockTimestampTimezone() The clockTimestampTimezone associated with the ClockLog
String	getDocumentId() The documentId associated with the ClockLog
String	getIpAddress() The ipAddress associated with the ClockLog
JobContract	getJob() The Job object associated with the ClockLog
Long	getJobNumber() The jobNumber associated with the ClockLog
String	getNextValidClockAction() The next valid clock action associated with the ClockLog
org.kuali.rice.kim.api.identity.Person	getPrincipal() The Person object associated with the ClockLog
String	getPrincipalId() The principalId associated with the ClockLog
Long	getTask() The task associated with the ClockLog
TaskContract	getTaskObj() The Task object associated with the ClockLog
Timestamp	getTimestamp() The timestamp associated with the ClockLog
String	getTkClockLogId() The primary key of a ClockLog entry saved in a database
String	getUserPrincipalId() TODO: Is this field needed?? The userPrincipalId associated with the ClockLog
Long	getWorkArea() The workArea associated with the ClockLog
WorkAreaContract	getWorkAreaObj() The WorkArea object associated with the ClockLog
boolean	isClockedByMissedPunch() The clockedByMissedPunch flag of the MissedPunch
boolean	isUnapprovedIP() The unapprovedIP flag of the MissedPunch

Methods inherited from interface org.kuali.rice.krad.bo.PersistableBusinessObject

buildListOfDeletionAwareLists, getExtension, isNewCollectionRecord, linkEditableUserFields, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from interface org.kuali.rice.krad.bo.BusinessObject

refresh

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Methods inherited from interface org.kuali.rice.core.api.mo.common.Versioned

getVersionNumber

Methods inherited from interface org.kuali.rice.core.api.mo.common.GloballyUnique

getObjectId

Method Detail

getTkClockLogId

String getTkClockLogId()

The primary key of a ClockLog entry saved in a database

tkClockLogId of a ClockLog

Returns:

tkClockLogId for ClockLog

getDocumentId

String getDocumentId()

The documentId associated with the ClockLog

documentId of a ClockLog

Returns:

documentId for ClockLog

getPrincipalId

String getPrincipalId()

The principalId associated with the ClockLog

principalId of a ClockLog

Returns:

principalId for ClockLog

getJobNumber

Long getJobNumber()

The jobNumber associated with the ClockLog

jobNumber of a ClockLog

Returns:

jobNumber for ClockLog

getClockTimestamp

Timestamp getClockTimestamp()

The clockTimestamp associated with the ClockLog

clockTimestamp of a ClockLog

Returns:

clockTimestamp for ClockLog

getClockDateTime

org.joda.time.DateTime getClockDateTime()

The clockTimestamp associated with the ClockLog

clockTimestamp of a ClockLog

Returns:

new DateTime(clockTimestamp) for ClockLog

getClockAction

String getClockAction()

The clockAction associated with the ClockLog

clockAction of a ClockLog

Returns:

clockAction for ClockLog

getIpAddress

String getIpAddress()

The ipAddress associated with the ClockLog

ipAddress of a ClockLog

Returns:

ipAddress for ClockLog

getUserPrincipalId

String getUserPrincipalId()

TODO: Is this field needed?? The userPrincipalId associated with the ClockLog

userPrincipalId of a ClockLog

Returns:

userPrincipalId for ClockLog

getTimestamp

Timestamp getTimestamp()

The timestamp associated with the ClockLog

timestamp of a ClockLog

Returns:

timestamp for ClockLog

getClockTimestampTimezone

String getClockTimestampTimezone()

The clockTimestampTimezone associated with the ClockLog

clockTimestampTimezone of a ClockLog

Returns:

clockTimestampTimezone for ClockLog

getNextValidClockAction

String getNextValidClockAction()

The next valid clock action associated with the ClockLog

If clockAction is CI (clock in), the next action is CO (clock out). If clockAction is CO, the next action is CI. If clockAction is LI (lunch in), the next action is LO (lunch out). If clockAction is LO, the next action is LI.

Returns:

next valid clock action for ClockLog

getJob

JobContract getJob()

The Job object associated with the ClockLog

job of a ClockLog

Returns:

job for ClockLog

getWorkAreaObj

WorkAreaContract getWorkAreaObj()

The WorkArea object associated with the ClockLog

workAreaObj of a ClockLog

Returns:

workAreaObj for ClockLog

getTaskObj

TaskContract getTaskObj()

The Task object associated with the ClockLog

taskObj of a ClockLog

Returns:

taskObj for ClockLog

getWorkArea

Long getWorkArea()

The workArea associated with the ClockLog

workArea of a ClockLog

Returns:

workArea for ClockLog

getTask

Long getTask()

The task associated with the ClockLog

task of a ClockLog

Returns:

task for ClockLog

getPrincipal

org.kuali.rice.kim.api.identity.Person getPrincipal()

The Person object associated with the ClockLog

principal of a ClockLog

Returns:

principal for ClockLog

isClockedByMissedPunch

boolean isClockedByMissedPunch()

The clockedByMissedPunch flag of the MissedPunch

clockedByMissedPunch flag of a MissedPunch

Returns:

Y if clocked by missed punch, N if not

isUnapprovedIP

boolean isUnapprovedIP()

The unapprovedIP flag of the MissedPunch

unapprovedIP flag of a MissedPunch

Returns:

Y if it's an approved ip, N if not