Primavera Integration API 7.0

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

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.ResourceTeamBase
              extended by com.primavera.integration.client.bo.object.ResourceTeam

public class ResourceTeam
extends com.primavera.integration.client.bo.base.ResourceTeamBase

A resource team consists of resources grouped together in some way that is meaningful to you.

To add a resource to a team, use one of the addResource() or addResources() methods. Use one of the removeResource() or removeResources() methods to remove a resource from a team. These methods will not cause the resource(s) to be deleted.

To determine if a resource is in this team, use one of the containsResource() methods. The getResourceIds() method will return an array of the ObjectIds of all resources in the team.

To load all or some of the resources contained in this team, use the loadResources() method.

See Also:   Quick reference of ResourceTeam fields


Constructor Summary
ResourceTeam(Session session)
          Class constructor specifying the Session.
ResourceTeam(Session session, ObjectId objId)
          Class constructor specifying the Session and ObjectId of the object.
ResourceTeam(Session session, com.primavera.infr.db.PrmRowSet rowSet, int iIndex)
          Class constructor called internally after objects are retrieved from the server.
 
Method Summary
 void addResource(ObjectId objId)
          Adds a resource into the resource team.
 void addResource(Resource rsrc)
          Adds a resource into the resource team.
 void addResources(ObjectId[] objIds)
          Adds resources into the resource team.
 void addResources(Resource[] rsrcs)
          Adds resources into the resource team.
 boolean containsResource(ObjectId objId)
          Find out whether the resource team contains the specified Resource.
 boolean containsResource(Resource rsrc)
          Find out whether the resource team contains the specified Resource.
 ObjectId create()
          Creates this ResourceTeam object in the database.
static ObjectId[] create(Session session, ResourceTeam[] resourceteams)
          Creates multiple ResourceTeam objects in the database.
 void delete()
          Deletes this ResourceTeam object from the database.
static void delete(Session session, ResourceTeam[] resourceteams)
          Deletes multiple ResourceTeam objects from the database.
static java.lang.String[] getAllFields()
          Gets all fields for this business object.
 java.util.Date getCreateDate()
          Gets the date this resource team was created.
 java.lang.String getCreateUser()
          Gets the name of the user that created this resource 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 resource 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 resource team was last updated.
 java.lang.String getLastUpdateUser()
          Gets the name of the user that last updated this resource 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 resource 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[] getResourceObjectIds()
          Returns an array of resource unique IDs contained in the resource team.
 java.lang.String getUserName()
          Gets the user's login name.
 ObjectId getUserObjectId()
          Gets the unique ID of the associated user.
static java.lang.String[] getWritableFields()
          Gets all writable fields for this business object.
static ResourceTeam load(Session session, java.lang.String[] fields, ObjectId objId)
          Loads a single ResourceTeam object from the database.
static BOIterator<ResourceTeam> load(Session session, java.lang.String[] fields, ObjectId[] objIds)
          Loads multiple ResourceTeam objects from the database.
 BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy)
          Load the resource objects contained in the resource team.
 User loadUser(java.lang.String[] fields)
          Loads an associated User object from the database.
 void removeResource(ObjectId objId)
          Removes a resource from the resource team.
 void removeResource(Resource rsrc)
          Removes a resource from the resource team.
 void removeResources(ObjectId[] objIds)
          Removes resources from the resource team.
 void removeResources(Resource[] rsrcs)
          Removes resources from the resource team.
 void setDescription(java.lang.String s)
          Sets the description of the resource team.
 void setName(java.lang.String s)
          Sets the name of the resource team.
 void setObjectId(ObjectId o)
          Sets the unique ID generated by the system.
 void setUserObjectId(ObjectId o)
          Sets the unique ID of the associated user.
 java.lang.String toString()
          Returns a string representation of the object.
 void update()
          Updates this ResourceTeam object in the database.
static void update(Session session, ResourceTeam[] resourceteams)
          Updates multiple ResourceTeam 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

ResourceTeam

public ResourceTeam(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

ResourceTeam

public ResourceTeam(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

ResourceTeam

public ResourceTeam(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 ResourceTeam object in the database.

Returns:
ObjectId the unique ID of the newly created ResourceTeam 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,
                                ResourceTeam[] resourceteams)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Creates multiple ResourceTeam objects in the database.

Parameters:
session - the Session object
resourceteams - array of ResourceTeam objects to create
Returns:
ObjectId[] the array of unique IDs of newly created ResourceTeam 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 ResourceTeam load(Session session,
                                java.lang.String[] fields,
                                ObjectId objId)
                         throws ServerException,
                                NetworkException,
                                BusinessObjectException
Loads a single ResourceTeam object from the database.

Parameters:
session - the Session object
fields - fields to load
objId - unique ID of the ResourceTeam object
Returns:
ResourceTeam the ResourceTeam 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<ResourceTeam> load(Session session,
                                            java.lang.String[] fields,
                                            ObjectId[] objIds)
                                     throws ServerException,
                                            NetworkException,
                                            BusinessObjectException
Loads multiple ResourceTeam objects from the database.

Parameters:
session - the Session object
fields - fields to load
objIds - object ids of the ResourceTeam 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 ResourceTeam 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,
                          ResourceTeam[] resourceteams)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Updates multiple ResourceTeam objects in the database.

Parameters:
session - the Session object
resourceteams - array of ResourceTeam 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 ResourceTeam 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,
                          ResourceTeam[] resourceteams)
                   throws ServerException,
                          NetworkException,
                          BusinessObjectException
Deletes multiple ResourceTeam objects from the database.

Parameters:
session - the Session object
resourceteams - array of ResourceTeam 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

addResource

public void addResource(Resource rsrc)
                 throws BusinessObjectException
Adds a resource into the resource team.

Overrides:
addResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
rsrc - Resource object
Throws:
BusinessObjectException

addResources

public void addResources(Resource[] rsrcs)
                  throws BusinessObjectException
Adds resources into the resource team.

Overrides:
addResources in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
rsrcs - Array of Resource objects
Throws:
BusinessObjectException

addResource

public void addResource(ObjectId objId)
                 throws BusinessObjectException
Adds a resource into the resource team.

Overrides:
addResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
objId - unique ID of the Resource object
Throws:
BusinessObjectException

addResources

public void addResources(ObjectId[] objIds)
                  throws BusinessObjectException
Adds resources into the resource team.

Overrides:
addResources in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
objIds - Array of Resource unique IDs
Throws:
BusinessObjectException

removeResource

public void removeResource(Resource rsrc)
                    throws BusinessObjectException
Removes a resource from the resource team.

Overrides:
removeResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
rsrc - Resource object
Throws:
BusinessObjectException

removeResources

public void removeResources(Resource[] rsrcs)
                     throws BusinessObjectException
Removes resources from the resource team.

Overrides:
removeResources in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
rsrcs - Array of Resource objects
Throws:
BusinessObjectException

removeResource

public void removeResource(ObjectId objId)
                    throws BusinessObjectException
Removes a resource from the resource team.

Overrides:
removeResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
objId - Unique ID of the Resource object
Throws:
BusinessObjectException

removeResources

public void removeResources(ObjectId[] objIds)
                     throws BusinessObjectException
Removes resources from the resource team.

Overrides:
removeResources in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
objIds - Array of Resource unique IDs
Throws:
BusinessObjectException

containsResource

public boolean containsResource(Resource rsrc)
                         throws BusinessObjectException
Find out whether the resource team contains the specified Resource.

Overrides:
containsResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
rsrc - Resource object
Returns:
boolean whether the resource team contains the specified resource
Throws:
BusinessObjectException

containsResource

public boolean containsResource(ObjectId objId)
                         throws BusinessObjectException
Find out whether the resource team contains the specified Resource.

Overrides:
containsResource in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
objId - unique ID of a Resource object
Returns:
boolean whether the resource team contains the specified resource
Throws:
BusinessObjectException

getResourceObjectIds

public ObjectId[] getResourceObjectIds()
                                throws BusinessObjectException
Returns an array of resource unique IDs contained in the resource team.

Overrides:
getResourceObjectIds in class com.primavera.integration.client.bo.base.ResourceTeamBase
Returns:
ObjectId[] array of Resource unique IDs contained in the ResourcePortfolio
Throws:
BusinessObjectException

loadResources

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

Overrides:
loadResources in class com.primavera.integration.client.bo.base.ResourceTeamBase
Parameters:
fields - fields to load
sWhereClause - where clause
sOrderBy - order-by clause
Returns:
BOIterator iterator of Resource 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 the associated user. 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 the associated user. 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 resource 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 resource 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 resource 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 resource 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 resource 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 resource 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 resource 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 resource 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.