|
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.RoleRate
public class RoleRate
Role rates enable you to select a predefined price per unit for cost calculating when assigning the role to an activity. Roles are project personnel job titles or skills, such as mechanical engineer, inspector, or carpenter. They represent a type of resource with a certain level of proficiency rather than a specific individual. As resources, now roles can have different rates assigned to provide more flexibility for cost calculation. See also RateType, RateSource, and RateSourcePreference for more details on how rates can be used in cost calculation.
See Also: Quick reference of RoleRate fields
Constructor Summary | |
---|---|
RoleRate(Session session)
Class constructor specifying the Session. |
|
RoleRate(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
RoleRate(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 RoleRate object in the database. |
static ObjectId[] |
create(Session session,
RoleRate[] rolerates)
Creates multiple RoleRate objects in the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this role rate was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this role rate. |
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 role rate was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this role rate. |
static java.lang.String[] |
getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
Cost |
getPricePerUnit()
Gets the non-overtime price per time for the role. |
Cost |
getPricePerUnit2()
Gets the non-overtime price per time for the role. |
Cost |
getPricePerUnit3()
Gets the non-overtime price per time for the role. |
Cost |
getPricePerUnit4()
Gets the non-overtime price per time for the role. |
Cost |
getPricePerUnit5()
Gets the non-overtime price per time for the role. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getRoleId()
Gets the short code that uniquely identifies the role. |
java.lang.String |
getRoleName()
Gets the name of the role. |
ObjectId |
getRoleObjectId()
Gets the unique ID of the associated role. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static RoleRate |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single RoleRate object from the database. |
static BOIterator<RoleRate> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple RoleRate objects from the database. |
Role |
loadRole(java.lang.String[] fields)
Loads an associated Role object from the database. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setPricePerUnit(Cost c)
Sets the non-overtime price per time for the role. |
void |
setPricePerUnit2(Cost c)
Sets the non-overtime price per time for the role. |
void |
setPricePerUnit3(Cost c)
Sets the non-overtime price per time for the role. |
void |
setPricePerUnit4(Cost c)
Sets the non-overtime price per time for the role. |
void |
setPricePerUnit5(Cost c)
Sets the non-overtime price per time for the role. |
void |
setRoleObjectId(ObjectId o)
Sets the unique ID of the associated role. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this RoleRate object in the database. |
static void |
update(Session session,
RoleRate[] rolerates)
Updates multiple RoleRate 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 RoleRate(Session session)
session
- the Sessionpublic RoleRate(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RoleRate(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, RoleRate[] rolerates) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrolerates
- array of RoleRate 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 RoleRate load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the RoleRate 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<RoleRate> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the RoleRate 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, RoleRate[] rolerates) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectrolerates
- array of RoleRate 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 Role loadRole(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 getRoleObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setRoleObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPricePerUnit(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit2() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPricePerUnit2(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit3() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPricePerUnit3(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit4() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPricePerUnit4(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getPricePerUnit5() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setPricePerUnit5(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRoleId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getRoleName() throws BusinessObjectException
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 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 |