readProgram

Purpose

This operation reads a program in PPM Center.

Function

This operation reads a program and the related information, identified by the program ID.

To perform this operation, the user must have one of the following access grants:

  • View Programs

  • Edit Programs

  • Edit All Programs

Related Information

Operation: createProgram

Input

Program ID

Return

A ProgramInfo object.

Java Examples

ProgramServiceStub stub = new ProgramServiceStub(ctx, WSURL);
ReadProgramDocument doc =
ReadProgramDocument.Factory.newInstance();
ReadProgram readProgram = doc.addNewReadProgram();
readProgram.setProgramId(programId);
ReadProgramResponseDocument responseDoc =
stub.readProgram(doc);
return responseDoc.getReadProgramResponse().getProgram();

Errors and Exceptions

Possible root cause descriptions:

Exception/Message Code

Message

Cause(s)

Possible Corrective Action

ObjectNotFoundException

No program found

The program ID or name is invalid.

Validate the program ID or name.

AuthorizationException

You do not have the privilege to take this action. Please consult your PPM Administrator.

The user has no access granted to read programs.

Grant the appropriate access to the user. For more information, see Function