readFinancialSummary

Purpose

This operation reads a financial summary.

Related Information

Data Type: ParentInfo, FinancialSummaryInfo

Input

This operation requires the following input:

• financialSummaryParent: ParentInfo, with the following required information:

  • parentType

  • parentIdentifier

Return

FinancialSummaryInfo

A financial summary will be returned if this operation is successful.

Java Examples

See webservice_toolkit:

java\client\src\examples\fm\FinancialSummaryClient.java

readFinancialSummary ()

ReadFinancialSummaryDocument requestDoc = 
ReadFinancialSummaryDocument.Factory.newInstance();
ReadFinancialSummary fs = 
requestDoc.addNewReadFinancialSummary();

// Set up parent information.
ParentInfo parent =
populateParentInfo(fs.addNewFinancialSummaryParent(),
parentType, parentId);

// Read the financial summary.
FinanceServiceStub stub = new FinanceServiceStub(context,
serviceURL);
ReadFinancialSummaryResponseDocument responseDoc =
stub.readFinancialSummary(requestDoc);
ReadFinancialSummaryResponse response =
responseDoc.getReadFinancialSummaryResponse();

return response.getFinancialSummary();

ParentInfo populateParentInfo (ParentInfo parentInfo, String
parentType, Long parentId)
{
    ParentInfo.ParentType.Enum parentTypeEnum =
ParentInfo.ParentType.Enum.forString(parentType);
    parentInfo.setParentType(parentTypeEnum);

    ParentIdentifier identifier =
ParentIdentifier.Factory.newInstance();
    identifier.setId(new BigInteger(parentId.toString()));
    parentInfo.setParentIdentifier(identifier);
    return parentInfo;
}