Page History

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

search
searchByParm
searchCollectionbyParm

user autocomplete metadata
getSearchLists
listSupervisor
listAddressee
listId
listSponsor
listPrimeSponsor
listProfitCenter
listFundCenter
listWorkset
listFlaggedCO

costObject Metadata
listBudgets(CO,withchildren)
listWorksetScenarios(Workset,withchildren)
listCOScenarios(CO, withchildren)
listProjectPeriods

Project period maintenance
updateProjectPeriods
addProjectPeriod
dropProjectPeriod
validateProjectPeriods


Summary
querySummary
queryMonthSummary

Query
queryActualsSummary
queryActualsExpense
queryActualsPeople
queryBudgetSummary
queryCommitmentsSummary
queryCommitmentsExpense
queryCommitmentsPeople
queryForecastSummary
queryForecastExpense
queryForecastPeople
{panel}

{include:Method Table Style Page}
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}
{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.
{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: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:listFundCenter}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listFundCenter
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of fund centers 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:listProfitCenter}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listProfitCenter
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of profit Centers 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}{_}CO Metadata{_}{color}

{anchor:listBudgets}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listBudgets
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of budgets available for the specified Cost Object.
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_Collector_key
{td}
{td:class=methodParamDesc}The cost object to look up
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children accounts.
{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. In this case, key = budget version code, value = Description
{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:listWorksetScenarios}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listWorksetScenarios
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of Scenarios associated with this workset. This list is implicitly restricted to the scenarios that the accessing user has access to.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Workset_Key
{td}
{td:class=methodParamDesc}The id for this workset
{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. In this case, key = scenario ID, value = scenario name
{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:listProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}listProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns the list of Project Periods for this cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[projectYearResultType|projectYearResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the project year date ranges associated with this cost object
{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:updateProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}updateProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}For the given project period, alter the start and end date.
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end date for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=3}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this project period/cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OVERLAP
{td}
{td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID
{td}
{td:class=methodErrorDesc}Project period defined outside of start/final expiration date range for this cost 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]

{anchor:addProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}addProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Add project year to cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for this project period
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end date for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=4}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}OVERLAP
{td}
{td:class=methodErrorDesc}Warning: Project period now overlaps another project period defined for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}EXISTS
{td}
{td:class=methodErrorDesc}Project period with this name already exists
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INVALID
{td}
{td:class=methodErrorDesc} Project period defined outside of start/final expiration date range for this cost 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]

{anchor:dropProjectPeriod}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}dropProjectPeriod
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Delete project year from cost object
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Project_Period_Key
{td}
{td:class=methodParamDesc}The identifier for this project period
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[confirmResultType|confirmResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the confirmation status along with the object reference.
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost 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]

{anchor:validateProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}validateProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Validate that the project periods are contiguous and non overlapping, and that they begin at the start of the project and end at the end of the final expiration date
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost 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]

{anchor:normalizeProjectPeriods}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}normalizeProjectPeriods
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=4}Starting from the first period, push out the start date of the subsequent project periods so that the full set of project periods are contiguous and non-overlapping
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for this cost object
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[validateResultType|validateResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the validity status of the project periods on the cost object and identifies exceptions
{td}
{tr}
{tr}
{th:class=h|rowspan=2}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc} No match for this cost object
{td}
{tr}
{tr}
{td:class=methodErrorType|colspan=2}INCOMPLETE
{td}
{td:class=methodErrorDesc} Warning: Project Period schedule does not cover the full date range for this CO (from effective through final expiration date)
{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}{_}Summary{_}{color}

{anchor:querySummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}querySummary
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses.
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}The start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}The end_date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{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:queryMonthSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryMonthSummary
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. Monthly view
{td}
{tr}
{tr}
{th:class=h|rowspan=9}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Hierarchy
{td}
{td:class=methodParamDesc}The Hierarchy of GL categories and accounts to use.
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget_version
{td}
{td:class=methodParamDesc}Which budget to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_version
{td}
{td:class=methodParamDesc}Which scenario to use
{td}
{tr}
{tr}
{td:class=methodParamType}Cost_collector_key
{td}
{td:class=methodParamName}Cost_collector_key
{td}
{td:class=methodParamDesc}The identifier for the cost object
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Start_Period
{td}
{td:class=methodParamDesc}The start period for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}End_Period
{td}
{td:class=methodParamDesc}The end_date for the query window - format = YYYYMM
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Consolidate the results to include all associated children with the parent
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_type
{td}
{td:class=methodParamDesc}When including children, use the following collection for the aggregation
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Collection_key
{td}
{td:class=methodParamDesc}When including children, use this particular collection key as the root of the consolidation tree
{td}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[coSummaryResultType|coSummaryResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Flattened cube of summary financial information
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_MATCH
{td}
{td:class=methodErrorDesc}Either the Cost object or collection key does not exist in the system
{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}{_}Drill-down{_}{color}


{anchor:queryActualsSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsSumm
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the totals by GL/CO 
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actSummResultType|actSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryActualsExpense}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsExpense
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching actuals expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actPOResultType|actPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryActualsPeople}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryActualsPeople
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching actuals personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[actPEResultType|actPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryBudgetSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryBudgetDetail
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching budget records (SAP = GL Level, COEUS = line item level)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Budget Version
{td}
{td:class=methodParamDesc}The plan version for the associated budget
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[budResultType|budPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryCommitmentsSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsSummary
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the commitments information by gl
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commSummResultType|commSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryCommitmentsExpense}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsExpense
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching commitments expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryCommitmentsPeople}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryCommitmentsPeople
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching commitments personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=10}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryForecastSummary}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastSummary
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns a summary of the forecast(scenario) information by gl
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[forSummResultType|forSummResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryForecastExpense}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastExpense
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching forecast (scenario) expense Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPOResultType|commPOResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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:queryForecastPeople}
{table:class=methodTable}
{tr}
{th:class=h}Method
{th}
{td:class=methodName|colspan=3}queryForecastPeople
{td}
{tr}
{tr}
{th:class=h}Description
{th}
{td:class=methodDesc|colspan=3}Returns matching forecast (scenario) personnel Records (rename?)
{td}
{tr}
{tr}
{th:class=h|rowspan=11}Parameters
{th}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_HIER
{td}
{td:class=methodParamDesc}The gl_hierarchy to use
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}GL_Level
{td}
{td:class=methodParamDesc}The GL Category or Account to show items from
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}CoArray
{td}
{td:class=methodParamDesc}The cost_collector_key
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}Scenario_key
{td}
{td:class=methodParamDesc}The scenario key. Defaults to the Common scenario key (COMMON)
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}Start_Date
{td}
{td:class=methodParamDesc}Start date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Zend_Date
{td}
{td:class=methodParamName}End_Date
{td}
{td:class=methodParamDesc}End_Date for the query window
{td}
{tr}
{tr}
{td:class=methodParamType}Boolean
{td}
{td:class=methodParamName}with_children
{td}
{td:class=methodParamDesc}Include children?
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}Start
{td}
{td:class=methodParamDesc}Start at record # 
{td}
{tr}
{tr}
{td:class=methodParamType}Integer
{td}
{td:class=methodParamName}End
{td}
{td:class=methodParamDesc}Return up to and including record #
{td}
{tr}
{tr}
{td:class=methodParamType}String
{td}
{td:class=methodParamName}filter
{td}
{td:class=methodParamDesc}Return records with string in the body
{td}
{tr}
{tr}
{td:class=methodParamType}Array
{td}
{td:class=methodParamName}ordercol
{td}
{td:class=methodParamDesc}The sorting for the structure
{td}
{tr}
{tr}
{tr}
{th:class=h}Return
{th}
{td:class=methodReturnType|colspan=2}[commPEResultType|commPEResultTypeInfo Structure]
{td}
{td:class=methodReturnDesc} Returns the matching collection of actuals records
{td}
{tr}
{tr}
{th:class=h|rowspan=1}Errors
{th}
{td:class=methodErrorType|colspan=2}NO_RECORDS
{td}
{td:class=methodErrorDesc}No records found
{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]