Primavera Integration API Release 8

com.primavera.integration.common.value
Class ResourceRequest

java.lang.Object
  extended by com.primavera.integration.common.value.ResourceRequest
All Implemented Interfaces:
Serializable

public class ResourceRequest
extends Object
implements Serializable

The resource request used as a search template to search for a qualified resource.

See Also:
Serialized Form

Constructor Summary
ResourceRequest()
           
 
Method Summary
 void addCriterion(ResourceRequestCriterion obj)
          Adds a new criterion
 void addPrimaryRoleCriterion(ObjectId roleObjectId, Proficiency proficiency)
          Adds a new primary role criterion
 void addResourceCodeCriterion(ObjectId rsrcCodeObjectId)
          Adds a new resource code criterion
 void addResourceCriterion(ObjectId rsrcObjectId)
          Adds a new resource criterion
 void addRoleCriterion(ObjectId roleObjectId, Proficiency proficiency)
          Adds a new role criterion
 ResourceRequestCriterion[] criteriaToArray()
          Returns the criteria as an array of ResourceRequestCriterion
 boolean equals(Object newResourceRequest)
           
 Iterator<ResourceRequestCriterion> getCriteria()
          Returns the criteria itself as an java.util.Iterator
 int getCriteriaCount()
          Returns the criteria count
 Date getFinishDate()
          Returns a copy of the finish date
 String getName()
          Returns the name of this ResourceRequest
 Unit getRequestedUnits()
          Returns the requested units
 int getSequenceNumber()
          Returns the sequence number of this ResourceRequest
 Date getStartDate()
          Returns a copy of the start date
 int hashCode()
           
 boolean isMatchAllCriteria()
          Returns the status of the flag matching all criteria or any criteria
 boolean isShowOnlyLaborResources()
          Returns the status of the flag showing only labor Resources
 boolean isShowOverallocatedResources()
          Returns the status of the flag showing overallocated Resources
 boolean isSortResultsByAvailability()
          Returns the status of the flag sorting results by availability
 boolean isUseActivityDates()
          Returns the status of the flag using Activity dates
 void setFinishDate(Date date)
          Sets the finish date, clones argument
 void setMatchAllCriteria(boolean val)
          Sets the flag matching all criteria or any criteria
 void setName(String name)
          Sets the name of this ResourceRequest
 void setRequestedUnits(Unit val)
          Sets the requested units
 void setSequenceNumber(int val)
          Sets the sequence number of this ResourceRequest
 void setShowOnlyLaborResources(boolean val)
          Sets the flag showing only labor Resources
 void setShowOverallocatedResources(boolean val)
          Sets the flag showing overallocated Resources
 void setSortResultsByAvailability(boolean val)
          Sets the flag sorting results by availability
 void setStartDate(Date date)
          Sets the start date, clones argument
 void setUseActivityDates(boolean val)
          Sets the flag using Activity dates
 String toString()
           
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceRequest

public ResourceRequest()
Method Detail

getCriteriaCount

public int getCriteriaCount()
Returns the criteria count

Returns:
int Criteria count

getCriteria

public Iterator<ResourceRequestCriterion> getCriteria()
Returns the criteria itself as an java.util.Iterator

Returns:
Iterator Search criteria

criteriaToArray

public ResourceRequestCriterion[] criteriaToArray()
Returns the criteria as an array of ResourceRequestCriterion

Returns:
ResourceRequestCriterion[] Search criteria

getName

public String getName()
Returns the name of this ResourceRequest

Returns:
String Name of this ResourceRequest

setName

public void setName(String name)
Sets the name of this ResourceRequest

Parameters:
name - Name of this ResourceRequest

getSequenceNumber

public int getSequenceNumber()
Returns the sequence number of this ResourceRequest

Returns:
int sequence number of this ResourceRequest

setSequenceNumber

public void setSequenceNumber(int val)
Sets the sequence number of this ResourceRequest

Parameters:
val - sequence number of this ResourceRequest

isMatchAllCriteria

public boolean isMatchAllCriteria()
Returns the status of the flag matching all criteria or any criteria

Returns:
boolean status of the flag matching all criteria or any criteria

setMatchAllCriteria

public void setMatchAllCriteria(boolean val)
Sets the flag matching all criteria or any criteria

Parameters:
val - value for the flag matching all criteria or any criteria

isSortResultsByAvailability

public boolean isSortResultsByAvailability()
Returns the status of the flag sorting results by availability

Returns:
boolean status of the flag sorting results by availability

setSortResultsByAvailability

public void setSortResultsByAvailability(boolean val)
Sets the flag sorting results by availability

Parameters:
val - value for the flag sorting results by availability

isUseActivityDates

public boolean isUseActivityDates()
Returns the status of the flag using Activity dates

Returns:
boolean status of the flag using Activity dates

setUseActivityDates

public void setUseActivityDates(boolean val)
Sets the flag using Activity dates

Parameters:
val - value for the flag using Activity dates

isShowOverallocatedResources

public boolean isShowOverallocatedResources()
Returns the status of the flag showing overallocated Resources

Returns:
boolean status of the flag showing overallocated Resources

setShowOverallocatedResources

public void setShowOverallocatedResources(boolean val)
Sets the flag showing overallocated Resources

Parameters:
val - value for the flag showing overallocated Resources

getStartDate

public Date getStartDate()
Returns a copy of the start date

Returns:
Date Start date

setStartDate

public void setStartDate(Date date)
Sets the start date, clones argument

Parameters:
date - Start date

getFinishDate

public Date getFinishDate()
Returns a copy of the finish date

Returns:
Date Finish date

setFinishDate

public void setFinishDate(Date date)
Sets the finish date, clones argument

Parameters:
date - Finish date

isShowOnlyLaborResources

public boolean isShowOnlyLaborResources()
Returns the status of the flag showing only labor Resources

Returns:
boolean status of the flag showing only labor Resources

setShowOnlyLaborResources

public void setShowOnlyLaborResources(boolean val)
Sets the flag showing only labor Resources

Parameters:
val - value for the flag showing only labor Resources

getRequestedUnits

public Unit getRequestedUnits()
Returns the requested units

Returns:
Unit the requested units

setRequestedUnits

public void setRequestedUnits(Unit val)
Sets the requested units

Parameters:
val - the requested units

addPrimaryRoleCriterion

public void addPrimaryRoleCriterion(ObjectId roleObjectId,
                                    Proficiency proficiency)
Adds a new primary role criterion

Parameters:
roleObjectId - identifying a Role
proficiency - Proficiency
See Also:
ResourceRequestCriterion

addRoleCriterion

public void addRoleCriterion(ObjectId roleObjectId,
                             Proficiency proficiency)
Adds a new role criterion

Parameters:
roleObjectId - identifying a Role
proficiency - Proficiency
See Also:
ResourceRequestCriterion

addResourceCriterion

public void addResourceCriterion(ObjectId rsrcObjectId)
Adds a new resource criterion

Parameters:
rsrcObjectId - identifying a Resource
See Also:
ResourceRequestCriterion

addResourceCodeCriterion

public void addResourceCodeCriterion(ObjectId rsrcCodeObjectId)
Adds a new resource code criterion

Parameters:
rsrcCodeObjectId - identifying a ResourceCode
See Also:
ResourceRequestCriterion

addCriterion

public void addCriterion(ResourceRequestCriterion obj)
Adds a new criterion

Parameters:
obj - ResourceRequestCriterion object
See Also:
ResourceRequestCriterion

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object newResourceRequest)
Overrides:
equals in class Object

Primavera Integration API Release 8

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