|
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.GlobalProfileBase
com.primavera.integration.client.bo.object.GlobalProfile
public class GlobalProfile
A global profile defines a set of privileges for access to global, or application-wide, information such as cost accounts, resources, and roles. To control user access to global information, you create global profiles, and then assign specific profiles to individual users. All users are required to have a global profile.
To allow complete access to all global
information and all projects, a global profile called Admin Superuser is provided. You can assign
the Admin Superuser profile to as many users as you like. However, since the Admin Superuser
profile enables access to all information, you would typically restrict the number of users to
whom you assign this profile. You cannot edit the Admin Superuser security profile. The Admin
Superuser profile has a constant ObjectId defined by the ADMIN_SUPERUSER
static
constant.
A global profile called No Global Privileges also exists. Assign this profile to
users who require access only to Timesheets. This profile doesn't allow the user to edit data or
view cost information. The No Global Privileges profile has a constant ObjectId defined by the
NO_GLOBAL_PRIVILEGES
static constant.
To access individual privileges in a global 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 GlobalProfile fields
Field Summary | |
---|---|
static ObjectId |
ADMIN_SUPERUSER
Constant for Admin Superuser |
static ObjectId |
NO_GLOBAL_PRIVILEGES
Constant for No Global Privileges |
Constructor Summary | |
---|---|
GlobalProfile(Session session)
Class constructor specifying the Session. |
|
GlobalProfile(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
GlobalProfile(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 GlobalProfile object in the database. |
static ObjectId[] |
create(Session session,
GlobalProfile[] globalprofiles)
Creates multiple GlobalProfile objects in the database. |
void |
delete()
Deletes this GlobalProfile object from the database. |
static void |
delete(Session session,
GlobalProfile[] globalprofiles)
Deletes multiple GlobalProfile objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this Global Profile was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this Global 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 assigned to new users by default. |
boolean |
getIsSuperUser()
Gets the flag that identifies the superuser profile. |
java.util.Date |
getLastUpdateDate()
Gets the date this Global Profile was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this Global 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 privileges that are turned on. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
GlobalPrivilege[] |
getPrivileges()
Retrieve privileges that are on. |
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(GlobalPrivilege priv)
Find out whether this profile has a certain privilege. |
static GlobalProfile |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single GlobalProfile object from the database. |
static BOIterator<GlobalProfile> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple GlobalProfile objects from the database. |
BOIterator<User> |
loadUsers(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Loads multiple associated User objects from the database. |
void |
setIsDefault(boolean b)
Sets the flag that indicates this security profile is assigned to new users by default. |
void |
setName(java.lang.String s)
Sets the privileges that are turned on. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setPrivilege(GlobalPrivilege priv,
boolean bOn)
Sets this privilege on or off. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this GlobalProfile object in the database. |
static void |
update(Session session,
GlobalProfile[] globalprofiles)
Updates multiple GlobalProfile 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 ADMIN_SUPERUSER
public static final ObjectId NO_GLOBAL_PRIVILEGES
Constructor Detail |
---|
public GlobalProfile(Session session)
session
- the Sessionpublic GlobalProfile(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic GlobalProfile(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, GlobalProfile[] globalprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectglobalprofiles
- array of GlobalProfile 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 GlobalProfile load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the GlobalProfile 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<GlobalProfile> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the GlobalProfile 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, GlobalProfile[] globalprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectglobalprofiles
- array of GlobalProfile 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, GlobalProfile[] globalprofiles) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectglobalprofiles
- array of GlobalProfile 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<User> loadUsers(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(GlobalPrivilege priv) throws BusinessObjectException
hasPrivilege
in class com.primavera.integration.client.bo.base.GlobalProfileBase
priv
- identify which privilege
BusinessObjectException
public void setPrivilege(GlobalPrivilege priv, boolean bOn) throws BusinessObjectException
setPrivilege
in class com.primavera.integration.client.bo.base.GlobalProfileBase
priv
- identify which privilegebOn
- turn on/off this privilege
BusinessObjectException
public GlobalPrivilege[] getPrivileges() throws BusinessObjectException
getPrivileges
in class com.primavera.integration.client.bo.base.GlobalProfileBase
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 |