|
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.UserOBS
public class UserOBS
A UserOBS object represents an association between a user object and an OBS object. Users are assigned to global OBS elements to define the scope of project and EPS security for the users. For a user to have access to a project or EPS, the user must be assigned to an OBS element within that project or EPS. (Or, the user must have Admin Superuser privileges.) This gives the user access to any WBS areas their assigned OBS is responsible for.
A utility class, SecurityHelper
, has convenience methods for some of the more
common tasks related to security.
Project profiles are assigned to UserOBS objects. Note that this business object has a multi-part object ID; its object ID is a combination of its user object ID and its OBS object ID. The method createObjectId() can be used to create the multi-part object ID from the individual IDs.
See Also: Quick reference of UserOBS fields
Constructor Summary | |
---|---|
UserOBS(Session session)
Class constructor specifying the Session. |
|
UserOBS(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
UserOBS(Session session,
ObjectId userObjectId,
ObjectId obsObjectId)
Class constructor specifying the Session and the individual components of the multi-part key: UserObjectId and OBSObjectId. |
|
UserOBS(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 UserOBS object in the database. |
static ObjectId[] |
create(Session session,
UserOBS[] userobs)
Creates multiple UserOBS objects in the database. |
static ObjectId |
createObjectId(ObjectId userObjectId,
ObjectId obsObjectId)
Creates a multi-part ObjectId from two individual ObjectIds. |
void |
delete()
Deletes this UserOBS object from the database. |
static void |
delete(Session session,
UserOBS[] userobs)
Deletes multiple 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 association was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this association. |
static java.lang.String[] |
getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified. |
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 association was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this association. |
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. |
java.lang.String |
getOBSName()
Gets the name of the person/role in the organization, sometimes referred to as the "responsible manager". |
ObjectId |
getOBSObjectId()
Gets the unique ID of the OBS to which the user is granted access. |
java.lang.String |
getProfileName()
Gets the name of security profile. |
ObjectId |
getProjectProfileObjectId()
Gets the unique ID of the project profile with which the user is granted access to the project and OBS. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
java.lang.String |
getUserName()
Gets the user's login name. |
ObjectId |
getUserObjectId()
Gets the unique ID of the user who is assigned to the project OBS. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static UserOBS |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single UserOBS object from the database. |
static BOIterator<UserOBS> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple UserOBS objects from the database. |
OBS |
loadOBS(java.lang.String[] fields)
Loads an associated OBS object from the database. |
ProjectProfile |
loadProjectProfile(java.lang.String[] fields)
Loads an associated ProjectProfile object from the database. |
User |
loadUser(java.lang.String[] fields)
Loads an associated User object from the database. |
void |
setOBSObjectId(ObjectId o)
Sets the unique ID of the OBS to which the user is granted access. |
void |
setProjectProfileObjectId(ObjectId o)
Sets the unique ID of the project profile with which the user is granted access to the project and OBS. |
void |
setUserObjectId(ObjectId o)
Sets the unique ID of the user who is assigned to the project OBS. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this UserOBS object in the database. |
static void |
update(Session session,
UserOBS[] userobs)
Updates multiple UserOBS 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 UserOBS(Session session)
session
- the Sessionpublic UserOBS(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UserOBS(Session session, ObjectId userObjectId, ObjectId obsObjectId) throws BusinessObjectException
session
- the SessionuserObjectId
- the first ObjectId in the keyobsObjectId
- the second ObjectId in the key
BusinessObjectException
- if a problem occurred in the client-side business objectspublic UserOBS(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 userObjectId, ObjectId obsObjectId) throws InvalidValueException
userObjectId
- the ObjectId of the associated user object.obsObjectId
- the ObjectId of the associated obs 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, UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserobs
- 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 static UserOBS load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the UserOBS 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<UserOBS> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the UserOBS 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, UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserobs
- 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 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, UserOBS[] userobs) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectuserobs
- 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 ProjectProfile loadProjectProfile(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 User loadUser(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 OBS loadOBS(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 getUserObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setUserObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getOBSObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setOBSObjectId(ObjectId o) throws BusinessObjectException
o
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ObjectId getProjectProfileObjectId() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setProjectProfileObjectId(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 getUserName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getOBSName() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic java.lang.String getProfileName() 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 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 |