(!) WIP

h2. RAFT Service


{include:Interface Style}
{table:id=serviceMetaTable}
{tr}
{th:class=h}Name
{th}
{td:id=serviceName|colspan=2}RAFT Service
{td}
{tr}
{tr}
{th:class=h}Version

{th}
{td:id=serviceVersion}Dev ([0.1|Search Service 0.1])
{td}
{td:id=serviceVersionHistory}[Release Notes|Search Service Release Notes#current]
{td}
{tr}
{table}
| [#References] | [#Operations] | [#Capabilities] |



h3. Description

{excerpt-include:RAFT Service Description and Assumptions}

h3. References


h3. Operations

{include:Method Table Style Page}
{panel:title=Setup|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}
*Domain Operations*
[|#getModelTypes]

{panel}
{panel:title=Search|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}

{panel}
{panel:title=Maintenance|borderStyle=solid|borderColor=#cccccc|bgColor=#ffffff|titleBGColor=#eeeeee}

searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)

Listinfo about user sets
getSearchLists
listSupervisor(#count)
listAddressee(#count)
listSponsor(#count)
listPrimeSponsor(#count)
listId(#count)
listWorksets(#count)
listFlaggedCostObjects(#count)


List info about cost objects
listBudgets(CO,withchildren)
listWorksetScenarios(Workset,withchildren)
listCOScenarios(CO, withchildren)
listProjectPeriods

listReport
executeReport
listDomain
buildDomainReport
executeDomainReport


Summary
BvAQueryDay
RvEQueryDay
BvAQueryMonth
RvEQueryMonth

Query
queryActualsSumm
queryActualsPODetail
queryActualsPEDetail
queryBudgetDay
queryCommitmentsSumm
queryCommitmentsPODetail
queryCommitmentsPEDetail
queryForecastSumm
queryForecastPODetail
queryForecastPEDetail

createWorkset
deleteWorkset
archiveWorkset
listWorksets
showWorkset
addWorksetObj
delWorksetObj
addWorksetRule
deleteWorksetRule
updateWorksetfromRules




createScenario
deleteScenario
addCOtoScenario
addAppttoScenario
dropCOfromScenario
dropApptfromScenario
copyScenario
archiveScenario
addAssumption
dropAssumption
updateAssumption
addExpenseAllocSpec
addApptAllocSpec
updateExpenseAllocSpec
updateApptAllocSpec
deleteExpenseAllocSpec
deleteApptAllocSpec
addTBACOSpec
addTBHApptSpec
delTBACOSpec
delTBHApptSpec
updateCOSpec
updateApptSpec
recalcApptDetail
recalcExpenseDetail








createWorkset
addCoToWorkset
addPersonToWorkset
removeCoFromWorkset
getCoFromWorkset

getCoForecastAssumption
getAllocationForecastByCo
getAllocationForecastByPerson?
getPersonForecastAssumption

createCoModelAssumption(From Forecast)
updateCoModelAssumption
revertCoModelToForecast

createAllocationModelAssumption(From Forecast)
updateAllocationModelAssumption
validateAllocationByPerson

createPersonModelAssumption(From Forecast?)
updatePersonModelAssumption

generateResultsFromModel (?) how many flavors...Date ranged, for entire Workset or specified Co etc

cloneModel (?)
[#createModel]
[#updateModel]
[#deleteModel]
(?) how to handle tbh and anticipated Cos

{panel}


h4. {color:#000066}{_}Setup{_}{color}

{anchor:getModelTypes}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getModelTypes
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Retrieves the list of model types known by this service
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}None
{td}
{td:class=methodParamName}None
{td}
{td:class=methodParamDesc}No parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[cluResultTypeInfo|cluResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}list of model types
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}OPERATION_FAILED
{td}
{td:class=methodErrorDesc}unable to complete request
{td}
{tr}
{tr}
{th:class=h}Capabilities
{th}
{td:class=capabilityDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Use Cases
{th}
{td:class=usecaseDesc|colspan=3}
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]