Page History

Panel

borderColor	#cccccc
bgColor	#ffffff
titleBGColor	#eeeeee
borderStyle	solid
title	Search
borderStyle	solid

search
searchByParm
searchCollectionbyParm

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

costObject Metadatalist
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

Include Page

	Method Table Style Page
	Method Table Style Page

Search

Anchor

	searchByParm
	searchByParm

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchByParm

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Searches the cost collector set and returns matches based on the passed in parameters

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

Parm

Table Cell (td)

class	methodParamDesc

An associative array of key value pairs for search parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

coResultType

Table Cell (td)

class	methodReturnDesc

Returns cost object details for all of the matching cost objects.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No cost objects found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MAX_COUNT

Table Cell (td)

class	methodErrorDesc

Number of objects returned >250

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

See RAFT-Search

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	searchCollectionbyParm
	searchCollectionbyParm

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

searchCollectionByParm

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Performs a collection search based off the identified parameters. Collection searches cannot be used to define sets

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Collection

Table Cell (td)

class	methodParamDesc

Which collection will be searched, one of supervisor, sponsor, fund_center, profit_center, workset

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

Parm

Table Cell (td)

class	methodParamDesc

An associative array of key value pairs for search parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

collectionResultType

Table Cell (td)

class	methodReturnDesc

Returns cost object details for all of the matching cost objects wrapped in a metadata header for the collection.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No cost objects found

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

MAX_COUNT

Table Cell (td)

class	methodErrorDesc

Count of returned objects (including the collection header) exceeds 250 and cannot be displayed.

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	getSearchLists
	getSearchLists

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

getSearchLists

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the default collection of selection items for each of the search lists.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

Parm

Table Cell (td)

class	methodParamDesc

An associative array of key value pairs for search parameters

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listSetResultType

Table Cell (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.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listSupervisor
	listSupervisor

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listSupervisor

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of supervisors accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listAddressee
	listAddressee

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listAddressee

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of adressees accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listSponsor
	listSponsor

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listSponsor

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of sponsors accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listPrimeSponsor
	listPrimeSponsor

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listPrimeSponsor

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of prime sponsors accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listFundCenter
	listFundCenter

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listFundCenter

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of fund centers accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listProfitCenter
	listProfitCenter

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listProfitCenter

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of profit Centers accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listWorkset
	listWorkset

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listWorkset

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of worksets accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listId
	listId

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listId

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of cost object ids and titles accessible by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listFlaggedCostObjects
	listFlaggedCostObjects

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listFlaggedCostObjects

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of flagged cost objects flagged by the requesting user.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Count

Table Cell (td)

class	methodParamDesc

The number of entries to return.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

coResultType

Table Cell (td)

class	methodReturnDesc

Returns cost object details for all of the matching cost objects

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

CO Metadata

Anchor

	listBudgets
	listBudgets

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listBudgets

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of budgets available for the specified Cost Object.

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_Collector_key

Table Cell (td)

class	methodParamDesc

The cost object to look up

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children accounts.

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs. In this case, key = budget version code, value = Description

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listWorksetScenarios
	listWorksetScenarios

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listWorksetScenarios

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of Scenarios associated with this workset. This list is implicitly restricted to the scenarios that the accessing user has access to.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Workset_Key

Table Cell (td)

class	methodParamDesc

The id for this workset

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

listResultType

Table Cell (td)

class	methodReturnDesc

Array list of key, value pairs. In this case, key = scenario ID, value = scenario name

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	listProjectPeriods
	listProjectPeriods

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

listProjectPeriods

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns the list of Project Periods for this cost object

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

projectYearResultType

Table Cell (td)

class	methodReturnDesc

Returns the project year date ranges associated with this cost object

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

Table Cell (td)

class	methodErrorDesc

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	updateProjectPeriod
	updateProjectPeriod

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

updateProjectPeriod

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	4
class	methodDesc

For the given project period, alter the start and end date.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Project_Period_Key

Table Cell (td)

class	methodParamDesc

The identifier for this project period

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The start date for this project period

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The end date for this project period

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference.

Table Row (tr)

Table Head (th)

rowspan	3
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No match for this project period/cost object

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OVERLAP

Table Cell (td)

class	methodErrorDesc

Warning: Project period now overlaps another project period defined for this cost object

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID

Table Cell (td)

class	methodErrorDesc

Project period defined outside of start/final expiration date range for this cost object

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	addProjectPeriod
	addProjectPeriod

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

addProjectPeriod

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	4
class	methodDesc

Add project year to cost object

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Project_Period_Key

Table Cell (td)

class	methodParamDesc

The identifier for this project period

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

The start date for this project period

Table Row (tr)

Table Cell (td)

class	methodParamType

Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

The end date for this project period

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference.

Table Row (tr)

Table Head (th)

rowspan	4
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No match for this cost object

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

OVERLAP

Table Cell (td)

class	methodErrorDesc

Warning: Project period now overlaps another project period defined for this cost object

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

EXISTS

Table Cell (td)

class	methodErrorDesc

Project period with this name already exists

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INVALID

Table Cell (td)

class	methodErrorDesc

Project period defined outside of start/final expiration date range for this cost object

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	dropProjectPeriod
	dropProjectPeriod

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

dropProjectPeriod

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	4
class	methodDesc

Delete project year from cost object

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Project_Period_Key

Table Cell (td)

class	methodParamDesc

The identifier for this project period

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

confirmResultType

Table Cell (td)

class	methodReturnDesc

Returns the confirmation status along with the object reference.

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No match for this cost object

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	validateProjectPeriods
	validateProjectPeriods

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

validateProjectPeriods

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	4
class	methodDesc

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

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validateResultType

Table Cell (td)

class	methodReturnDesc

Returns the validity status of the project periods on the cost object and identifies exceptions

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No match for this cost object

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Anchor

	normalizeProjectPeriods
	normalizeProjectPeriods

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

normalizeProjectPeriods

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	4
class	methodDesc

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

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Cost_collector_key

Table Cell (td)

class	methodParamDesc

The identifier for this cost object

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

validateResultType

Table Cell (td)

class	methodReturnDesc

Returns the validity status of the project periods on the cost object and identifies exceptions

Table Row (tr)

Table Head (th)

rowspan	2
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_MATCH

Table Cell (td)

class	methodErrorDesc

No match for this cost object

Table Row (tr)

Table Cell (td)

colspan	2
class	methodErrorType

INCOMPLETE

Table Cell (td)

class	methodErrorDesc

Warning: Project Period schedule does not cover the full date range for this CO (from effective through final expiration date)

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Back to Operations

Summary

...

Anchor
querySummary
querySummary
HTML Table
class methodTable
Table Row (tr)
Table Head (th)
class h
Method
Table Cell (td)
colspan 3
class methodName
querySummary
Table Row (tr)
Table Head (th)
class h
Description
Table Cell (td)
colspan 3
class methodDesc
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Revenue & Expenses.
Table Row (tr)
Table Head (th)
rowspan 9
class h
Parameters
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
GL_Hierarchy
Table Cell (td)
class methodParamDesc
The Hierarchy of GL categories and accounts to use.
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Budget_version
Table Cell (td)
class methodParamDesc
Which budget to use
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Scenario_version
Table Cell (td)
class methodParamDesc
Which scenario to use
Table Row (tr)
Table Cell (td)
class methodParamType
Cost_collector_key
Table Cell (td)
class methodParamName
Cost_collector_key
Table Cell (td)
class methodParamDesc
The identifier for the cost object
Table Row (tr)
Table Cell (td)
class methodParamType
Date
Table Cell (td)
class methodParamName
Start_Date
Table Cell (td)
class methodParamDesc
The start date for the query window
Table Row (tr)
Table Cell (td)
class methodParamType
Date
Table Cell (td)
class methodParamName
End_Date
Table Cell (td)
class methodParamDesc
The end_date for the query window
Table Row (tr)
Table Cell (td)
class methodParamType
Boolean
Table Cell (td)
class methodParamName
with_children
Table Cell (td)
class methodParamDesc
Consolidate the results to include all associated children with the parent
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Collection_type
Table Cell (td)
class methodParamDesc
When including children, use the following collection for the aggregation
Table Row (tr)
Table Head (th)
class h
Return
Table Cell (td)
colspan 2
class methodReturnType
coSummaryResultType
Table Cell (td)
class methodReturnDesc
Flattened cube of summary financial information
Table Row (tr)
Table Head (th)
rowspan 1
class h
Errors
Table Cell (td)
colspan 2
class methodErrorType
NO_MATCH
Table Cell (td)
class methodErrorDesc
Either the Cost object or collection key does not exist in the system
Table Row (tr)
Table Head (th)
class h
Capabilities
Table Cell (td)
colspan 3
class capabilityDesc
Table Row (tr)
Table Head (th)
class h
Use Cases
Table Cell (td)
colspan 3
class usecaseDesc
Table Row (tr)
Table Head (th)
class h
Comments/Feedback
Table Cell (td)
colspan 3
class commentsDesc
Back to Operations
Anchor
queryMonthSummary
queryMonthSummary
HTML Table
class methodTable
Table Row (tr)
Table Head (th)
class h
Method
Table Cell (td)
colspan 3
class methodName
queryMonthSummary
Table Row (tr)
Table Head (th)
class h
Description
Table Cell (td)
colspan 3
class methodDesc
Summary by GL hierarchy of the budgets, actuals, and commitment information for an account. Expenses only. Monthly view
Table Row (tr)
Table Head (th)
rowspan 9
class h
Parameters
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
GL_Hierarchy
Table Cell (td)
class methodParamDesc
The Hierarchy of GL categories and accounts to use.
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Budget_version
Table Cell (td)
class methodParamDesc
Which budget to use
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Scenario_version
Table Cell (td)
class methodParamDesc
Which scenario to use
Table Row (tr)
Table Cell (td)
class methodParamType
Cost_collector_key
Table Cell (td)
class methodParamName
Cost_collector_key
Table Cell (td)
class methodParamDesc
The identifier for the cost object
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Start_Period
Table Cell (td)
class methodParamDesc
The start period for the query window - format = YYYYMM
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
End_Period
Table Cell (td)
class methodParamDesc
The end_date for the query window - format = YYYYMM
Table Row (tr)
Table Cell (td)
class methodParamType
Boolean
Table Cell (td)
class methodParamName
with_children
Table Cell (td)
class methodParamDesc
Consolidate the results to include all associated children with the parent
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Collection_type
Table Cell (td)
class methodParamDesc
When including children, use the following collection for the aggregation
Table Row (tr)
Table Cell (td)
class methodParamType
String
Table Cell (td)
class methodParamName
Collection_key
Table Cell (td)
class methodParamDesc
When including children, use this particular collection key as the root of the consolidation tree
Table Row (tr)
Table Head (th)
class h
Return
Table Cell (td)
colspan 2
class methodReturnType
coSummaryResultType
Table Cell (td)
class methodReturnDesc
Flattened cube of summary financial information
Table Row (tr)
Table Head (th)
rowspan 1
class h
Errors
Table Cell (td)
colspan 2
class methodErrorType
NO_MATCH
Table Cell (td)
class methodErrorDesc
Either the Cost object or collection key does not exist in the system
Table Row (tr)
Table Head (th)
class h
Capabilities
Table Cell (td)
colspan 3
class capabilityDesc
Table Row (tr)
Table Head (th)
class h
Use Cases
Table Cell (td)
colspan 3
class usecaseDesc
Table Row (tr)
Table Head (th)
class h
Comments/Feedback
Table Cell (td)
colspan 3
class commentsDesc
Back to Operations

Drill-down

Anchor

	queryActualsSummary
	queryActualsSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryActualsSumm

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns a summary of the totals by GL/CO

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

actSummResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryActualsExpense
	queryActualsExpense

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryActualsExpense

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching actuals expense Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

actPOResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryActualsPeople
	queryActualsPeople

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryActualsPeople

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching actuals personnel Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

actPEResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryBudgetSummary
	queryBudgetSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryBudgetDetail

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching budget records (SAP = GL Level, COEUS = line item level)

Table Row (tr)

Table Head (th)

rowspan	11
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Budget Version

Table Cell (td)

class	methodParamDesc

The plan version for the associated budget

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

budResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryCommitmentsSummary
	queryCommitmentsSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryCommitmentsSummary

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns a summary of the commitments information by gl

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

commSummResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryCommitmentsExpense
	queryCommitmentsExpense

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryCommitmentsExpense

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching commitments expense Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

commPOResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryCommitmentsPeople
	queryCommitmentsPeople

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryCommitmentsPeople

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching commitments personnel Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	10
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

commPEResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryForecastSummary
	queryForecastSummary

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryForecastSummary

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns a summary of the forecast(scenario) information by gl

Table Row (tr)

Table Head (th)

rowspan	11
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_key

Table Cell (td)

class	methodParamDesc

The scenario key. Defaults to the Common scenario key (COMMON)

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

forSummResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryForecastExpense
	queryForecastExpense

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryForecastExpense

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching forecast (scenario) expense Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	11
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_key

Table Cell (td)

class	methodParamDesc

The scenario key. Defaults to the Common scenario key (COMMON)

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

commPOResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

Anchor

	queryForecastPeople
	queryForecastPeople

HTML Table

class	methodTable

Table Row (tr)

Table Head (th)

class	h

Method

Table Cell (td)

colspan	3
class	methodName

queryForecastPeople

Table Row (tr)

Table Head (th)

class	h

Description

Table Cell (td)

colspan	3
class	methodDesc

Returns matching forecast (scenario) personnel Records (rename?)

Table Row (tr)

Table Head (th)

rowspan	11
class	h

Parameters

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_HIER

Table Cell (td)

class	methodParamDesc

The gl_hierarchy to use

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

GL_Level

Table Cell (td)

class	methodParamDesc

The GL Category or Account to show items from

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

CoArray

Table Cell (td)

class	methodParamDesc

The cost_collector_key

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

Scenario_key

Table Cell (td)

class	methodParamDesc

The scenario key. Defaults to the Common scenario key (COMMON)

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

Start_Date

Table Cell (td)

class	methodParamDesc

Start date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Zend_Date

Table Cell (td)

class	methodParamName

End_Date

Table Cell (td)

class	methodParamDesc

End_Date for the query window

Table Row (tr)

Table Cell (td)

class	methodParamType

Boolean

Table Cell (td)

class	methodParamName

with_children

Table Cell (td)

class	methodParamDesc

Include children?

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

Start

Table Cell (td)

class	methodParamDesc

Start at record #

Table Row (tr)

Table Cell (td)

class	methodParamType

Integer

Table Cell (td)

class	methodParamName

End

Table Cell (td)

class	methodParamDesc

Return up to and including record #

Table Row (tr)

Table Cell (td)

class	methodParamType

String

Table Cell (td)

class	methodParamName

filter

Table Cell (td)

class	methodParamDesc

Return records with string in the body

Table Row (tr)

Table Cell (td)

class	methodParamType

Array

Table Cell (td)

class	methodParamName

ordercol

Table Cell (td)

class	methodParamDesc

The sorting for the structure

Table Row (tr)

Table Head (th)

class	h

Return

Table Cell (td)

colspan	2
class	methodReturnType

commPEResultType

Table Cell (td)

class	methodReturnDesc

Returns the matching collection of actuals records

Table Row (tr)

Table Head (th)

rowspan	1
class	h

Errors

Table Cell (td)

colspan	2
class	methodErrorType

NO_RECORDS

Table Cell (td)

class	methodErrorDesc

No records found

Table Row (tr)

Table Head (th)

class	h

Capabilities

Table Cell (td)

colspan	3
class	capabilityDesc

Table Row (tr)

Table Head (th)

class	h

Use Cases

Table Cell (td)

colspan	3
class	usecaseDesc

Table Row (tr)

Table Head (th)

class	h

Comments/Feedback

Table Cell (td)

colspan	3
class	commentsDesc

Table Row (tr)

Back to Operations

...

Child pages

Versions Compared

Old Version 2

New Version Current

Key

Search

CO Metadata

Summary

Drill-down