|
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.base.UserFieldTitleBase
com.primavera.integration.client.bo.object.UserFieldTitle
public class UserFieldTitle
User fields enable you to add your own custom fields and values to the project database. For example, you can track additional activity data, such as delivery dates and purchase order numbers, or resource and cost-related data, such as profit, variances, and revised budgets.
In the Project Management application you can display custom user fields in the columns of the Activity Table and then print the layout. You can also group, sort, filter, and summarize by user field, as well as add user fields to reports you create. Use Global Change to assign values to Activity and Activity Resource Assignments type user fields.
You may not create or delete user field titles; they may only be loaded and updated.
See Also: Quick reference of UserFieldTitle fields
Constructor Summary | |
---|---|
UserFieldTitle(Session session)
Class constructor specifying the Session. |
|
UserFieldTitle(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
UserFieldTitle(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
static String[] |
getAllFields()
Gets all fields for this business object. |
Date |
getCreateDate()
Gets the date this user field title was created. |
String |
getCreateUser()
Gets the name of the user that created this user field title. |
String |
getDefaultTitle()
Gets the default title of the column name. |
static String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
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 user field title was last updated. |
String |
getLastUpdateUser()
Gets the name of the user that last updated this user field title. |
static 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. |
String |
getObjectName()
Gets the name of the business object to which this user defined column belongs. |
String |
getUserDefinedTitle()
Gets the user defined column name. |
String |
getUserTableName()
Gets the table name of the user defined column. |
static String[] |
getWritableFields()
Gets all writable fields for this business object. |
static UserFieldTitle |
load(Session session,
String[] fields,
ObjectId objId)
Loads a single UserFieldTitle object from the database. |
static BOIterator<UserFieldTitle> |
load(Session session,
String[] fields,
ObjectId[] objIds)
Loads multiple UserFieldTitle objects from the database. |
static String |
objectNameToTableName(String sObjectName)
Translate from object name to physical database table name. |
void |
setUserDefinedTitle(String s)
Sets the user defined column name. |
String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this UserFieldTitle object in the database. |
static void |
update(Session session,
UserFieldTitle[] userfieldtitles)
Updates multiple UserFieldTitle objects in the database. |
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 UserFieldTitle(Session session)
session
- the Sessionpublic UserFieldTitle(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UserFieldTitle(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 static String objectNameToTableName(String sObjectName)
sObjectName
- object name
public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getUserTableName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getDefaultTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getObjectName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic String getUserDefinedTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUserDefinedTitle(String s) throws BusinessObjectException
s
- the value to set this field to
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[] getWritableFields()
public static String[] getDefaultXMLExportFields()
public static String[] getMinimumXMLExportFields()
public String toString()
toString
in class Object
public static UserFieldTitle load(Session session, String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UserFieldTitle 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<UserFieldTitle> load(Session session, String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UserFieldTitle 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, UserFieldTitle[] userfieldtitles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserfieldtitles
- array of UserFieldTitle 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 objects
|
Primavera Integration API 8.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |