|
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.base.ProjectProfileBase
com.primavera.integration.client.bo.object.ProjectProfile
public class ProjectProfile
A project profile defines a set of privileges for access to project-specific information. Project profiles are assigned to users based on the OBS hierarchy. To control access to project-specific information, you create project profiles, and then assign specific OBS elements and associated project profiles to individual users. The assigned OBS element determines the EPS and WBS elements for which the user can access project information. The assigned project profile determines the type of access privileges the user has to that project information.
All WBS elements are required to have an assigned responsible OBS. If a user's project profile assignment includes a WBS element's responsible OBS, then the user can access all activities, risks, and issues related to that WBS element. Similarly, all thresholds and project issues also have an assigned responsible OBS. If a user's project profile assignment includes a threshold or issue's responsible OBS, then the user can access that threshold or issue.
A user is not required
to have a profile for every project. However, unless a user's global profile is Admin Superuser,
that user cannot access a project without a project profile. To allow complete access to a
project/OBS assignment, a project profile is included named Project Superuser. You can apply the
Project Superuser profile to as many users and for as many projects as you like. The Project
Superuser profile has a constant ObjectId defined by the PROJECT_SUPERUSER
static
constant.
To access individual privileges in a project profile, use the hasPrivilege(), setPrivilege() methods. To get an array of all privileges that are set, use the getPrivileges() method.
See Also: Quick reference of ProjectProfile fields
Field Summary | |
---|---|
static ObjectId |
PROJECT_SUPERUSER
Constant for Project Superuser |
Constructor Summary | |
---|---|
ProjectProfile(Session session)
Class constructor specifying the Session. |
|
ProjectProfile(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
ProjectProfile(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 ProjectProfile object in the database. |
static ObjectId[] |
create(Session session,
ProjectProfile[] projectprofiles)
Creates multiple ProjectProfile objects in the database. |
void |
delete()
Deletes this ProjectProfile object from the database. |
static void |
delete(Session session,
ProjectProfile[] projectprofiles)
Deletes multiple ProjectProfile objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this project profile was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this project profile. |
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. |
boolean |
getIsDefault()
Gets the flag that indicates this security profile is the default profile assigned to UserOBS objects. |
boolean |
getIsSuperUser()
Gets the flag that indicates this is the project superuser profile, which gives a user read/write privileges for all project and OBS specific information and features. |
java.util.Date |
getLastUpdateDate()
Gets the date this project profile was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this project profile. |
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 unique name of this project profile. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
ProjectPrivilege[] |
getPrivileges()
Sets this privilege on or off. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
boolean |
hasPrivilege(ProjectPrivilege priv)
Find out whether this profile has a certain privilege. |
static ProjectProfile |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single ProjectProfile object from the database. |
static BOIterator<ProjectProfile> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple ProjectProfile objects 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. |
void |
setIsDefault(boolean b)
Sets the flag that indicates this security profile is the default profile assigned to UserOBS objects. |
void |
setName(java.lang.String s)
Sets the unique name of this project profile. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setPrivilege(ProjectPrivilege priv,
boolean bOn)
Turn a certain privilege on or off. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this ProjectProfile object in the database. |
static void |
update(Session session,
ProjectProfile[] projectprofiles)
Updates multiple ProjectProfile 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 |
Field Detail |
---|
public static final ObjectId PROJECT_SUPERUSER
Constructor Detail |
---|
public ProjectProfile(Session session)
session
- the Sessionpublic ProjectProfile(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ProjectProfile(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, ProjectProfile[] projectprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectprofiles
- array of ProjectProfile 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 ProjectProfile load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ProjectProfile 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<ProjectProfile> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ProjectProfile 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, ProjectProfile[] projectprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectprofiles
- array of ProjectProfile 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, ProjectProfile[] projectprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectprojectprofiles
- array of ProjectProfile 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<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 boolean hasPrivilege(ProjectPrivilege priv) throws BusinessObjectException
hasPrivilege
in class com.primavera.integration.client.bo.base.ProjectProfileBase
priv
- identify which privilege
BusinessObjectException
public void setPrivilege(ProjectPrivilege priv, boolean bOn) throws BusinessObjectException
setPrivilege
in class com.primavera.integration.client.bo.base.ProjectProfileBase
priv
- identify which privilegebOn
- turn on/off this privilege
BusinessObjectException
public ProjectPrivilege[] getPrivileges() throws BusinessObjectException
getPrivileges
in class com.primavera.integration.client.bo.base.ProjectProfileBase
BusinessObjectException
public 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 boolean getIsDefault() throws BusinessObjectException
BusinessObjectException
- if a problem occurred in the client-side business objectspublic void setIsDefault(boolean b) throws BusinessObjectException
b
- the value to set this field to
BusinessObjectException
- if a problem occurred in the client-side business objectspublic boolean getIsSuperUser() throws BusinessObjectException
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.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 |