| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" |
| "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html;charset=utf-8" /> |
| <link href="style.css" rel="stylesheet" type="text/css"/> |
| <title>Thrift module: allocation_manager_cpi</title></head><body> |
| <div class="container-fluid"> |
| <h1>Thrift module: allocation_manager_cpi</h1> |
| <table class="table-bordered table-striped table-condensed"><thead><th>Module</th><th>Services</th><th>Data types</th><th>Constants</th></thead> |
| <tr> |
| <td>allocation_manager_cpi</td><td><a href="#Svc_AllocationRegistryService">AllocationRegistryService</a><br/> |
| <ul> |
| <li><a href="#Fn_AllocationRegistryService_assignReviewers">assignReviewers</a></li> |
| <li><a href="#Fn_AllocationRegistryService_createAllocationRequest">createAllocationRequest</a></li> |
| <li><a href="#Fn_AllocationRegistryService_deleteAllocationRequest">deleteAllocationRequest</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllRequestsForAdmin">getAllRequestsForAdmin</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllRequestsForReviewers">getAllRequestsForReviewers</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllocationManagerAdminEmail">getAllocationManagerAdminEmail</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllocationRequest">getAllocationRequest</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllocationRequestStatus">getAllocationRequestStatus</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllocationRequestUserEmail">getAllocationRequestUserEmail</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getAllocationRequestUserName">getAllocationRequestUserName</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getReviewsForRequest">getReviewsForRequest</a></li> |
| <li><a href="#Fn_AllocationRegistryService_getUserDetails">getUserDetails</a></li> |
| <li><a href="#Fn_AllocationRegistryService_isAdmin">isAdmin</a></li> |
| <li><a href="#Fn_AllocationRegistryService_isAllocationRequestExists">isAllocationRequestExists</a></li> |
| <li><a href="#Fn_AllocationRegistryService_isReviewer">isReviewer</a></li> |
| <li><a href="#Fn_AllocationRegistryService_updateAllocationRequest">updateAllocationRequest</a></li> |
| <li><a href="#Fn_AllocationRegistryService_updateAllocationRequestStatus">updateAllocationRequestStatus</a></li> |
| <li><a href="#Fn_AllocationRegistryService_updateRequestByReviewer">updateRequestByReviewer</a></li> |
| </ul> |
| </td> |
| <td></td> |
| <td></code></td> |
| </tr></table> |
| <hr/><h2 id="Services">Services</h2> |
| <h3 id="Svc_AllocationRegistryService">Service: AllocationRegistryService</h3> |
| <div class="definition"><h4 id="Fn_AllocationRegistryService_createAllocationRequest">Function: AllocationRegistryService.createAllocationRequest</h4> |
| <pre><code>string</code> createAllocationRequest(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> allocDetail) |
| </pre><p>API method to create new allocation requests</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_isAllocationRequestExists">Function: AllocationRegistryService.isAllocationRequestExists</h4> |
| <pre><code>bool</code> isAllocationRequestExists(<code>string</code> projectId, |
| <code>string</code> userName) |
| </pre><p>API method to check if the allocation request exists</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_deleteAllocationRequest">Function: AllocationRegistryService.deleteAllocationRequest</h4> |
| <pre><code>bool</code> deleteAllocationRequest(<code>string</code> projectId, |
| <code>string</code> userName) |
| </pre><p>API method to delete allocation request</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequest">Function: AllocationRegistryService.getAllocationRequest</h4> |
| <pre><code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> getAllocationRequest(<code>string</code> projectId, |
| <code>string</code> userName) |
| </pre><p>API method to get an allocation Request</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_updateAllocationRequest">Function: AllocationRegistryService.updateAllocationRequest</h4> |
| <pre><code>bool</code> updateAllocationRequest(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> allocDetail) |
| </pre><p>API method to update an allocation Request</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestStatus">Function: AllocationRegistryService.getAllocationRequestStatus</h4> |
| <pre><code>string</code> getAllocationRequestStatus(<code>string</code> projectId, |
| <code>string</code> userName) |
| </pre><p>API method to get an allocation Request status</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestUserEmail">Function: AllocationRegistryService.getAllocationRequestUserEmail</h4> |
| <pre><code>string</code> getAllocationRequestUserEmail(<code>string</code> userName) |
| </pre><p>API method to get an allocation Request PI email</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationManagerAdminEmail">Function: AllocationRegistryService.getAllocationManagerAdminEmail</h4> |
| <pre><code>string</code> getAllocationManagerAdminEmail(<code>string</code> userType) |
| </pre><p>API method to get an allocation Request Admin email</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllocationRequestUserName">Function: AllocationRegistryService.getAllocationRequestUserName</h4> |
| <pre><code>string</code> getAllocationRequestUserName(<code>string</code> projectId) |
| </pre><p>API method to get an allocation Request PI</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_updateAllocationRequestStatus">Function: AllocationRegistryService.updateAllocationRequestStatus</h4> |
| <pre><code>void</code> updateAllocationRequestStatus(<code>string</code> projectId, |
| <code>string</code> status) |
| </pre><p>API method to update the status of a request</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllRequestsForAdmin">Function: AllocationRegistryService.getAllRequestsForAdmin</h4> |
| <pre><code>list<<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code>></code> getAllRequestsForAdmin(<code>string</code> userName) |
| </pre><p>API method to get all requests for admin</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_assignReviewers">Function: AllocationRegistryService.assignReviewers</h4> |
| <pre><code>bool</code> assignReviewers(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetailPK">allocation_manager_models.UserAllocationDetailPK</a></code> projectId, |
| <code>string</code> userName) |
| </pre><p>API method to assign reviewers</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_updateRequestByReviewer">Function: AllocationRegistryService.updateRequestByReviewer</h4> |
| <pre><code>bool</code> updateRequestByReviewer(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetailPK">allocation_manager_models.UserAllocationDetailPK</a></code> projectId, |
| <code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code> userAllocationDetail) |
| </pre><p>API method to update request submitted by reviewer</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_isAdmin">Function: AllocationRegistryService.isAdmin</h4> |
| <pre><code>bool</code> isAdmin(<code>string</code> userName) |
| </pre><p>API method to check if the logged in user is an Admin</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_isReviewer">Function: AllocationRegistryService.isReviewer</h4> |
| <pre><code>bool</code> isReviewer(<code>string</code> userName) |
| </pre><p>API method to check if the logged in user is a Reviewer</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getAllRequestsForReviewers">Function: AllocationRegistryService.getAllRequestsForReviewers</h4> |
| <pre><code>list<<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code>></code> getAllRequestsForReviewers(<code>string</code> userName) |
| </pre><p>API method to get all requests assigned to the reviewers</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getUserDetails">Function: AllocationRegistryService.getUserDetails</h4> |
| <pre><code><a href="allocation_manager_models.html#Struct_UserDetail">allocation_manager_models.UserDetail</a></code> getUserDetails(<code>string</code> userName) |
| </pre><p>API method to get a user details</p> |
| <br/></div><div class="definition"><h4 id="Fn_AllocationRegistryService_getReviewsForRequest">Function: AllocationRegistryService.getReviewsForRequest</h4> |
| <pre><code>list<<code><a href="allocation_manager_models.html#Struct_UserAllocationDetail">allocation_manager_models.UserAllocationDetail</a></code>></code> getReviewsForRequest(<code><a href="allocation_manager_models.html#Struct_UserAllocationDetailPK">allocation_manager_models.UserAllocationDetailPK</a></code> projectId) |
| </pre><p>API method to get all the reviews for a request</p> |
| <br/></div></div></body></html> |
