FRAMES NO FRAMES |
com.ibm.rpm.framework.RPMObjectcom.ibm.rpm.timesheet.containers.AbstractTimesheet
com.ibm.rpm.timesheet.containers.SummaryTimesheet
Related scope: com.ibm.rpm.timesheet.scope.SummaryTimesheetScope
The SummaryTimesheet object is used to report
time against specific TaskAssignments.
Two steps must be taken before creating a SummaryTimesheet:
Once a
Checking out (or in) an instance of this container checks out (or in) all timesheet objects assigned to the same resource for the resource that is currently logged in.
Delete restrictions: This object can't be deleted.
Supported API Calls:The following fields are required when using the loadFromId and loadArrayFromID methods :
Related code samples :
Java
C#
Field Summary | |
TimesheetApprovalStatus
|
approvalStatus
Determines if summary timesheet has been submitted, approved, or rejected. |
xsd:double
|
costPerHour
The resource's regular cost rate for this specific week. This is the special (overtime) cost rate that was specified in task assignment at the time that this summary timesheet was created. |
xsd:double
|
expectedWorkPerWeek
The expected amount of work per week, in hours. |
xsd:dateTime
|
forecastFinishDate
The forecasted finish date. |
xsd:dateTime
|
forecastStartDate
The forecasted start date. |
GenericProject
|
project
The project related to the task assignment for which the summary timesheet was created. |
Resource
|
resource
The resource related to the task assignment for which the summary timesheet was created. |
xsd:double
|
sellingRatePerHour
The resource's regular selling rate for this specific week. This is the regular selling rate that was specified in task assignment at the time that this summary timesheet was created. |
xsd:double
|
specialCostPerHour
The resource's special (overtime) cost rate for this specific week. This is the special (overtime) cost rate that was specified in task assignment at the time that this summary timesheet was created. |
xsd:double
|
specialSellingRatePerHour
The resource's special (overtime) selling rate for this specific week. This is the special (overtime) selling rate that was specified in task assignment at the time that this summary timesheet was created. |
GenericTaskAssignment
|
taskAssignment
The task assignment for which the summary timesheet was created. |
TimeCode
|
timeCode1
The first time code of the summary timesheet. |
TimeCode
|
timeCode2
The second time code of the summary timesheet. |
xsd:double
|
totalRegular
Total
regular hours worked in the week. The value of this field is the summation
of |
xsd:double
|
totalSpecial
Total
special (overtime) hours worked in the week. The value of this field is the
summation of |
xsd:double
|
totalWeek
Total hours worked in the week. The value of this field is the summation of |
WorkElement
|
workElement
The work element related to the task assignment for which the summary timesheet was created. |
Inherited Field Summary | |
xsd:string
|
contextName
The context name identifies which section of the Web Services API the object belongs to. This value of this field is generated automatically when creating the RPMObject. |
xsd:boolean
|
deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save. |
xsd:string
|
ID
The unique ID of the RPMObject. If the value of this field is set to null, the save operation will generate the ID automatically when creating the RPMObject. If an ID is specified, then the save operation will attempt to update an existing RPMObject. |
RPMObject
|
parent
Must be null. |
xsd:double
|
regularFriday
The number of regular hours worked on that day. |
xsd:double
|
regularMonday
The number of regular hours worked on that day. |
xsd:double
|
regularSaturday
The number of regular hours worked on that day. |
xsd:double
|
regularSunday
The number of regular hours worked on that day. |
xsd:double
|
regularThursday
The number of regular hours worked on that day. |
xsd:double
|
regularTuesday
The number of regular hours worked on that day. |
xsd:double
|
regularWednesday
The number of regular hours worked on that day. |
xsd:double
|
specialFriday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialMonday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialSaturday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialSunday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialThursday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialTuesday
The number of special hours (overtime) worked on that day. |
xsd:double
|
specialWednesday
The number of special hours (overtime) worked on that day. |
xsd:string
|
summaryNotes
The note of the timesheet. |
xsd:dateTime
|
weekOf
The week of the timesheet. |
Field Detail |
Scoping: This field will be used by the API if the scope field approvalStatus is enabled.
Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Validation: The year, month and day values will be used by this field.
Read-only: This field is read-only and null when the TaskAssignment has been completed.
Validation: The year, month and day values will be used by this field.
Read-only: This field is read-only and null when there are actual times reported in the timesheet.
Scoping: This field will be used by the API if the scope field project is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field resource is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Read-only behavior: The value of this field is read only.
Null value: This field may never be null.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Scoping: This field will be used by the API if the scope field timeCodes is enabled.
Relationship: This field is a reference relationship.
Validation:
The
time code must belong to
Read-only: This field is read-only when the task has been broken into steps.
Scoping: This field will be used by the API if the scope field timeCodes is enabled.
Relationship: This field is a reference relationship.
Validation:
The
time code must belong to
Read-only: This field is read-only when the task has been broken into steps.
Total
regular hours worked in the week. The value of this field is the summation
of
Read-only behavior: The value of this field is read only.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Total
special (overtime) hours worked in the week. The value of this field is the
summation of
Read-only behavior: The value of this field is read only.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Read-only behavior: The value of this field is read only.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Scoping: This field will be used by the API if the scope field workElement is enabled.
Read-only behavior: The value of this field is read only.
Relationship: This field is a reference relationship.
Inherited Field Detail |
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
X-Path availability: This field doesn't support X-Path queries.
Read-only behavior: The value of this field is read only.
Scoping: This field will be used by the API if the scope field parent is enabled.
Read-only behavior: The value of this field is read only after the object was created.
Relationship: This field is a reference relationship.
X-Path availability: This field doesn't support X-Path queries.
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Minimum: The minimum value for this field is 0.
Maximum: The maximum value for this field is 255.
Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).
Maximum: The maximum length for this field is 255 characters.
Null value: This field may never be null.
Validation: The value of this field can't be changed for an existing Timesheet because it is a part of the primary key.