|
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.ResourceTeamBase
com.primavera.integration.client.bo.object.ResourceTeam
public class ResourceTeam
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 |
---|
public ResourceTeam(Session session)
session
- the Sessionpublic ResourceTeam(Session session, ObjectId objId) throws BusinessObjectException
session
- the SessionobjId
- the ObjectId
BusinessObjectException
- if a problem occurred in the client-side business objectspublic ResourceTeam(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, ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceteams
- array of ResourceTeam 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 ResourceTeam load(Session session, java.lang.String[] fields, ObjectId objId) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjId
- unique ID of the ResourceTeam 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<ResourceTeam> load(Session session, java.lang.String[] fields, ObjectId[] objIds) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectfields
- fields to loadobjIds
- object ids of the ResourceTeam 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, ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceteams
- array of ResourceTeam 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, ResourceTeam[] resourceteams) throws ServerException, NetworkException, BusinessObjectException
session
- the Session objectresourceteams
- array of ResourceTeam 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 addResource(Resource rsrc) throws BusinessObjectException
addResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
rsrc
- Resource object
BusinessObjectException
public void addResources(Resource[] rsrcs) throws BusinessObjectException
addResources
in class com.primavera.integration.client.bo.base.ResourceTeamBase
rsrcs
- Array of Resource objects
BusinessObjectException
public void addResource(ObjectId objId) throws BusinessObjectException
addResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
objId
- unique ID of the Resource object
BusinessObjectException
public void addResources(ObjectId[] objIds) throws BusinessObjectException
addResources
in class com.primavera.integration.client.bo.base.ResourceTeamBase
objIds
- Array of Resource unique IDs
BusinessObjectException
public void removeResource(Resource rsrc) throws BusinessObjectException
removeResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
rsrc
- Resource object
BusinessObjectException
public void removeResources(Resource[] rsrcs) throws BusinessObjectException
removeResources
in class com.primavera.integration.client.bo.base.ResourceTeamBase
rsrcs
- Array of Resource objects
BusinessObjectException
public void removeResource(ObjectId objId) throws BusinessObjectException
removeResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
objId
- Unique ID of the Resource object
BusinessObjectException
public void removeResources(ObjectId[] objIds) throws BusinessObjectException
removeResources
in class com.primavera.integration.client.bo.base.ResourceTeamBase
objIds
- Array of Resource unique IDs
BusinessObjectException
public boolean containsResource(Resource rsrc) throws BusinessObjectException
containsResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
rsrc
- Resource object
BusinessObjectException
public boolean containsResource(ObjectId objId) throws BusinessObjectException
containsResource
in class com.primavera.integration.client.bo.base.ResourceTeamBase
objId
- unique ID of a Resource object
BusinessObjectException
public ObjectId[] getResourceObjectIds() throws BusinessObjectException
getResourceObjectIds
in class com.primavera.integration.client.bo.base.ResourceTeamBase
BusinessObjectException
public BOIterator<Resource> loadResources(java.lang.String[] fields, java.lang.String sWhereClause, java.lang.String sOrderBy) throws ServerException, NetworkException, BusinessObjectException
loadResources
in class com.primavera.integration.client.bo.base.ResourceTeamBase
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 |