Page History

(!) 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

The RAFT Service is focused on providing a consistent interface for:
* Searching for Cost Objects and Cost Object Collections
* Viewing Budget, Actual, Commitments, and Forecast information for Cost Object Collections
* Creating What If scenarios as collections of speculations
* Viewing the projected impacts of those speculations
* Generating and viewing reports on this information


h3. References

see RAFT Requirements Documentation (RAFT-*)

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}
searchbyParm(&parm)
searchCollectionbyParm(&collection,&parm)

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

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

addComment
deleteComment
updateComment
getComment
getCommentsforObject

addWorksetAuthorizations
dropWorksetAuthorizations
viewAuthorizationsforUser
viewAuthorizationsforObject


List info about cost objects
listBudgets(CO,withchildren)
listWorksetScenarios(Workset,withchildren)
listCOScenarios(CO, withchildren)
listProjectPeriods
updateProjectPeriods
addProjectPeriod
dropProjectPeriod
validateProjectPeriods

listReport
executeReport
listDomain
buildDomainReport
executeDomainReport


Summary
BvAQueryDay
RvEQueryDay
BvAQueryMonth
RvEQueryMonth

Query
queryActualsSumm
queryActualsPODetail
queryActualsPEDetail
queryBudgetDay
queryCommitmentsSumm
queryCommitmentsPODetail
queryCommitmentsPEDetail
queryForecastSumm
queryForecastPODetail
queryForecastPEDetail

workset Management
createWorkset
deleteWorkset
archiveWorkset
listWorksets
showWorkset
addWorksetObj
delWorksetObj
addWorksetRule
deleteWorksetRule
updateWorksetfromRules
showWorksetChanges
showAccessChanges
showBalanceExceptions
showworksetCOSummary
showworksetApptSummary


scenario Management
showCOAttributes
showApptAttributes
showScenarioOverview
showScenaroFinImpact
showScenarioPersonImpact
showScenarioDetail
showCOExpenseDetail
showCOPersonDetail
showCODetail
showApptDetail
createScenario
deleteScenario
addCOtoScenario
addAppttoScenario
dropCOfromScenario
dropApptfromScenario
copyScenario
archiveScenario
addAssumption
dropAssumption
updateAssumption
addExpenseAllocSpec
addApptAllocSpec
updateExpenseAllocSpec
updateApptAllocSpec
dropExpenseAllocSpec
dropApptAllocSpec
addTBACOSpec
addTBHApptSpec
dropTBACOSpec
dropTBHApptSpec
updateCOSpec
updateApptSpec
addAdjSpec
dropAdjSpec
addCORateSpec
dropCORateSpec
updateFTESpec
updateVacationSpec
createExpenseAllocSpecfromCOEUS
createExpenseAllocSpecfromSAP
createPersonAllocSpecfromCOEUS

recalcApptDetail
recalcExpenseDetail
buildScenarioSummary
buildWorksetSummary

updateUserPrefGL
updateUserPrefBudget

checkSystemStatus
setScenarioVisibility
setWorksetVisibility

checkProjectedBalance
checkGLBudget
checkMonthlyBurn
checkPersonAlloc
checkRemainingGLBalance
checkRemainingBalance

addProjectTerm
dropProjectTerm
checkProjectTerms

showGlsInCategory
showGLHierarchy
showRatesonObj

showVarianceonScenario
showlineItemsonGL





{panel}

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

{anchor:searchByParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Searches the cost collector set and returns matches based on the passed in parameters
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MAX_COUNT
{td}
{td:class=methodErrorDesc}Number of objects returned >250 
{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} See RAFT-Search
{td}
{tr}
{tr}
{th:class=h}Comments/Feedback
{th}
{td:class=commentsDesc|colspan=3}
{td}
{tr}
{table}
[Back to Operations|#Operations]

{anchor:searchCollectionbyParm}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}searchCollectionByParm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection
{td}
{td:class=methodParamDesc}Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[collectionResultType|collectionResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No cost objects found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}MAX_COUNT
{td}
{td:class=methodErrorDesc}Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.

{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]

{anchor:getSearchLists}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getSearchLists
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the default collection of selection items for each of the search lists.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listSetResultType|listSetResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Master structure for list data that includes supervisor, addressee, sponsor, prime_sponsor, workset. The set always returns a max of 150 entries. To extend beyond that requires the user to use the autocomplete methods.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listSupervisor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listSupervisor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of supervisors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listAddressee}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listAddressee
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of adressees accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of sponsors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listPrimeSponsor}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listPrimeSponsor
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of prime sponsors accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listWorkset}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorkset
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of worksets accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listId}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listId
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of cost object ids and titles accessible by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[listResultType|listResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Array list of key, value pairs
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]

{anchor:listFlaggedCostObjects}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listFlaggedCostObjects
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of flagged cost objects flagged by the requesting user.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Count
{td}
{td:class=methodParamDesc}The number of entries to return.
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coResultType|coResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns cost object details for all of the matching cost objects
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}
{td}
{td:class=methodErrorDesc}
{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]



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



{anchor:addComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Adds a comment to the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}Comment_Type
{td}
{td:class=methodParamName}String
{td}
{td:class=methodParamDesc}Denotes whether a particular comment is public or private.
{td}
{tr}
{tr}
{td:class=methodParamType}Ref_Type
{td}
{td:class=methodParamName}String
{td}
{td:class=methodParamDesc}Identifies what sort of speculation the reference is on (EXPENSE_RULE, APPT_RULE, APPT, CO, SCENARIO, WORKSET)
{td}
{tr}
{tr}
{td:class=methodParamType}REF_ID
{td}
{td:class=methodParamName}String
{td}
{td:class=methodParamDesc}The object id for the associated item (cost_collector_key, etc.)
{td}
{tr}
{tr}
{td:class=methodParamType}
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{td:class=methodParamType}
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns status information and object id for the action (in this case, the comment)
{td}
{tr}
{tr}
{th:class=h|rowspan=14}Errors
{th}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Object already exists
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Object identified by REF_ID does not exist
{td}
{tr}
{td:class=methodErrorType|colspan=2}EMPTY
{td}
{td:class=methodErrorDesc}Comment body is empty
{td}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have comment authorizations here.
{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]

{anchor:deleteComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}deleteComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Sets the status for the identified comment to 'D', effectively removing the comment from display.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}Parm
{td}
{td:class=methodParamDesc}An associative array of key value pairs for search parameters
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Returns the result status and objectId for the action.
{td}
{tr}
{tr}
{th:class=h|rowspan=12}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No comment match found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User cannot delete this authorization.
{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]

{anchor:getComment}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getComment
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Requests the Comment from the system.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Comment_Id
{td}
{td:class=methodParamDesc}The specific comment to retreive
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Object containing the associated comments
{td}
{tr}
{tr}
{th:class=h|rowspan=12}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No comment found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to this comment
{td}
{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]

{anchor:getCommentsforObject}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}getCommentsforObject
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns all comments associated with the identified object
{td}
{tr}
{tr}
{th:class=h|rowspan=12}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_TYPE
{td}
{td:class=methodParamDesc}The type of object to look up comments for
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}REF_ID
{td}
{td:class=methodParamDesc}The Id for the object to look up comments for (cost_collector_key, personell_key, etc.)
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commentResultType|commentResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc}Object containing the associated comments. If there is no match than an empty structure is returned.
{td}
{tr}
{tr}
{th:class=h|rowspan=12}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}No object found
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}NO_AUTH
{td}
{td:class=methodErrorDesc}User does not have access to look at comments on this object.
{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]


h4. {color:#000066}{_}RAFT Authorizations{_}{color}