Foundations Apex API Developer Reference

fferpcore.ArchiveService

global with sharing class ArchiveService

This class is the main entry point for the Foundations Archive Engine.

Methods

summarize

global static fferpcore.ArchiveService.SummarizeResponse summarize(fferpcore.ArchiveService.SummarizeRequest request)

Schedules in the asynchronous process to summarize the Archive Items in one or more Archive Sets.

Input Parameters

Name Type Description
request fferpcore.ArchiveService.SummarizeRequest The request object specifying the Archive Sets to be processed.

Return Value

The response object describing the result of the Summarization process.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

fferpcore.ArchiveService.SummarizeRequest request = new fferpcore.ArchiveService.SummarizeRequest();
request.ArchiveSetIds = new Set<Id>{ 'a006F00002gD3JJQA0' };
fferpcore.ArchiveService.SummarizeResponse response = fferpcore.ArchiveService.summarize(request);

summarize

global static fferpcore.ArchiveService.SummarizeChunkResponse summarize(fferpcore.ArchiveService.SummarizeChunkRequest request)

Runs the synchronous process to summarize the Archive Items in a single Archive Set Chunk.

Input Parameters

Name Type Description
request fferpcore.ArchiveService.SummarizeChunkRequest The request object specifying the Archive Set Chunks to be processed.

Return Value

The response object describing the result of the Summarization process.

Sample Code

//Note: This sample code is for demonstration purposes only. It is not intended for
//use in a production environment, is not guaranteed against defects or errors, and
//is in no way optimized or streamlined.

fferpcore.ArchiveService.SummarizeChunkRequest request = new fferpcore.ArchiveService.SummarizeChunkRequest();
request.ChunkId = 'a0g6F00000Vsjt7QAB';
fferpcore.ArchiveService.SummarizeChunkResponse response = fferpcore.ArchiveService.summarize(request);

fferpcore.ArchiveService.SummarizeRequest

global class SummarizeRequest

Summarize request object.

Properties

Name Type Description
ArchiveSetIds Set<Id> IDs of one or more Archive Sets to be summarized.

fferpcore.ArchiveService.SummarizeChunkRequest

global class SummarizeChunkRequest

Summarize Archive Set Chunk request object.

Properties

Name Type Description
ChunkId Id ID of Archive Set Chunk to be summarized.

fferpcore.ArchiveService.SummarizeResponse

global class SummarizeResponse

Summarize response object.

Properties

Name Type Description
JobIds List<Id> IDs of any jobs created to process Archive Sets.

fferpcore.ArchiveService.SummarizeChunkResponse

global class SummarizeChunkResponse

Summarize Archive Set Chunk response object.

Properties

Name Type Description
Success Boolean Whether or not the operation succeeded.
Messages List<String> Messages generated during the operation.
© Copyright 2009–2020 FinancialForce.com, inc. Confidential – all rights reserved. Various trademarks held by their respective owners.