|
Primavera Integration API 8.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.ActivityStep
public class ActivityStep
Activity steps provide a way to break activities down into smaller units and track the completion of those units. For example, the activity Prepare for System Integration and Testing might contain the following steps:
You can add as many steps to an activity as you need: some activities will require more steps to complete than others and some activities may require no additional steps at all. If progress occurs on the step, enter a percent complete or set the IsCompleted flag if the step is 100% complete. You can also assign additional information to steps, such as cost, start and finish dates, and text.
Weighted steps
Weighted steps enable you to track the progress of an activity based on the number of steps completed. When activity percent complete is specified to be based on activity steps, and physical is chosen as the activity's percent complete type, activity percent complete is updated based on the weight you assign to each activity step.
For example, in the activity Prepare for System Integration and Testing mentioned above, the steps are assigned weights of 3.0, 2.0, and 1.0 respectively. When you specify the step Establish Test Cases and Test Procedures to be complete, the activity's physical percent complete is updated to 50 percent (because the total weight for the steps in this activity is 6.0 and the weight for this step is 3.0; therefore, half the work on this activity, according to the weight of the steps, has been completed).
This business object supports user defined fields (UDFs). Use the UDFValue business object to assign UDFs.
See Also: Quick reference of ActivityStep fields
Constructor Summary | |
---|---|
ActivityStep(Session session)
Class constructor specifying the Session. |
|
ActivityStep(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityStep(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 ActivityStep object in the database. |
static ObjectId[] |
create(Session session,
ActivityStep[] activitysteps)
Creates multiple ActivityStep objects in the database. |
void |
delete()
Deletes this ActivityStep object from the database. |
static void |
delete(Session session,
ActivityStep[] activitysteps)
Deletes multiple ActivityStep objects from the database. |
String |
getActivityId()
Gets the short ID that uniquely identifies the activity within the project. |
String |
getActivityName()
Gets the name of the activity. |
ObjectId |
getActivityObjectId()
Gets the unique ID of the activity to which the steps are assigned. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this activity step was created. |
String |
getCreateUser()
Gets the name of the user that created this activity step. |
static String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
String |
getDescription()
Gets the description of the activity step. |
static String[] |
getFilterableFields()
Gets all fields that can be filtered. |
static String[] |
getInternalAllFields()
An internal method that should not be called directly by client code. |
static Set<String> |
getInternalAllFieldsSet()
An internal method that should not be called directly by client code. |
static 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. |
boolean |
getIsTemplate()
Gets the boolean value indicating if this business object is related to a template Project. |
Date |
getLastUpdateDate()
Gets the date this activity step was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this activity step. |
static String[] |
getMainFields()
Gets all fields in the main group for this business object. |
static String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
String |
getName()
Gets the name of the activity step. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
Percent |
getPercentComplete()
Gets the percent complete for the step. |
String |
getProjectId()
Gets the short code that uniquely identifies the project. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
ObjectId |
getWBSObjectId()
Gets the unique ID of the WBS for the activity. |
double |
getWeight()
Gets the weight that is assigned to the step. |
Percent |
getWeightPercent()
Gets the non-editable field that displays the percentage amount that corresponds to the step. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityStep |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single ActivityStep object from the database. |
static BOIterator<ActivityStep> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple ActivityStep objects from the database. |
Activity |
loadActivity(String[] fields)
Loads an associated Activity object from the database. |
Project |
loadProject(String[] fields)
Loads an associated Project object from the database. |
BOIterator<UDFValue> |
loadUDFValues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
void |
setActivityObjectId(ObjectId o)
Sets the unique ID of the activity to which the steps are assigned. |
void |
setDescription(String s)
Sets the description of the activity step. |
void |
setIsCompleted(boolean b)
Sets the flag that indicates whether the step has been completed. |
void |
setName(String s)
Sets the name of the activity step. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setPercentComplete(Percent p)
Sets the percent complete for the step. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
void |
setWeight(double d)
Sets the weight that is assigned to the step. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ActivityStep object in the database. |
static void |
update(Session session,
ActivityStep[] activitysteps)
Updates multiple ActivityStep 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 ActivityStep(Session session)
session
- the Sessionpublic ActivityStep(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityStep(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 Activity loadActivity(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 Project loadProject(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 BOIterator<UDFValue> loadUDFValues(String[] fields, String sWhereClause, String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
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 getActivityObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setActivityObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityId() 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 String getProjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(String s) throws BusinessObjectException
s
- 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 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 String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(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 Percent getPercentComplete() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPercentComplete(Percent p) throws BusinessObjectException
p
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getActivityName() throws BusinessObjectException
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 Percent getWeightPercent() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getCreateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Date getLastUpdateDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getCreateUser() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic 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 boolean getIsTemplate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic static String[] getRequiredCreateFields()
public static String[] getFilterableFields()
public static String[] getInternalDefaultLoadFields()
public static String[] getAllFields()
public static String[] getInternalAllFields()
public static Set<String> getInternalAllFieldsSet()
public static String[] getMainFields()
public static String[] getWritableFields()
public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
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, ActivityStep[] activitysteps) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitysteps
- array of ActivityStep 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 ActivityStep load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityStep 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<ActivityStep> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityStep 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 com.primavera.integration.client.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, ActivityStep[] activitysteps) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitysteps
- array of ActivityStep 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 com.primavera.integration.client.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, ActivityStep[] activitysteps) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectactivitysteps
- array of ActivityStep 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 objects
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |