Primavera Integration API 7.0

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

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.ActivityStepTemplate

public class ActivityStepTemplate
extends BusinessObject

Activity step templates enable you to define a group of steps common to multiple activities, and then assign the template to activities. Your organization may have several activities that repeat within a project or across projects. For example, every time you start a project, several specifications must be written and approved. Developing a specification is a multi-step process that never changes.

As an example, the "Write Specifications" activity could have the following steps:

These steps may apply to many or all "Write Specifications" activities in a project or across all projects. Rather than manually inputting these steps into each "Write Specifications" activity, you can create an activity step template containing these steps and assign the template to each applicable activity at once. One activity step template may contain several activity steps. Each activity template step is represented by the ActivityStepTemplateItem business object.

This is a read-only business object.

See Also:   Quick reference of ActivityStepTemplate fields


Constructor Summary
ActivityStepTemplate(Session session)
          Class constructor specifying the Session.
ActivityStepTemplate(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ActivityStepTemplate(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this activity step template was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this activity step template.
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.
 java.util.Date getLastUpdateDate()
          Gets the date this activity step template was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this activity step template.
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 activity step template.
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 int getSequenceNumber()
          Gets the sequence number for sorting.
 int getStepCount()
          Gets the number of items in this activity step template.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ActivityStepTemplate load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ActivityStepTemplate object from the database.
static BOIterator<ActivityStepTemplate> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ActivityStepTemplate objects from the database.
 BOIterator<ActivityStepTemplateItem> loadActivityStepTemplateItems(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ActivityStepTemplateItem objects from the database.
 java.lang.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

ActivityStepTemplate

public ActivityStepTemplate(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

ActivityStepTemplate

public ActivityStepTemplate(Session session,
                            ObjectId objId)
                     throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object.

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

ActivityStepTemplate

public ActivityStepTemplate(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

load

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

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ActivityStepTemplate object
Returns:
ActivityStepTemplate the ActivityStepTemplate 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<ActivityStepTemplate> load(Session session,
                                                    java.lang.String[] fields,
                                                    ObjectId[] objIds)
                                             throws ServerException,
                                                    NetworkException,
                                                    BusinessObjectException
Loads multiple ActivityStepTemplate objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ActivityStepTemplate 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

loadActivityStepTemplateItems

public BOIterator<ActivityStepTemplateItem> loadActivityStepTemplateItems(java.lang.String[] fields,
                                                                          java.lang.String sWhereClause,
                                                                          java.lang.String sOrderBy)
                                                                   throws ServerException,
                                                                          NetworkException,
                                                                          BusinessObjectException
Loads multiple associated ActivityStepTemplateItem objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
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

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the activity step template. 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

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

getStepCount

public int getStepCount()
                 throws BusinessObjectException
Gets the number of items in this activity step template. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this activity step template 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 activity step template 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 activity step template.

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 activity step template.

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

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.