|
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.OBS
public class OBS
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 |
---|
public OBS(Session session)
session
- the Sessionpublic OBS(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic OBS(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, OBS[] obs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectobs
- array of OBS 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 OBS load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the OBS 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<OBS> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the OBS 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, OBS[] obs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectobs
- array of OBS 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 void delete(ObjectId replacementId) throws ServerException, NetworkException, BusinessObjectException
delete
in class BOBase
replacementId
- unique ID of the new parent for all current child 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 static void delete(Session session, OBS[] obs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectobs
- array of OBS 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 static void delete(Session session, OBS[] obs, ObjectId replacementParent) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectobs
- array of OBS objects to deletereplacementParent
- replacement parent 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 OBS loadParentOBS(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 createOBSChild(OBS obschild) throws ServerException, NetworkException, BusinessObjectException
obschild
- OBSChild object 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 ObjectId[] createOBSChildren(OBS[] obschildren) throws ServerException, NetworkException, BusinessObjectException
obschildren
- array of OBSChild 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 BOIterator<OBS> loadOBSChildren(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 static OBS loadRootOBS(Session session, java.lang.String[] fields) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- 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 createUserOBS(UserOBS userobs) throws ServerException, NetworkException, BusinessObjectException
userobs
- UserOBS object 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 ObjectId[] createUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
userobs
- array of UserOBS 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 BOIterator<UserOBS> loadUserOBS(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 void updateUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
userobs
- array of UserOBS 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 deleteUserOBS(UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
userobs
- array of UserOBS 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<EPS> loadEPS(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<Project> loadProjects(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<WBS> loadWBS(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<ProjectIssue> loadProjectIssues(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<ProjectRisk> loadProjectRisks(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<ProjectThreshold> loadProjectThresholds(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 getParentObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setParentObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
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 getName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setName(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.lang.String getGUID() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setGUID(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 |