rejectTimeSheet

Purpose

Reject an existing time sheet object in PPM.

Function

This operation updates the status of all the lines of an existing time sheet to "rejected," and the status of the time sheet to be "in-rework."

Before this operation, the status of the time sheet must be "pending-approval."

The user performing this operation must have the permission to reject this particular time sheet, meaning that the user must meet the following conditions:

• Have the Time Mgmt: Edit Time Sheets access grant.

• Be one of the following:

  • The time sheet line approver.

  • The delegate of the time sheet line approver.

An additional field this operation updates is the Actual Approver, which is set to null.

Input

The ID of the time sheet that you want to reject.

Return

An object of TimeSheetBean, with all the fields completed.

Java Interface

RejectTimeSheetResponseDocument rejectTimeSheet(RejectTimeSheetDocument in)

Parameters	Description
RejectTimeSheetDocument	Wrapper for TimeSheetBean. See the following example for the construction.
RejectTimeSheetResponseDocument	Wrapper for TimeSheetBean. See the following example on how to retrieve the bean.

Java Examples

Example: reject an existing time sheet.

TimeSheetBean createdTimeSheetBean = null;
    public void testRejectTimeSheet() {
        System.out.println("testRejectTimeSheet started ...");
        try {
            if(createdTimeSheetBean == null)
                testSubmitTimeSheet();

            TimeServiceStub stub = new TimeServiceStub(ctx,
WSURL);
            RejectTimeSheetDocument rejectTimeSheetDocument =
RejectTimeSheetDocument.Factory.newInstance();
            TimeSheetBean rejectTimeSheetBean =
rejectTimeSheetDocument.addNewRejectTimeSheet().addNewTimeSheet
Bean();

rejectTimeSheetBean.setTimeSheetId(createdTimeSheetBean.getTime
SheetId());

rejectTimeSheetBean.setResourceId(createdTimeSheetBean.getResou
rceId());

rejectTimeSheetBean.setPeriodId(createdTimeSheetBean.getPeriodI
d());
            TimeSheetStatus timeSheetStatus =
rejectTimeSheetBean.addNewState();
            timeSheetStatus.setCode(new BigInteger("2"));
            timeSheetStatus.setMeaning("pending-approval");
            TimeSheetLineBean timeSheetLineBean =
rejectTimeSheetBean.addNewTimeSheetLines();

timeSheetLineBean.setTimeSheetLineId(createdTimeSheetBean.getTi
meSheetLinesArray(0).getTimeSheetLineId());

timeSheetLineBean.setWorkItemId(createdTimeSheetBean.getTimeShe
etLinesArray(0).getWorkItemId());

timeSheetLineBean.setWorkItemSetId(createdTimeSheetBean.getTime
SheetLinesArray(0).getWorkItemSetId());

timeSheetLineBean.setWorkItemType(createdTimeSheetBean.getTimeS
heetLinesArray(0).getWorkItemType());
           TimeActualsBean timeActualsBean1 =
timeSheetLineBean.addNewTimeActualsList();
           timeActualsBean1.setTotalsFlag(true);
           timeActualsBean1.setEffortsListArray(new double[]
{1,2,3,4,5,0,0,1,2,3,4,5,0,0,10});

           TimeActualsBean timeActualsBean2 =
timeSheetLineBean.addNewTimeActualsList();
           timeActualsBean2.setTotalsFlag(false);
           timeActualsBean2.setEffortsListArray(new double[]
{1,2,3,4,5,0,0,1,2,3,4,5,0,0,10});

           RejectTimeSheetResponseDocument response =
stub.rejectTimeSheet(rejectTimeSheetDocument);
           TimeSheetBean returnTimeSheet =
response.getRejectTimeSheetResponse().getReturn();
            System.out.println("Time Sheet was rejected " +
returnTimeSheet.getTimeSheetId());
      }
      catch(Exception e) {
          e.printStackTrace();
      }
      System.out.println("testRejectTimeSheet completed");
   }

Errors and Exceptions

When an error occurs on this operation, you will receive a description of the root cause in the log or in the response message.

The server log file content is similar to the following:

Exception in thread "main" org.apache.axis2.AxisFault: [root cause description] 

Response message:

<exception:exceptionDetails xmlns:exception="http://
www.mercury.com/ppm/ws/exception">
<exception:detail>[root cause description] </exception:detail>
</exception:exceptionDetails>

Possible root cause descriptions:

Message Code	Message	Cause(s)	Possible Corrective Action
ex.cannotRejectTimesheet	User cannot reject Timesheet	You may not have the required access grant or Time Management License.	Check the user licenses and privileges (access grants).
ex.timesheetCannotbeRejected	Timesheet is not in pending approval state, it cannot be rejected	You try to reject a time sheet that is not pending approval.	Check the state of the time sheet that you are trying to reject.
ex.timesheetNullCannotbeRejected	Timesheet is null, cannot be rejected	Time sheet ID is invalid, or database might be corrupt.	Check the validity of the time sheet ID.
ex.tsIncorrectRejectStatus	This timesheet can not be rejected as timesheet status is approved	Time sheet status is incorrect to reject	Perform the getTimeSheet operation to check the time sheet status, and then perform other appropriate operations.