|
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.ActivityStepTemplateItem
public class ActivityStepTemplateItem
An activity step template item is one of the defined steps in the associated activity template. See ActivityStepTemplate for more information about activity step templates. This is a read-only business object.
This business object supports user defined fields (UDFs). Use the UDFValue business object to load assigned UDFs.
See Also: Quick reference of ActivityStepTemplateItem fields
Constructor Summary | |
---|---|
ActivityStepTemplateItem(Session session)
Class constructor specifying the Session. |
|
ActivityStepTemplateItem(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ActivityStepTemplateItem(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
ObjectId |
getActivityStepTemplateObjectId()
Gets the unique ID of the activity step template to which this item belongs. |
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this activity step template item was created. |
String |
getCreateUser()
Gets the name of the user that created this activity step template item. |
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. |
Date |
getLastUpdateDate()
Gets the date this activity step template item was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this activity step template item. |
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 templat item. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
double |
getWeight()
Gets the weight that is assigned to the step. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static ActivityStepTemplateItem |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single ActivityStepTemplateItem object from the database. |
static BOIterator<ActivityStepTemplateItem> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple ActivityStepTemplateItem objects from the database. |
ActivityStepTemplate |
loadActivityStepTemplate(String[] fields)
Loads an associated ActivityStepTemplate object from the database. |
BOIterator<UDFValue> |
loadUDFValues(String[] fields,
String sWhereClause,
String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
String |
toString()
Returns a string representation of the object. |
Methods inherited from class com.primavera.integration.client.bo.BusinessObject |
---|
equals, hashCode, isNull, setNull, setObjectId |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ActivityStepTemplateItem(Session session)
session
- the Sessionpublic ActivityStepTemplateItem(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ActivityStepTemplateItem(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 ActivityStepTemplate loadActivityStepTemplate(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 ObjectId getActivityStepTemplateObjectId() throws BusinessObjectException
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 String getName() 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 String getDescription() 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 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 static ActivityStepTemplateItem load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ActivityStepTemplateItem 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<ActivityStepTemplateItem> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ActivityStepTemplateItem 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 objects
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |