|
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.RoleTeamBase
com.primavera.integration.client.bo.object.RoleTeam
public class RoleTeam
A role team consists of roles grouped together in some way that is meaningful to you.
To add a role to a team, use one of the addRole() or addRoles() methods. Use one of the removeRole() or removeRoles() methods to remove a role from a team. These methods will not cause the role(s) to be deleted.
To determine if a role is in this team, use one of the containsRole() methods. The getRoleIds() method will return an array of the ObjectIds of all roles in the team.
To load all or some of the roles contained in this team, use the loadRoles() method.
See Also: Quick reference of RoleTeam fields
Constructor Summary | |
---|---|
RoleTeam(Session session)
Class constructor specifying the Session. |
|
RoleTeam(Session session,
ObjectId objId)
Class constructor specifying the Session and ObjectId of the object. |
|
RoleTeam(Session session,
com.primavera.infr.db.PrmRowSet rowSet,
int iIndex)
Class constructor called internally after objects are retrieved from the server. |
Method Summary | |
---|---|
void |
addRole(ObjectId objId)
Adds a role into the role team. |
void |
addRole(Role role)
Adds a role into the role team. |
void |
addRoles(ObjectId[] objIds)
Adds roles into the role team. |
void |
addRoles(Role[] roles)
Adds roles into the role team. |
boolean |
containsRole(ObjectId objId)
Indicates if the role is in the role team. |
boolean |
containsRole(Role role)
Indicates if the role is in the role team. |
ObjectId |
create()
Creates this RoleTeam object in the database. |
static ObjectId[] |
create(Session session,
RoleTeam[] roleteams)
Creates multiple RoleTeam objects in the database. |
void |
delete()
Deletes this RoleTeam object from the database. |
static void |
delete(Session session,
RoleTeam[] roleteams)
Deletes multiple RoleTeam objects from the database. |
static java.lang.String[] |
getAllFields()
Gets all fields for this business object. |
java.util.Date |
getCreateDate()
Gets the date this role team was created. |
java.lang.String |
getCreateUser()
Gets the name of the user that created this role team. |
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 role team. |
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 role team was last updated. |
java.lang.String |
getLastUpdateUser()
Gets the name of the user that last updated this role team. |
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 role team. |
ObjectId |
getObjectId()
Gets the unique ID generated by the system. |
static java.lang.String[] |
getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. |
ObjectId[] |
getRoleObjectIds()
Gets an array of role unique IDs contained in the role team. |
java.lang.String |
getUserName()
Gets the user's login name. |
ObjectId |
getUserObjectId()
Gets the unique ID of a specific user who has access to the selected role team. |
static java.lang.String[] |
getWritableFields()
Gets all writable fields for this business object. |
static RoleTeam |
load(Session session,
java.lang.String[] fields,
ObjectId objId)
Loads a single RoleTeam object from the database. |
static BOIterator<RoleTeam> |
load(Session session,
java.lang.String[] fields,
ObjectId[] objIds)
Loads multiple RoleTeam objects from the database. |
BOIterator<Role> |
loadRoles(java.lang.String[] fields,
java.lang.String sWhereClause,
java.lang.String sOrderBy)
Load the role objects contained in the role team. |
User |
loadUser(java.lang.String[] fields)
Loads an associated User object from the database. |
void |
removeRole(ObjectId objId)
Removes a role from the role team. |
void |
removeRole(Role role)
Removes a role from the role team. |
void |
removeRoles(ObjectId[] objIds)
Removes roles from the role team. |
void |
removeRoles(Role[] roles)
Removes roles from the role team. |
void |
setDescription(java.lang.String s)
Sets the description of the role team. |
void |
setName(java.lang.String s)
Sets the name of the role team. |
void |
setObjectId(ObjectId o)
Sets the unique ID generated by the system. |
void |
setUserObjectId(ObjectId o)
Sets the unique ID of a specific user who has access to the selected role team. |
java.lang.String |
toString()
Returns a string representation of the object. |
void |
update()
Updates this RoleTeam object in the database. |
static void |
update(Session session,
RoleTeam[] roleteams)
Updates multiple RoleTeam 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 RoleTeam(Session session)
session
- the Sessionpublic RoleTeam(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic RoleTeam(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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroleteams
- array of RoleTeam 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 RoleTeam load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the RoleTeam 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<RoleTeam> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the RoleTeam 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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroleteams
- array of RoleTeam 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, RoleTeam[] roleteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectroleteams
- array of RoleTeam 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 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 void addRole(Role role) throws BusinessObjectException
addRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
role
- Role object to add
BusinessObjectException
public void addRoles(Role[] roles) throws BusinessObjectException
addRoles
in class com.primavera.integration.client.bo.base.RoleTeamBase
roles
- Array of Role objects to add
BusinessObjectException
public void addRole(ObjectId objId) throws BusinessObjectException
addRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
objId
- unique ID of a Role object to add
BusinessObjectException
public void addRoles(ObjectId[] objIds) throws BusinessObjectException
addRoles
in class com.primavera.integration.client.bo.base.RoleTeamBase
objIds
- Array of Role unique IDs to add
BusinessObjectException
public void removeRole(Role role) throws BusinessObjectException
removeRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
role
- Role object to remove
BusinessObjectException
public void removeRoles(Role[] roles) throws BusinessObjectException
removeRoles
in class com.primavera.integration.client.bo.base.RoleTeamBase
roles
- Array of Role objects
BusinessObjectException
public void removeRole(ObjectId objId) throws BusinessObjectException
removeRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
objId
- unique ID of a Role object
BusinessObjectException
public void removeRoles(ObjectId[] objIds) throws BusinessObjectException
removeRoles
in class com.primavera.integration.client.bo.base.RoleTeamBase
objIds
- Array of Role unique IDs
BusinessObjectException
public boolean containsRole(Role role) throws BusinessObjectException
containsRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
role
- Role object
BusinessObjectException
public boolean containsRole(ObjectId objId) throws BusinessObjectException
containsRole
in class com.primavera.integration.client.bo.base.RoleTeamBase
objId
- unique ID of a Role object
BusinessObjectException
public ObjectId[] getRoleObjectIds() throws BusinessObjectException
getRoleObjectIds
in class com.primavera.integration.client.bo.base.RoleTeamBase
BusinessObjectException
public BOIterator<Role> loadRoles(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
loadRoles
in class com.primavera.integration.client.bo.base.RoleTeamBase
fields
- fields to loadsWhereClause
- where clausesOrderBy
- order-by clause
ServerException
NetworkException
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 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 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 getUserName() 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 |