com.ibm.rpm.timesheet.containers
SummaryTimesheet

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.timesheet.containers.AbstractTimesheet
   extended bycom.ibm.rpm.timesheet.containers.SummaryTimesheet

SummaryTimesheet
Extends: com.ibm.rpm.timesheet.containers.AbstractTimesheet
Child objects: None

Related scope: com.ibm.rpm.timesheet.scope.SummaryTimesheetScope

The SummaryTimesheet object is used to report time against specific TaskAssignments. SummaryTimesheet objects are automatically deleted when their parent is deleted, they cannot be deleted otherwise.

Two steps must be taken before creating a SummaryTimesheet:

  1. The project has to be published to the team (project.setPublished(ProjectPublishedType.ToTeam).
  2. The proposed dates of the project must be copied to planned dates using the Application Interface's method copyProposedToPlan(sessionID, workElement, workElementScope).

Once a SummaryTimesheet is submitted for approval, it can no longer be modified, unless it has been rejected by the manager. In addition, the SummaryTimesheet object cannot be modified if the task has been broken into steps.

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: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

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 regularFriday, regularMonday, regularSaturday, regularSunday, regularThursday, regularTuesday, and regularWednesday.

xsd:double totalSpecial
   

Total special (overtime) hours worked in the week. The value of this field is the summation of specialFriday, specialMonday, specialSaturday, specialSunday, specialThursday, specialTuesday, and specialWednesday.

xsd:double totalWeek
   Total hours worked in the week. The value of this field is the summation of totalRegular and totalSpecial.
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

approvalStatus


TimesheetApprovalStatus approvalStatus
Determines if summary timesheet has been submitted, approved, or rejected.

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.


costPerHour


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.

Read-only behavior: The value of this field is read only.


expectedWorkPerWeek


xsd:double  expectedWorkPerWeek
The expected amount of work per week, in hours.

Read-only behavior: The value of this field is read only.


forecastFinishDate


xsd:dateTime  forecastFinishDate
The forecasted finish date.

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.


forecastStartDate


xsd:dateTime  forecastStartDate
The forecasted start date.

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.


project


GenericProject project
The project related to the task assignment for which the summary timesheet was created.

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.


resource


Resource resource
The resource related to the task assignment for which the summary timesheet was created.

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.


sellingRatePerHour


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.

Read-only behavior: The value of this field is read only.


specialCostPerHour


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.

Read-only behavior: The value of this field is read only.


specialSellingRatePerHour


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.

Read-only behavior: The value of this field is read only.


taskAssignment


GenericTaskAssignment taskAssignment
The task assignment for which the summary timesheet was created.

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.


timeCode1


TimeCode timeCode1
The first time code of the summary timesheet.

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 Time Codes I category and it must be assigned to the project.

Read-only: This field is read-only when the task has been broken into steps.


timeCode2


TimeCode timeCode2
The second time code of the summary timesheet.

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 Time Codes II category and it must be assigned to the project.

Read-only: This field is read-only when the task has been broken into steps.


totalRegular


xsd:double  totalRegular

Total regular hours worked in the week. The value of this field is the summation of regularFriday, regularMonday, regularSaturday, regularSunday, regularThursday, regularTuesday, and regularWednesday.

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).


totalSpecial


xsd:double  totalSpecial

Total special (overtime) hours worked in the week. The value of this field is the summation of specialFriday, specialMonday, specialSaturday, specialSunday, specialThursday, specialTuesday, and specialWednesday.

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).


totalWeek


xsd:double  totalWeek
Total hours worked in the week. The value of this field is the summation of totalRegular and totalSpecial.

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).


workElement


WorkElement workElement
The work element related to the task assignment for which the summary timesheet was created.

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

contextName


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.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


deleted


xsd:boolean  deleted
If the value of this field is set to true, then the RPMObject will be deleted when performing a save.

Read-only behavior: The value of this field is read only.

X-Path availability: This field doesn't support X-Path queries.


ID


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.

Read-only behavior: The value of this field is read only.


parent


RPMObject parent
Must be null.

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.


regularFriday


xsd:double  regularFriday
The number of regular hours worked on that day.

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).


regularMonday


xsd:double  regularMonday
The number of regular hours worked on that day.

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).


regularSaturday


xsd:double  regularSaturday
The number of regular hours worked on that day.

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).


regularSunday


xsd:double  regularSunday
The number of regular hours worked on that day.

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).


regularThursday


xsd:double  regularThursday
The number of regular hours worked on that day.

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).


regularTuesday


xsd:double  regularTuesday
The number of regular hours worked on that day.

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).


regularWednesday


xsd:double  regularWednesday
The number of regular hours worked on that day.

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).


specialFriday


xsd:double  specialFriday
The number of special hours (overtime) worked on that day.

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).


specialMonday


xsd:double  specialMonday
The number of special hours (overtime) worked on that day.

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).


specialSaturday


xsd:double  specialSaturday
The number of special hours (overtime) worked on that day.

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).


specialSunday


xsd:double  specialSunday
The number of special hours (overtime) worked on that day.

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).


specialThursday


xsd:double  specialThursday
The number of special hours (overtime) worked on that day.

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).


specialTuesday


xsd:double  specialTuesday
The number of special hours (overtime) worked on that day.

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).


specialWednesday


xsd:double  specialWednesday
The number of special hours (overtime) worked on that day.

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).


summaryNotes


xsd:string  summaryNotes
The note of the timesheet.

Maximum: The maximum length for this field is 255 characters.


weekOf


xsd:dateTime  weekOf
The week of the timesheet.

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.