|
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.UDFCode
public class UDFCode
UDF codes, also known as issue codes, allow you to organize and categorize project issues in a way that is meaningful to you. Their UDF type is 'Code.' For example, you can create a UDF Code, Severity, and subsequently create code values: 'High', 'Medium', and 'Low'. You can assign each of these code values to project issues across multiple projects, enabling you to categorize each project issue according how severe it is. UDF codes are stored in a non-hierarchical list.
See Also: Quick reference of UDFCode fields
Constructor Summary | |
---|---|
UDFCode(Session session)
Class constructor specifying the Session. |
|
UDFCode(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
UDFCode(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 UDFCode object in the database. |
static ObjectId[] |
create(Session session,
UDFCode[] udfcodes)
Creates multiple UDFCode objects in the database. |
void |
delete()
Deletes this UDFCode object from the database. |
static void |
delete(Session session,
UDFCode[] udfcodes)
Deletes multiple UDFCode objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
ObjectId |
getCodeTypeObjectId()
Gets the unique ID of the code type. |
java.lang.String |
getCodeTypeTitle()
Gets the title of the parent code type for this code. |
java.lang.String |
getCodeValue()
Gets the short ID that uniquely identifies the code within the code type. |
java.util.Date |
getCreateDate()
Gets the date this code was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this code. |
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 code. |
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 code was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this code. |
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. |
int |
getSequenceNumber()
Gets the sequence number for sorting. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static UDFCode |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single UDFCode object from the database. |
static BOIterator<UDFCode> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple UDFCode objects from the database. |
UDFType |
loadUDFType(java.lang.String[] fields)
Loads an associated UDFType object 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 |
setCodeTypeObjectId(ObjectId o)
Sets the unique ID of the code type. |
void |
setCodeValue(java.lang.String s)
Sets the short ID that uniquely identifies the code within the code type. |
void |
setDescription(java.lang.String s)
Sets the description of the code. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setSequenceNumber(int i)
Sets the sequence number for sorting. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this UDFCode object in the database. |
static void |
update(Session session,
UDFCode[] udfcodes)
Updates multiple UDFCode 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 UDFCode(Session session)
session
- the Sessionpublic UDFCode(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UDFCode(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, UDFCode[] udfcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfcodes
- array of UDFCode 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 UDFCode load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UDFCode 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<UDFCode> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UDFCode 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, UDFCode[] udfcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfcodes
- array of UDFCode 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, UDFCode[] udfcodes) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectudfcodes
- array of UDFCode 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 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 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 getCodeTypeObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setCodeTypeObjectId(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 getCodeTypeTitle() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic int getSequenceNumber() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setSequenceNumber(int i) throws BusinessObjectException
i
- 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 void setCodeValue(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 java.lang.String getDescription() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setDescription(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 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 |