com.ibm.rpm.wbs.containers
Opportunity

com.ibm.rpm.framework.RPMObject
  extended bycom.ibm.rpm.wbs.containers.Opportunity

Opportunity
Extends: com.ibm.rpm.framework.RPMObject
Child objects: None

Opportunity allows the project manager to enter the future client opportunity data.

Parent is mandatory, allowed parent types are Proposal, Project, and WorkOrganization.

The checkout mode type is: Parent

Supported API Calls: Primary key: The following fields are required when using the loadFromID and loadArrayFromID methods:

ID

Related code samples :

Java

C#

Field Summary
xsd:int benefitBeginsMonths
   The estimated number of months before beginning to realize benefits or revenue as defined in the project description view.
xsd:int benefitDurationMonths
   The ballpark estimate of the duration to realize profit or benefit as defined in the project description view.
xsd:string contactNumber
   The opportunity contact number.
xsd:string contactType
   The opportunity contact type.
xsd:string customerNumber
   The opportunity customer number.
xsd:string externalClient
   The name of an external customer as defined in the project description view.
xsd:dateTime forecastClosed
   The forecast close date for awarding of the project.
xsd:string opportunityOwner
   The opportunity owner
xsd:string opportunityTrackingNumber
   The opportunity tracking number
xsd:double orderOfMagnitudeCost
   The ballpark cost as defined in the project description view.
xsd:double orderOfMagnitudeGPSavingsPercent
   The ballpark gross profìt percentage as defined in the project description view.

This field is read-only.

Field calculation: 100 - (orderOfMagnitudeCost / orderOfMagnitudeRevenueBenefits * 100)

xsd:double orderOfMagnitudeRevenueBenefits
   The ballpark revenue/benefits as defined in the project description view.
xsd:dateTime pursuitFinish
   The estimated pursuit finish date for the project.
xsd:dateTime pursuitStart
   The estimated pursuit start date for the project.

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
   The parent of the RPMObject.

Field Detail

benefitBeginsMonths


xsd:int  benefitBeginsMonths
The estimated number of months before beginning to realize benefits or revenue as defined in the project description view.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 200.

Null value: This field may never be null during updates.

Default value: This default value is 0.


benefitDurationMonths


xsd:int  benefitDurationMonths
The ballpark estimate of the duration to realize profit or benefit as defined in the project description view.

Minimum: The minimum value for this field is 0.

Maximum: The maximum value for this field is 200.

Null value: This field may never be null during updates.

Default value: This default value is 0.


contactNumber


xsd:string  contactNumber
The opportunity contact number.

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

Validation: The field must contain a valid telephone number.


contactType


xsd:string  contactType
The opportunity contact type.

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


customerNumber


xsd:string  customerNumber
The opportunity customer number.

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


externalClient


xsd:string  externalClient
The name of an external customer as defined in the project description view.

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


forecastClosed


xsd:dateTime  forecastClosed
The forecast close date for awarding of the project.

Validation: The year, month and day values will be used by this field.


opportunityOwner


xsd:string  opportunityOwner
The opportunity owner

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


opportunityTrackingNumber


xsd:string  opportunityTrackingNumber
The opportunity tracking number

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


orderOfMagnitudeCost


xsd:double  orderOfMagnitudeCost
The ballpark cost as defined in the project description view.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.

Null value: This field may never be null during updates.

Default value: This default value is 0.00.


orderOfMagnitudeGPSavingsPercent


xsd:double  orderOfMagnitudeGPSavingsPercent
The ballpark gross profìt percentage as defined in the project description view.

This field is read-only.

Field calculation: 100 - (orderOfMagnitudeCost / orderOfMagnitudeRevenueBenefits * 100)

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


orderOfMagnitudeRevenueBenefits


xsd:double  orderOfMagnitudeRevenueBenefits
The ballpark revenue/benefits as defined in the project description view.

Minimum: The minimum value for this field is 0.00.

Maximum: The maximum value for this field is 9999999999999.99.

Null value: This field may never be null during updates.

Default value: This default value is 0.00.


pursuitFinish


xsd:dateTime  pursuitFinish
The estimated pursuit finish date for the project.

Validation: The year, month and day values will be used by this field.


pursuitStart


xsd:dateTime  pursuitStart
The estimated pursuit start date for the project.

Validation: The year, month and day values will be used by this field.


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
The parent of the RPMObject.

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.

Valid types:
com.ibm.rpm.wbs.containers.Project
com.ibm.rpm.wbs.containers.Proposal
com.ibm.rpm.wbs.containers.WorkOrganization