com.ibm.rpm.timesheet.containers
Step

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.timesheet.containers.GenericStep
   extended bycom.ibm.rpm.timesheet.containers.Step

Step
Extends: com.ibm.rpm.timesheet.containers.GenericStep
Child objects: None

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

When a task is large or complex, effort can be split into several smaller task steps so that time can be entered separately against each step. Once a task is broken into steps, the SummaryTimesheet object cannot be modified.

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.

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
xsd:boolean alwaysAvailable
    Flag that indicates if the step is available on all weeks.
xsd:boolean billable
    This flag indicates if this timesheet step is billable.
xsd:double EETC
    The estimated time to complete.
xsd:boolean ETCChanged
    This flag indicates if the EETC was changed.
StepTimesheet[] stepTimesheets
    The the list of associated timesheet steps.
xsd:double weight
    The weight of the step in percentage.

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.
xsd:string name
    The name of the GenericStep.
RPMObject parent
   Must be null.
GenericProject project
    The project related to the task assignment for which the generic step was created.
Resource resource
    The resource related to the task assignment for which the generic step was created.
TaskAssignment taskAssignment
    The task assignment for which the generic step was created.
TimeCode timeCode1
    The first timecode associated with the timesheet entry.
TimeCode timeCode2
    The second timecode associated with the timesheet entry.
WorkElement workElement
    work element related to the task assignment for which the generic step was created.

Field Detail

alwaysAvailable


xsd:boolean  alwaysAvailable
Flag that indicates if the step is available on all weeks.

billable


xsd:boolean  billable
This flag indicates if this timesheet step is billable.

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


EETC


xsd:double  EETC
The estimated time to complete.

Minimum: The minimum value for this field is 0.

Rounding: The value must be rounded to the nearest 0.25 (time is in 15 minutes increment).


ETCChanged


xsd:boolean  ETCChanged
This flag indicates if the EETC was changed.

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


stepTimesheets


StepTimesheet[] stepTimesheets
The the list of associated timesheet steps.

Null value: This field must have a value at creation time.

Scoping: This field will be used by the API if the scope field timesheets is enabled.

Relationship: This field is a composite relationship. Deleting the current object will delete the object stored in this field.


weight


xsd:double  weight
The weight of the step in percentage.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 100.

Validation: The summation of the weight of all Steps for a TaskAssignment cannot exceed 100.


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.


name


xsd:string  name
The name of the GenericStep.

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


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.


project


GenericProject project
The project related to the task assignment for which the generic step 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 generic step 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.


taskAssignment


TaskAssignment taskAssignment
The task assignment for which the generic step was created.

Null value: This field must have a value at creation time.

Scoping: This field will be used by the API if the scope field taskAssignment is enabled.

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

Relationship: This field is a reference relationship.


timeCode1


TimeCode timeCode1
The first timecode associated with the timesheet entry.

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.


timeCode2


TimeCode timeCode2
The second timecode associated with the timesheet entry.

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.


workElement


WorkElement workElement
work element related to the task assignment for which the generic step 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.