|
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.base.UDFTypeBase
com.primavera.integration.client.bo.object.UDFType
public class UDFType
User-defined fields (UDFs) enable users to add custom fields and values to the project database. For example, additional activity data, such as delivery dates and purchase order numbers, can be tracked. Business objects that support UDFs are Activity, ActivityExpense, ActivityStep, ActivityStepTemplateItem, Document, EPS, Project, ProjectIssue, ProjectRisk, Resource, ResourceAssignment, and WBS. Note that UDFs with a data type of Code may only be assigned to ProjectIssues.
The assignment of a UDF to a particular business object is represented by the UDFValue business object.
See Also: Quick reference of UDFType fields
Constructor Summary | |
---|---|
UDFType(Session session)
Class constructor specifying the Session. |
|
UDFType(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
UDFType(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 UDFType object in the database. |
static ObjectId[] |
create(Session session,
UDFType[] udftypes)
Creates multiple UDFType objects in the database. |
void |
delete()
Deletes this UDFType object from the database. |
static void |
delete(Session session,
UDFType[] udftypes)
Deletes multiple UDFType objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this user-defined field was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this user-defined field. |
UDFDataType |
getDataType()
Gets the data type of the user-defined field: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code". |
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. |
boolean |
getIsCalculated()
Gets the flag indicating whether this is a calculated user defined field type. |
boolean |
getIsConditional()
Gets the flag indicating whether this is a indicator user defined field type. |
boolean |
getIsSecureCode()
Gets the flag indicating whether this is a secure code type. |
java.util.Date |
getLastUpdateDate()
Gets the date this user-defined field was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this user-defined field. |
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. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
UDFSubjectArea |
getSubjectArea()
Gets the subject area of the user-defined field: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents". |
java.lang.String |
getTitle()
Gets the name/title of the user-defined field. |
java.lang.String |
getUDFFieldName()
Obtaining composed field name used for loading udf data. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static UDFType |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single UDFType object from the database. |
static BOIterator<UDFType> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple UDFType objects from the database. |
BOIterator<UDFCode> |
loadUDFCodes(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated UDFCode objects from the database. |
BOIterator<UDFValue> |
loadUDFValues(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated UDFValue objects from the database. |
void |
setDataType(UDFDataType enm)
Sets the data type of the user-defined field: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code". |
void |
setIsSecureCode(boolean b)
Sets the flag indicating whether this is a secure code type. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setSubjectArea(UDFSubjectArea enm)
Sets the subject area of the user-defined field: "Activity", "Activity Expense", "Activity Step", "Activity Step Template Item", "Project", "Project Issue", "Project Risk", "Resource", "Resource Assignment", "WBS", or "Work Products and Documents". |
void |
setTitle(java.lang.String s)
Sets the name/title of the user-defined field. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this UDFType object in the database. |
static void |
update(Session session,
UDFType[] udftypes)
Updates multiple UDFType 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 UDFType(Session session)
session
- the Sessionpublic UDFType(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFType(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, UDFType[] udftypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudftypes
- array of UDFType 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 UDFType load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UDFType 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<UDFType> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UDFType 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, UDFType[] udftypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudftypes
- array of UDFType 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 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, UDFType[] udftypes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudftypes
- array of UDFType 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 objectspublic BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.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 BOIterator<UDFCode> loadUDFCodes(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.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 java.lang.String getUDFFieldName() throws BusinessObjectException
getUDFFieldName
in class com.primavera.integration.client.bo.base.UDFTypeBase
BusinessObjectException
public 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 UDFSubjectArea getSubjectArea() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSubjectArea(UDFSubjectArea enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setTitle(java.lang.String s) throws BusinessObjectException
s
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFDataType getDataType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDataType(UDFDataType enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsSecureCode() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsSecureCode(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsCalculated() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsConditional() 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 |