Primavera Integration API 7.0

com.primavera.integration.client.bo.object
Class RoleTeam

java.lang.Object
  extended by com.primavera.integration.client.BOBase
      extended by com.primavera.integration.client.bo.BusinessObject
          extended by com.primavera.integration.client.bo.base.RoleTeamBase
              extended by com.primavera.integration.client.bo.object.RoleTeam

public class RoleTeam
extends com.primavera.integration.client.bo.base.RoleTeamBase

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

RoleTeam

public RoleTeam(Session session)
Class constructor specifying the Session. This constructor is most commonly used when create() is intended to be called on this object.

Parameters:
session - the Session

RoleTeam

public RoleTeam(Session session,
                ObjectId objId)
         throws BusinessObjectException
Class constructor specifying the Session and ObjectId of the object. This constructor is most commonly used when update() will be called on this object.

Parameters:
session - the Session
objId - the ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

RoleTeam

public RoleTeam(Session session,
                com.primavera.infr.db.PrmRowSet rowSet,
                int iIndex)
         throws BusinessObjectException
Class constructor called internally after objects are retrieved from the server. Client code should use one of the other constructors for this class.

Parameters:
session - the Session
rowSet - the PrmRowSet retrieved from the server
iIndex - the row index in the PrmRowSet associated with this business object
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects
Method Detail

create

public ObjectId create()
                throws ServerException,
                       NetworkException,
                       BusinessObjectException
Creates this RoleTeam object in the database.

Returns:
ObjectId the unique ID of the newly created RoleTeam object
Throws:
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 objects

create

public static ObjectId[] create(Session session,
                                RoleTeam[] roleteams)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple RoleTeam objects in the database.

Parameters:
session - the Session object
roleteams - array of RoleTeam objects to create
Returns:
ObjectId[] the array of unique IDs of newly created RoleTeam objects
Throws:
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 objects

load

public static RoleTeam load(Session session,
                            java.lang.String[] fields,
                            ObjectId objId)
                     throws ServerException,
                            NetworkException,
                            BusinessObjectException
Loads a single RoleTeam object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the RoleTeam object
Returns:
RoleTeam the RoleTeam object
Throws:
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 objects

load

public static BOIterator<RoleTeam> load(Session session,
                                        java.lang.String[] fields,
                                        ObjectId[] objIds)
                                 throws ServerException,
                                        NetworkException,
                                        BusinessObjectException
Loads multiple RoleTeam objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the RoleTeam objects
Returns:
BOIterator a business object iterator used to get the results of the load request
Throws:
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 objects

update

public void update()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Updates this RoleTeam object in the database.

Overrides:
update in class BOBase
Throws:
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 objects

update

public static void update(Session session,
                          RoleTeam[] roleteams)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple RoleTeam objects in the database.

Parameters:
session - the Session object
roleteams - array of RoleTeam objects to update
Throws:
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 objects

delete

public void delete()
            throws ServerException,
                   NetworkException,
                   BusinessObjectException
Deletes this RoleTeam object from the database.

Overrides:
delete in class BOBase
Throws:
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 objects

delete

public static void delete(Session session,
                          RoleTeam[] roleteams)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple RoleTeam objects from the database.

Parameters:
session - the Session object
roleteams - array of RoleTeam objects to delete
Throws:
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 objects

loadUser

public User loadUser(java.lang.String[] fields)
              throws ServerException,
                     NetworkException,
                     BusinessObjectException
Loads an associated User object from the database.

Parameters:
fields - fields to load
Returns:
User the User object
Throws:
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 objects

addRole

public void addRole(Role role)
             throws BusinessObjectException
Adds a role into the role team.

Overrides:
addRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
role - Role object to add
Throws:
BusinessObjectException

addRoles

public void addRoles(Role[] roles)
              throws BusinessObjectException
Adds roles into the role team.

Overrides:
addRoles in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
roles - Array of Role objects to add
Throws:
BusinessObjectException

addRole

public void addRole(ObjectId objId)
             throws BusinessObjectException
Adds a role into the role team.

Overrides:
addRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
objId - unique ID of a Role object to add
Throws:
BusinessObjectException

addRoles

public void addRoles(ObjectId[] objIds)
              throws BusinessObjectException
Adds roles into the role team.

Overrides:
addRoles in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
objIds - Array of Role unique IDs to add
Throws:
BusinessObjectException

removeRole

public void removeRole(Role role)
                throws BusinessObjectException
Removes a role from the role team.

Overrides:
removeRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
role - Role object to remove
Throws:
BusinessObjectException

removeRoles

public void removeRoles(Role[] roles)
                 throws BusinessObjectException
Removes roles from the role team.

Overrides:
removeRoles in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
roles - Array of Role objects
Throws:
BusinessObjectException

removeRole

public void removeRole(ObjectId objId)
                throws BusinessObjectException
Removes a role from the role team.

Overrides:
removeRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
objId - unique ID of a Role object
Throws:
BusinessObjectException

removeRoles

public void removeRoles(ObjectId[] objIds)
                 throws BusinessObjectException
Removes roles from the role team.

Overrides:
removeRoles in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
objIds - Array of Role unique IDs
Throws:
BusinessObjectException

containsRole

public boolean containsRole(Role role)
                     throws BusinessObjectException
Indicates if the role is in the role team.

Overrides:
containsRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
role - Role object
Returns:
boolean whether the role team contains the specified Roles
Throws:
BusinessObjectException

containsRole

public boolean containsRole(ObjectId objId)
                     throws BusinessObjectException
Indicates if the role is in the role team.

Overrides:
containsRole in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
objId - unique ID of a Role object
Returns:
boolean whether the portfolio contains the specified Role
Throws:
BusinessObjectException

getRoleObjectIds

public ObjectId[] getRoleObjectIds()
                            throws BusinessObjectException
Gets an array of role unique IDs contained in the role team.

Overrides:
getRoleObjectIds in class com.primavera.integration.client.bo.base.RoleTeamBase
Returns:
ObjectId[] array of role unique IDs contained in the role team
Throws:
BusinessObjectException

loadRoles

public BOIterator<Role> loadRoles(java.lang.String[] fields,
                                  java.lang.String sWhereClause,
                                  java.lang.String sOrderBy)
                           throws ServerException,
                                  NetworkException,
                                  BusinessObjectException
Load the role objects contained in the role team.

Overrides:
loadRoles in class com.primavera.integration.client.bo.base.RoleTeamBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator iterator of Role objects
Throws:
ServerException
NetworkException
BusinessObjectException

getObjectId

public ObjectId getObjectId()
                     throws BusinessObjectException
Gets the unique ID generated by the system.

Overrides:
getObjectId in class BusinessObject
Returns:
the value in the field ObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setObjectId

public void setObjectId(ObjectId o)
                 throws BusinessObjectException
Sets the unique ID generated by the system.

Overrides:
setObjectId in class BusinessObject
Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserObjectId

public ObjectId getUserObjectId()
                         throws BusinessObjectException
Gets the unique ID of a specific user who has access to the selected role team. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Returns:
the value in the field UserObjectId
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setUserObjectId

public void setUserObjectId(ObjectId o)
                     throws BusinessObjectException
Sets the unique ID of a specific user who has access to the selected role team. This field is automatically loaded by default whenever this type of business object is loaded from the database.

Parameters:
o - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getName

public java.lang.String getName()
                         throws BusinessObjectException
Gets the name of the role team. This field must contain a valid value in order to create this type of business object in the database.

Returns:
the value in the field Name
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setName

public void setName(java.lang.String s)
             throws BusinessObjectException
Sets the name of the role team. This field must contain a valid value in order to create this type of business object in the database.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getDescription

public java.lang.String getDescription()
                                throws BusinessObjectException
Gets the description of the role team.

Returns:
the value in the field Description
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

setDescription

public void setDescription(java.lang.String s)
                    throws BusinessObjectException
Sets the description of the role team.

Parameters:
s - the value to set this field to
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getUserName

public java.lang.String getUserName()
                             throws BusinessObjectException
Gets the user's login name.

Returns:
the value in the field UserName
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateDate

public java.util.Date getCreateDate()
                             throws BusinessObjectException
Gets the date this role team was created.

Returns:
the value in the field CreateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateDate

public java.util.Date getLastUpdateDate()
                                 throws BusinessObjectException
Gets the date this role team was last updated.

Returns:
the value in the field LastUpdateDate
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getCreateUser

public java.lang.String getCreateUser()
                               throws BusinessObjectException
Gets the name of the user that created this role team.

Returns:
the value in the field CreateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getLastUpdateUser

public java.lang.String getLastUpdateUser()
                                   throws BusinessObjectException
Gets the name of the user that last updated this role team.

Returns:
the value in the field LastUpdateUser
Throws:
BusinessObjectException - if a problem occurred in the client-side business objects

getRequiredCreateFields

public static java.lang.String[] getRequiredCreateFields()
Gets all fields that must be set before calling create() on this business object. Generally the array will contain one field in each position, but if this business object requires either one field or another field to be set, both of those fields will appear in an element of the returned array separated by '|'. For example, if this business object requires field A to always be set, and field B or field C to be set, one element in the returned array will contain A, and one element will contain B|C.

Returns:
String[] an array of required create fields

getFilterableFields

public static java.lang.String[] getFilterableFields()
Gets all fields that can be filtered.

Returns:
String[] an array of filterable fields

getInternalDefaultLoadFields

public static java.lang.String[] getInternalDefaultLoadFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getAllFields

public static java.lang.String[] getAllFields()
Gets all fields for this business object.

Returns:
String[] an array of all fields

getInternalAllFields

public static java.lang.String[] getInternalAllFields()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getInternalAllFieldsSet

public static java.util.Set<java.lang.String> getInternalAllFieldsSet()
An internal method that should not be called directly by client code.

Returns:
String[] an internal array

getWritableFields

public static java.lang.String[] getWritableFields()
Gets all writable fields for this business object.

Returns:
String[] an array of writable fields

getDefaultXMLExportFields

public static java.lang.String[] getDefaultXMLExportFields()
Gets the fields that are exported by the XML exporter when no fields are specified.

Returns:
String[] an array of field names

getMinimumXMLExportFields

public static java.lang.String[] getMinimumXMLExportFields()
Gets all fields that are always exported at a minimum by the new flat XML exporter

Returns:
String[] an array of exported fields

toString

public java.lang.String toString()
Returns a string representation of the object. The output is in XML.

Overrides:
toString in class java.lang.Object
Returns:
String a string representation of the object.

Primavera Integration API 7.0

Copyright © 2003, 2009, Oracle and/or its affiliates. All rights reserved.