Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class UDFCode

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.object.UDFCode

public class UDFCode
extends BusinessObject

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

UDFCode

public UDFCode(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

UDFCode

public UDFCode(Session session,
               ObjectId objId)
        throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

UDFCode

public UDFCode(Session session,
               com.primavera.infr.db.PrmRowSet rowSet,
               int iIndex)
        throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this UDFCode object in the database.

Returns:
ObjectId the unique ID of the newly created UDFCode object
Throws:
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

create

public static ObjectId[] create(Session session,
                                UDFCode[] udfcodes)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple UDFCode objects in the database.

Parameters:
session - the Session object
udfcodes - array of UDFCode objects to create
Returns:
ObjectId[] the array of unique IDs of newly created UDFCode objects
Throws:
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

load

public static UDFCode load(Session session,
                           java.lang.String[] fields,
                           ObjectId objId)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads a single UDFCode object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the UDFCode object
Returns:
UDFCode the UDFCode object
Throws:
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

load

public static BOIterator<UDFCode> load(Session session,
                                       java.lang.String[] fields,
                                       ObjectId[] objIds)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads multiple UDFCode objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the UDFCode objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this UDFCode object in the database.

Overrides:
update in class BOBase
Throws:
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

update

public static void update(Session session,
                          UDFCode[] udfcodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple UDFCode objects in the database.

Parameters:
session - the Session object
udfcodes - array of UDFCode objects to update
Throws:
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

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this UDFCode object from the database.

Overrides:
delete in class BOBase
Throws:
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

delete

public static void delete(Session session,
                          UDFCode[] udfcodes)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple UDFCode objects from the database.

Parameters:
session - the Session object
udfcodes - array of UDFCode objects to delete
Throws:
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

loadUDFType

public UDFType loadUDFType(java.lang.String[] fields)
                    throws ServerException,
                           NetworkException,
                           BusinessObjectException
Loads an associated UDFType object from the database.

Parameters:
fields - fields to load
Returns:
UDFType the UDFType object
Throws:
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

loadUDFValues

public BOIterator<UDFValue> loadUDFValues(java.lang.String[] fields,
                                          java.lang.String sWhereClause,
                                          java.lang.String sOrderBy)
                                   throws ServerException,
                                          NetworkException,
                                          BusinessObjectException
Loads multiple associated UDFValue objects from the database.

Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeTypeObjectId

public ObjectId getCodeTypeObjectId()
                             throws BusinessObjectException
Gets the unique ID of the code type. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field CodeTypeObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeTypeObjectId

public void setCodeTypeObjectId(ObjectId o)
                         throws BusinessObjectException
Sets the unique ID of the code type. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeTypeTitle

public java.lang.String getCodeTypeTitle()
                                  throws BusinessObjectException
Gets the title of the parent code type for this code.

Returns:
the value in the field CodeTypeTitle
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getSequenceNumber

public int getSequenceNumber()
                      throws BusinessObjectException
Gets the sequence number for sorting.

Returns:
the value in the field SequenceNumber
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setSequenceNumber

public void setSequenceNumber(int i)
                       throws BusinessObjectException
Sets the sequence number for sorting.

Parameters:
i - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCodeValue

public java.lang.String getCodeValue()
                              throws BusinessObjectException
Gets the short ID that uniquely identifies the code within the code type. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field CodeValue
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setCodeValue

public void setCodeValue(java.lang.String s)
                  throws BusinessObjectException
Sets the short ID that uniquely identifies the code within the code type. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the description of the code.

Returns:
the value in the field Description
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the description of the code.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this code was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this code was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this code.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this code.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.