Maximo 7.6.1.2 API - IResourceManager

All Known Implementing Classes:

CachedResourceManager, ResourceMaxManager
```
public interface IResourceManager
```
Interface to manage the collection of Resource/Reservation information.

Author:

sls

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`java.util.Collection<IMXReservation>`	`getAllReservations(java.lang.Long projectId, UserInfo userInfo)` Get all Project reservations.
`java.util.Collection<IMXReservation>`	`getAllZoneReservations(java.lang.Long projectId, UserInfo userInfo)` Get all zone reservations.
`java.util.Map<java.lang.String,java.lang.Double>`	`getModifiedAvailabilityHours(java.lang.Long projectId, java.lang.String type, UserInfo userInfo)` Get working/non-working (modified availability) hours for the Project.
`java.util.Collection<IMXReservation>`	`getReservations(Schedule schedule, IMXResource resource)` For the given resource, we need to return an Iterator of the Reservations for that resources.
`IMXResource`	`getResourceForId(java.lang.String id)` Find the resource for the provided id.
`java.util.Collection<IMXResource>`	`getResources(Schedule schedule, Range<java.util.Date> range, java.util.List<java.lang.String> objectNames, boolean bucketBased)` For the given schedule and the Date Range (in System times), return an interator of Resources that match the given range in the Schedule.
`java.util.Collection<IMXResource>`	`getResourcesAvailability(java.util.Set<java.lang.String> resources, UserInfo userInfo, int resourceType, java.lang.Long projectId)` Get resources availability
`java.lang.Double`	`getTotalWorkHours(java.lang.Long projectId, UserInfo userInfo)` Get total shift hours for the Project.
`java.util.Collection<IMXResource>`	`getZoneAvailability(java.lang.Long projectId, UserInfo userInfo)` Get zone resources availability

Method Detail

getResources

java.util.Collection<IMXResource> getResources(Schedule schedule,
                                               Range<java.util.Date> range,
                                               java.util.List<java.lang.String> objectNames,
                                               boolean bucketBased)
                                        throws java.rmi.RemoteException,
                                               MXException

For the given schedule and the Date Range (in System times), return an interator of Resources that match the given range in the Schedule. We should check the scheduler Resource Data Manager to get a list of Columns that would be loaded for a given resource, and be sure that we populate those accordingly.

Parameters:: schedule -; range -
Returns:
Throws:: java.rmi.RemoteException; MXException

getReservations
```
java.util.Collection<IMXReservation> getReservations(Schedule schedule,
                                                     IMXResource resource)
                                              throws java.rmi.RemoteException,
                                                     MXException
```
For the given resource, we need to return an Iterator of the Reservations for that resources. A Reservation contains some information related to the load/availability, and it contains a reference to the IMXActivity (ie, the work). The IMXActivity record may not actually be loaded in the Schedule, so if it's not loaded, then we will need to load it on-demand. We should check the Reservation Data Manager in scheduler to make sure that we are loading the Reservation data properties accordingly per reservation.

Parameters:

schedule -

resource -

Returns:

Throws:

java.rmi.RemoteException

MXException

getResourceForId
```
IMXResource getResourceForId(java.lang.String id)
```
Find the resource for the provided id.

Parameters:

id -

Returns:

getAllReservations

java.util.Collection<IMXReservation> getAllReservations(java.lang.Long projectId,
                                                        UserInfo userInfo)
                                                 throws java.rmi.RemoteException,
                                                        MXException

Get all Project reservations.

Parameters:: projectId -; userInfo -
Returns:
Throws:: java.rmi.RemoteException; MXException

getResourcesAvailability

java.util.Collection<IMXResource> getResourcesAvailability(java.util.Set<java.lang.String> resources,
                                                           UserInfo userInfo,
                                                           int resourceType,
                                                           java.lang.Long projectId)
                                                    throws java.rmi.RemoteException,
                                                           MXException

Get resources availability

Parameters:: resources - - List of resources names, such as: ELECT, CARP.; resourceType - - Craft (0), Crew Type (1) or Tools (2)
Returns:
Throws:: java.rmi.RemoteException; MXException

getTotalWorkHours

java.lang.Double getTotalWorkHours(java.lang.Long projectId,
                                   UserInfo userInfo)
                            throws java.rmi.RemoteException,
                                   MXException

Get total shift hours for the Project.

Parameters:: projectId -
Returns:
Throws:: java.rmi.RemoteException; MXException

getModifiedAvailabilityHours

java.util.Map<java.lang.String,java.lang.Double> getModifiedAvailabilityHours(java.lang.Long projectId,
                                                                              java.lang.String type,
                                                                              UserInfo userInfo)
                                                                       throws java.rmi.RemoteException,
                                                                              MXException

Get working/non-working (modified availability) hours for the Project.

Parameters:: projectId -
Returns:
Throws:: java.rmi.RemoteException; MXException

getAllZoneReservations

java.util.Collection<IMXReservation> getAllZoneReservations(java.lang.Long projectId,
                                                            UserInfo userInfo)
                                                     throws java.rmi.RemoteException,
                                                            MXException

Get all zone reservations.

Parameters:: projectId -; userInfo -
Returns:
Throws:: java.rmi.RemoteException; MXException

getZoneAvailability

java.util.Collection<IMXResource> getZoneAvailability(java.lang.Long projectId,
                                                      UserInfo userInfo)
                                               throws java.rmi.RemoteException,
                                                      MXException

Get zone resources availability

Parameters:: resources - - List of resources names, such as: ELECT, CARP.
Returns:
Throws:: java.rmi.RemoteException; MXException

Interface IResourceManager