|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.primavera.integration.client.BOBase
com.primavera.integration.client.bo.BusinessObject
com.primavera.integration.client.bo.object.WBSMilestone
public class WBSMilestone
WBS milestones are weighted milestones assigned at the WBS level that can be used for calculating performance percent complete.
For each WBS element, set the EarnedValueComputeType to be WBS_MILESTONES_PERCENT_COMPLETE, then define as many milestones as you need and assign a level of significance or weight to each of them. As progress occurs and you mark each milestone complete, the WBS element's performance percent complete is calculated based on the weight of the milestone, independent of its lower-level activities.
See Also: Quick reference of WBSMilestone fields
Constructor Summary | |
---|---|
WBSMilestone(Session session)
Class constructor specifying the Session. |
|
WBSMilestone(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
WBSMilestone(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
ObjectId |
create()
Creates this WBSMilestone object in the database. |
static ObjectId[] |
create(Session session,
WBSMilestone[] wbsmilestones)
Creates multiple WBSMilestone objects in the database. |
void |
delete()
Deletes this WBSMilestone object from the database. |
static void |
delete(Session session,
WBSMilestone[] wbsmilestones)
Deletes multiple WBSMilestone objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this WBS milestone was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this WBS milestone. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
static java.lang.String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static java.util.Set<java.lang.String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static java.lang.String[] |
getInternalDefaultLoadFields()
An internal method that should not be called directly by client code. |
boolean |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
boolean |
getIsCompleted()
Gets the flag that indicates whether the step has been completed. |
java.util.Date |
getLastUpdateDate()
Gets the date this WBS milestone was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this WBS milestone. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
java.lang.String |
getName()
Gets the name of the WBS milestone. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
java.lang.String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
java.lang.String |
getWBSCode()
Gets the short code assigned to each WBS element for identification. |
java.lang.String |
getWBSName()
Gets the name of the WBS element. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the WBS where the WBS milestone is assigned. |
double |
getWeight()
Gets the weight that is assigned to the milestone. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static WBSMilestone |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single WBSMilestone object from the database. |
static BOIterator<WBSMilestone> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple WBSMilestone objects from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
WBS |
loadWBS(java.lang.String[] fields)
Loads an associated WBS object from the database. |
void |
setIsCompleted(boolean b)
Sets the flag that indicates whether the step has been completed. |
void |
setName(java.lang.String s)
Sets the name of the WBS milestone. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setProjectObjectId(ObjectId o)
Sets the unique ID of the associated project. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setWBSObjectId(ObjectId o)
Sets the unique ID of the WBS where the WBS milestone is assigned. |
void |
setWeight(double d)
Sets the weight that is assigned to the milestone. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this WBSMilestone object in the database. |
static void |
update(Session session,
WBSMilestone[] wbsmilestones)
Updates multiple WBSMilestone objects in the database. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public WBSMilestone(Session session)
session
- the Sessionpublic WBSMilestone(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic WBSMilestone(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex) throws BusinessObjectException
session
- the SessionrowSet
- the PrmRowSet retrieved from the serveriIndex
- the row index in the PrmRowSet associated with this business object
BusinessObjectException
- if a problem occurred in the client-side business objectsMethod Detail |
---|
public ObjectId create() throws ServerException, NetworkException, BusinessObjectException
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static ObjectId[] create(Session session, WBSMilestone[] wbsmilestones) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectwbsmilestones
- array of WBSMilestone objects to create
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static WBSMilestone load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the WBSMilestone object
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static BOIterator<WBSMilestone> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the WBSMilestone objects
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void update() throws ServerException, NetworkException, BusinessObjectException
update
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void update(Session session, WBSMilestone[] wbsmilestones) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectwbsmilestones
- array of WBSMilestone objects to update
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void delete() throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static void delete(Session session, WBSMilestone[] wbsmilestones) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectwbsmilestones
- array of WBSMilestone objects to delete
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Project loadProject(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic WBS loadWBS(java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to load
ServerException
- if a problem occurred on the server-side
NetworkException
- if a problem occurred in the network layer
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setObjectId(ObjectId o) throws BusinessObjectException
setObjectId
in class BusinessObject
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getWBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getWBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getWeight() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setWeight(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsCompleted() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsCompleted(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.util.Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getLastUpdateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static java.lang.String[] getRequiredCreateFields()
public static java.lang.String[] getFilterableFields()
public static java.lang.String[] getInternalDefaultLoadFields()
public static java.lang.String[] getAllFields()
public static java.lang.String[] getInternalAllFields()
public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
public static java.lang.String[] getWritableFields()
public static java.lang.String[] getDefaultXMLExportFields()
public static java.lang.String[] getMinimumXMLExportFields()
public java.lang.String toString()
toString
in class java.lang.Object
|
Primavera Integration API 7.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |