|
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.UDFValue
public class UDFValue
A user defined field value represents the value of a particular user defined field when assigned to another business object. The ForeignObjectId field represents the ObjectId of the business object to which the UDF is assigned. Note that the type of the foreign business object must match the subject area of the associated UDFType.
The data type of the associated UDFType determines the type of value that can be set. For example, if the data type of the associated UDFType is Indicator, only the get/set UDFIndicator methods may be used.
See Also: Quick reference of UDFValue fields
Constructor Summary | |
---|---|
UDFValue(Session session)
Class constructor specifying the Session. |
|
UDFValue(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
UDFValue(Session session,
ObjectId uDFTypeObjectId,
ObjectId foreignObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: UDFTypeObjectId and ForeignObjectId. |
|
UDFValue(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 UDFValue object in the database. |
static ObjectId[] |
create(Session session,
UDFValue[] udfvalues)
Creates multiple UDFValue objects in the database. |
static ObjectId |
createObjectId(ObjectId uDFTypeObjectId,
ObjectId foreignObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this UDFValue object from the database. |
static void |
delete(Session session,
UDFValue[] udfvalues)
Deletes multiple UDFValue objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.lang.String |
getCodeValue()
Gets the short ID that uniquely identifies the associated UDF code within the UDF code type. |
int |
getConditionalIndicator()
Gets the conditional indicator of the user defined field, obtained by evaluating the conditional expression. |
Cost |
getCost()
Gets the value of the cost UDF. |
java.util.Date |
getCreateDate()
Gets the date this UDF value was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this UDF value. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
java.lang.String |
getDescription()
Gets the description of the associated UDF code. |
double |
getDouble()
Gets the value of the double UDF. |
static java.lang.String[] |
getFilterableFields()
Gets all fields that can be filtered. |
EndDate |
getFinishDate()
Gets the value of the finish date UDF. |
ObjectId |
getForeignObjectId()
Gets the unique ID of the business object to which the UDF is assigned: ProjectObjectId, ActivityObjectId, ResourceObjectId, etc. |
UDFIndicator |
getIndicator()
Gets the value of the indicator UDF. |
int |
getInteger()
Gets the value of the integer UDF. |
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 |
getIsBaseline()
Gets the boolean value indicating if this business object is related to a Project or Baseline. |
boolean |
getIsUDFTypeCalculated()
Gets the flag indicating whether this is a value associated with a calculated user defined field type. |
boolean |
getIsUDFTypeConditional()
Gets the flag indicating whether this is a value associated with a user defined field type having a conditional expression. |
java.util.Date |
getLastUpdateDate()
Gets the date this UDF value was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this UDF value. |
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 ObjectId for this object. |
ObjectId |
getProjectObjectId()
Gets the unique ID of the associated project. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
BeginDate |
getStartDate()
Gets the value of the start date UDF. |
java.lang.String |
getText()
Gets the value of the text UDF. |
ObjectId |
getUDFCodeObjectId()
Gets the unique ID of the associated UDF code. |
UDFDataType |
getUDFTypeDataType()
Gets the data type of the associated user-defined field type: "Text", "Start Date", "Finish Date", "Cost", "Double", "Integer", "Indicator", or "Code". |
ObjectId |
getUDFTypeObjectId()
Gets the unique ID of the associated UDF type. |
UDFSubjectArea |
getUDFTypeSubjectArea()
Gets the subject area of the associated user-defined field type: "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 |
getUDFTypeTitle()
Gets the name/title of the associated user-defined field type. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static UDFValue |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single UDFValue object from the database. |
static BOIterator<UDFValue> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple UDFValue objects from the database. |
Project |
loadProject(java.lang.String[] fields)
Loads an associated Project object from the database. |
UDFCode |
loadUDFCode(java.lang.String[] fields)
Loads an associated UDFCode object from the database. |
UDFType |
loadUDFType(java.lang.String[] fields)
Loads an associated UDFType object from the database. |
void |
setCost(Cost c)
Sets the value of the cost UDF. |
void |
setDouble(double d)
Sets the value of the double UDF. |
void |
setFinishDate(EndDate d)
Sets the value of the finish date UDF. |
void |
setForeignObjectId(ObjectId o)
Sets the unique ID of the business object to which the UDF is assigned: ProjectObjectId, ActivityObjectId, ResourceObjectId, etc. |
void |
setIndicator(UDFIndicator enm)
Sets the value of the indicator UDF. |
void |
setInteger(int i)
Sets the value of the integer UDF. |
void |
setStartDate(BeginDate d)
Sets the value of the start date UDF. |
void |
setText(java.lang.String s)
Sets the value of the text UDF. |
void |
setUDFCodeObjectId(ObjectId o)
Sets the unique ID of the associated UDF code. |
void |
setUDFTypeObjectId(ObjectId o)
Sets the unique ID of the associated UDF type. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this UDFValue object in the database. |
static void |
update(Session session,
UDFValue[] udfvalues)
Updates multiple UDFValue 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 UDFValue(Session session)
session
- the Sessionpublic UDFValue(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFValue(Session session, ObjectId uDFTypeObjectId, ObjectId foreignObjectId) throws BusinessObjectException
session
- the SessionuDFTypeObjectId
- the first ObjectId in the keyforeignObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFValue(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 ObjectId createObjectId(ObjectId uDFTypeObjectId, ObjectId foreignObjectId) throws InvalidValueException
uDFTypeObjectId
- the ObjectId of the associated uDFType object.foreignObjectId
- the ObjectId of the associated foreign object.
InvalidValueException
- if one of the input parameters was invalid.
java.lang.IllegalArgumentException
- if one of the input parameters was null.public ObjectId getObjectId() throws BusinessObjectException
getObjectId
in class BusinessObject
BusinessObjectException
- if the ObjectId fields were not loaded.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, UDFValue[] udfvalues) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfvalues
- array of UDFValue 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 UDFValue load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UDFValue 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<UDFValue> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UDFValue 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, UDFValue[] udfvalues) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfvalues
- array of UDFValue 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, UDFValue[] udfvalues) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfvalues
- array of UDFValue 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 UDFType loadUDFType(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 UDFCode loadUDFCode(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 Project loadProject(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 getUDFTypeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUDFTypeObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getForeignObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setForeignObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getText() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setText(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 UDFIndicator getIndicator() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIndicator(UDFIndicator enm) throws BusinessObjectException
enm
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic double getDouble() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDouble(double d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getInteger() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setInteger(int i) throws BusinessObjectException
i
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic Cost getCost() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCost(Cost c) throws BusinessObjectException
c
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic BeginDate getStartDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setStartDate(BeginDate d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic EndDate getFinishDate() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setFinishDate(EndDate d) throws BusinessObjectException
d
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFSubjectArea getUDFTypeSubjectArea() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getUDFTypeTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFDataType getUDFTypeDataType() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getUDFCodeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUDFCodeObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getCodeValue() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getDescription() 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 boolean getIsBaseline() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsUDFTypeCalculated() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsUDFTypeConditional() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getConditionalIndicator() 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 |