Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class WBSMilestone

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.WBSMilestone

public class WBSMilestone
extends BusinessObject

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

WBSMilestone

public WBSMilestone(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

WBSMilestone

public WBSMilestone(Session session,
                    ObjectId objId)
             throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

WBSMilestone

public WBSMilestone(Session session,
                    com.primavera.infr.db.PrmRowSet rowSet,
                    int iIndex)
             throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this WBSMilestone object in the database.

Returns:
ObjectId the unique ID of the newly created WBSMilestone object
Throws:
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 objects

create

public static ObjectId[] create(Session session,
                                WBSMilestone[] wbsmilestones)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple WBSMilestone objects in the database.

Parameters:
session - the Session object
wbsmilestones - array of WBSMilestone objects to create
Returns:
ObjectId[] the array of unique IDs of newly created WBSMilestone objects
Throws:
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 objects

load

public static WBSMilestone load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Loads a single WBSMilestone object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the WBSMilestone object
Returns:
WBSMilestone the WBSMilestone object
Throws:
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 objects

load

public static BOIterator<WBSMilestone> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple WBSMilestone objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the WBSMilestone objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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 objects

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this WBSMilestone object in the database.

Overrides:
update in class BOBase
Throws:
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 objects

update

public static void update(Session session,
                          WBSMilestone[] wbsmilestones)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple WBSMilestone objects in the database.

Parameters:
session - the Session object
wbsmilestones - array of WBSMilestone objects to update
Throws:
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 objects

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this WBSMilestone object from the database.

Overrides:
delete in class BOBase
Throws:
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 objects

delete

public static void delete(Session session,
                          WBSMilestone[] wbsmilestones)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple WBSMilestone objects from the database.

Parameters:
session - the Session object
wbsmilestones - array of WBSMilestone objects to delete
Throws:
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 objects

loadProject

public Project loadProject(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated Project object from the database.

Parameters:
fields - fields to load
Returns:
Project the Project object
Throws:
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 objects

loadWBS

public WBS loadWBS(java.lang.String[] fields)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Loads an associated WBS object from the database.

Parameters:
fields - fields to load
Returns:
WBS the WBS object
Throws:
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 objects

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWBSObjectId

public ObjectId getWBSObjectId()
                        throws BusinessObjectException
Gets the unique ID of the WBS where the WBS milestone is assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field WBSObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setWBSObjectId

public void setWBSObjectId(ObjectId o)
                    throws BusinessObjectException
Sets the unique ID of the WBS where the WBS milestone is assigned. This field is automatically loaded by default whenever this type of business object is loaded from the database. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWBSCode

public java.lang.String getWBSCode()
                            throws BusinessObjectException
Gets the short code assigned to each WBS element for identification. Each WBS element is uniquely identified by concatenating its own code together with its parents' codes.

Returns:
the value in the field WBSCode
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWBSName

public java.lang.String getWBSName()
                            throws BusinessObjectException
Gets the name of the WBS element.

Returns:
the value in the field WBSName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectObjectId

public ObjectId getProjectObjectId()
                            throws BusinessObjectException
Gets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field ProjectObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setProjectObjectId

public void setProjectObjectId(ObjectId o)
                        throws BusinessObjectException
Sets the unique ID of the associated project. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getProjectId

public java.lang.String getProjectId()
                              throws BusinessObjectException
Gets the short code that uniquely identifies the project.

Returns:
the value in the field ProjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getWeight

public double getWeight()
                 throws BusinessObjectException
Gets the weight that is assigned to the milestone.

Returns:
the value in the field Weight
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setWeight

public void setWeight(double d)
               throws BusinessObjectException
Sets the weight that is assigned to the milestone.

Parameters:
d - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getIsCompleted

public boolean getIsCompleted()
                       throws BusinessObjectException
Gets the flag that indicates whether the step has been completed.

Returns:
the value in the field IsCompleted
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setIsCompleted

public void setIsCompleted(boolean b)
                    throws BusinessObjectException
Sets the flag that indicates whether the step has been completed.

Parameters:
b - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the WBS milestone. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the WBS milestone. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

Returns:
the value in the field SequenceNumber
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

Parameters:
i - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this WBS milestone was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this WBS milestone was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this WBS milestone.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this WBS milestone.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getIsBaseline

public boolean getIsBaseline()
                      throws BusinessObjectException
Gets the boolean value indicating if this business object is related to a Project or Baseline.

Returns:
the value in the field IsBaseline
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.