Primavera Integration API 7.0

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

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.OBS

public class OBS
extends BusinessObject

The Organizational Breakdown Structure (OBS) is a hierarchical arrangement of an organization's management structure. User access and privileges to nodes and projects within the Enterprise Project Structure (EPS) hierarchy are implemented via a responsible manager defined in the enterprise-wide OBS hierarchy.

See Also:   Quick reference of OBS fields


Constructor Summary
OBS(Session session)
          Class constructor specifying the Session.
OBS(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
OBS(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 OBS object in the database.
static ObjectId[] create(Session session, OBS[] obs)
          Creates multiple OBS objects in the database.
 ObjectId createOBSChild(OBS obschild)
          Creates an associated OBS object in the database.
 ObjectId[] createOBSChildren(OBS[] obschildren)
          Creates multiple associated OBS objects in the database.
 ObjectId createUserOBS(UserOBS userobs)
          Creates an associated UserOBS object in the database.
 ObjectId[] createUserOBS(UserOBS[] userobs)
          Creates multiple associated UserOBS objects in the database.
 void delete()
          Deletes this OBS object from the database.
 void delete(ObjectId replacementId)
          Deletes this OBS object from the database.
static void delete(Session session, OBS[] obs)
          Deletes multiple OBS objects from the database.
static void delete(Session session, OBS[] obs, ObjectId replacementParent)
          Deletes multiple obs objects in a hierarchy from the database and set the new parent of all child objects.
 void deleteUserOBS(UserOBS[] userobs)
          Deletes multiple associated UserOBS objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this OBS was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this OBS.
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 person/role in the organization.
static java.lang.String[] getFilterableFields()
          Gets all fields that can be filtered.
 java.lang.String getGUID()
          Gets the globally unique ID generated by the system.
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 OBS was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this OBS.
static java.lang.String[] getMinimumXMLExportFields()
          Gets all fields that are always exported at a minimum by the new flat XML exporter
 java.lang.String getName()
          Gets the name of the person/role in the organization, sometimes referred to elsewhere as the "responsible manager".
 ObjectId getObjectId()
          Gets the unique ID generated by the system.
 ObjectId getParentObjectId()
          Gets the unique ID of the parent OBS of this OBS in the hierarchy.
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 OBS load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single OBS object from the database.
static BOIterator<OBS> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple OBS objects from the database.
 BOIterator<EPS> loadEPS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated EPS objects from the database.
 BOIterator<OBS> loadOBSChildren(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated OBS objects from the database.
 OBS loadParentOBS(java.lang.String[] fields)
          Loads an associated OBS object from the database.
 BOIterator<ProjectIssue> loadProjectIssues(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectIssue objects from the database.
 BOIterator<ProjectRisk> loadProjectRisks(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectRisk objects from the database.
 BOIterator<Project> loadProjects(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated Project objects from the database.
 BOIterator<ProjectThreshold> loadProjectThresholds(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated ProjectThreshold objects from the database.
static OBS loadRootOBS(Session session, java.lang.String[] fields)
          Loads the root OBS object from the database.
 BOIterator<UserOBS> loadUserOBS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated UserOBS objects from the database.
 BOIterator<WBS> loadWBS(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Loads multiple associated WBS objects from the database.
 void setDescription(java.lang.String s)
          Sets the description of the person/role in the organization.
 void setGUID(java.lang.String s)
          Sets the globally unique ID generated by the system.
 void setName(java.lang.String s)
          Sets the name of the person/role in the organization, sometimes referred to elsewhere as the "responsible manager".
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setParentObjectId(ObjectId o)
          Sets the unique ID of the parent OBS of this OBS in the hierarchy.
 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 OBS object in the database.
static void update(Session session, OBS[] obs)
          Updates multiple OBS objects in the database.
 void updateUserOBS(UserOBS[] userobs)
          Updates multiple associated UserOBS 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

OBS

public OBS(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

OBS

public OBS(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

OBS

public OBS(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 OBS object in the database.

Returns:
ObjectId the unique ID of the newly created OBS 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,
                                OBS[] obs)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple OBS objects in the database.

Parameters:
session - the Session object
obs - array of OBS objects to create
Returns:
ObjectId[] the array of unique IDs of newly created OBS 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 OBS load(Session session,
                       java.lang.String[] fields,
                       ObjectId objId)
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Loads a single OBS object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the OBS object
Returns:
OBS the OBS 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<OBS> load(Session session,
                                   java.lang.String[] fields,
                                   ObjectId[] objIds)
                            throws ServerException,
                                   NetworkException,
                                   BusinessObjectException
Loads multiple OBS objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the OBS 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 OBS 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,
                          OBS[] obs)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple OBS objects in the database.

Parameters:
session - the Session object
obs - array of OBS 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 OBS 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 void delete(ObjectId replacementId)
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this OBS object from the database.

Overrides:
delete in class BOBase
Parameters:
replacementId - unique ID of the new parent for all current child 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

delete

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

Parameters:
session - the Session object
obs - array of OBS 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

delete

public static void delete(Session session,
                          OBS[] obs,
                          ObjectId replacementParent)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple obs objects in a hierarchy from the database and set the new parent of all child objects.

Parameters:
session - the Session object
obs - array of OBS objects to delete
replacementParent - replacement parent 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

loadParentOBS

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

Parameters:
fields - fields to load
Returns:
OBS the OBS 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

createOBSChild

public ObjectId createOBSChild(OBS obschild)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Creates an associated OBS object in the database.

Parameters:
obschild - OBSChild object to create
Returns:
ObjectId unique ID of the newly created OBS 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

createOBSChildren

public ObjectId[] createOBSChildren(OBS[] obschildren)
                             throws ServerException,
                                    NetworkException,
                                    BusinessObjectException
Creates multiple associated OBS objects in the database.

Parameters:
obschildren - array of OBSChild objects to create
Returns:
ObjectId[] array of object ids of newly created OBS 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

loadOBSChildren

public BOIterator<OBS> loadOBSChildren(java.lang.String[] fields,
                                       java.lang.String sWhereClause,
                                       java.lang.String sOrderBy)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads multiple associated OBS 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

loadRootOBS

public static OBS loadRootOBS(Session session,
                              java.lang.String[] fields)
                       throws ServerException,
                              NetworkException,
                              BusinessObjectException
Loads the root OBS object from the database.

Parameters:
session - the Session object
fields - fields to load
Returns:
OBS the root OBS 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

createUserOBS

public ObjectId createUserOBS(UserOBS userobs)
                       throws ServerException,
                              NetworkException,
                              BusinessObjectException
Creates an associated UserOBS object in the database.

Parameters:
userobs - UserOBS object to create
Returns:
ObjectId unique ID of the newly created UserOBS 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

createUserOBS

public ObjectId[] createUserOBS(UserOBS[] userobs)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple associated UserOBS objects in the database.

Parameters:
userobs - array of UserOBS objects to create
Returns:
ObjectId[] array of object ids of newly created UserOBS 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

loadUserOBS

public BOIterator<UserOBS> loadUserOBS(java.lang.String[] fields,
                                       java.lang.String sWhereClause,
                                       java.lang.String sOrderBy)
                                throws ServerException,
                                       NetworkException,
                                       BusinessObjectException
Loads multiple associated UserOBS 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

updateUserOBS

public void updateUserOBS(UserOBS[] userobs)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple associated UserOBS objects in the database.

Parameters:
userobs - array of UserOBS 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

deleteUserOBS

public void deleteUserOBS(UserOBS[] userobs)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple associated UserOBS objects from the database.

Parameters:
userobs - array of UserOBS 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

loadEPS

public BOIterator<EPS> loadEPS(java.lang.String[] fields,
                               java.lang.String sWhereClause,
                               java.lang.String sOrderBy)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Loads multiple associated EPS 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

loadProjects

public BOIterator<Project> loadProjects(java.lang.String[] fields,
                                        java.lang.String sWhereClause,
                                        java.lang.String sOrderBy)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Loads multiple associated Project 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

loadWBS

public BOIterator<WBS> loadWBS(java.lang.String[] fields,
                               java.lang.String sWhereClause,
                               java.lang.String sOrderBy)
                        throws ServerException,
                               NetworkException,
                               BusinessObjectException
Loads multiple associated WBS 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

loadProjectIssues

public BOIterator<ProjectIssue> loadProjectIssues(java.lang.String[] fields,
                                                  java.lang.String sWhereClause,
                                                  java.lang.String sOrderBy)
                                           throws ServerException,
                                                  NetworkException,
                                                  BusinessObjectException
Loads multiple associated ProjectIssue 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

loadProjectRisks

public BOIterator<ProjectRisk> loadProjectRisks(java.lang.String[] fields,
                                                java.lang.String sWhereClause,
                                                java.lang.String sOrderBy)
                                         throws ServerException,
                                                NetworkException,
                                                BusinessObjectException
Loads multiple associated ProjectRisk 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

loadProjectThresholds

public BOIterator<ProjectThreshold> loadProjectThresholds(java.lang.String[] fields,
                                                          java.lang.String sWhereClause,
                                                          java.lang.String sOrderBy)
                                                   throws ServerException,
                                                          NetworkException,
                                                          BusinessObjectException
Loads multiple associated ProjectThreshold 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.

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.

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

getParentObjectId

public ObjectId getParentObjectId()
                           throws BusinessObjectException
Gets the unique ID of the parent OBS of this OBS in the hierarchy. This field is automatically loaded by default whenever this type of business object is loaded from the database.

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

setParentObjectId

public void setParentObjectId(ObjectId o)
                       throws BusinessObjectException
Sets the unique ID of the parent OBS of this OBS in the hierarchy. 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

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

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the person/role in the organization, sometimes referred to elsewhere as the "responsible manager". 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 Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the person/role in the organization, sometimes referred to elsewhere as the "responsible manager". 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 person/role in the organization. This field may not be included in the where clause or order by clause specified when loading business objects.

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 person/role in the organization. This field may not be included in the where clause or order by clause specified when loading business objects.

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

getGUID

public java.lang.String getGUID()
                         throws BusinessObjectException
Gets the globally unique ID generated by the system.

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

setGUID

public void setGUID(java.lang.String s)
             throws BusinessObjectException
Sets the globally unique ID generated by the system.

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 OBS 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 OBS 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 OBS.

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 OBS.

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.