Thrift module: access

Module Services Data types Constants
access FetchCommunicationService
StoreCommunicationService
FetchRequest
FetchResult

Data structures

Struct: FetchResult

Key Field Type Description Requiredness Default value
1 communications list< communication.Communication > a list of Communication objects that represent the results of the request required 

Struct containing Communications from the FetchCommunicationService service.

Struct: FetchRequest

Key Field Type Description Requiredness Default value
1 communicationIds list< string > a list of Communication IDs required
2 auths string optional authorization mechanism optional 

Struct representing a request for FetchCommunicationService.

Services

Service: FetchCommunicationService

extends services.Service 
Service to fetch particular communications.

Function: FetchCommunicationService.fetch 

FetchResult fetch(FetchRequest request)
    throws services.ServicesException

Function: FetchCommunicationService.getCommunicationIDs 

list<string> getCommunicationIDs(i64 offset,
                                 i64 count)
    throws services.NotImplementedException

Get a list of 'count' Communication IDs starting at 'offset'.  Implementations
that do not provide this should throw an exception.

Function: FetchCommunicationService.getCommunicationCount 

i64 getCommunicationCount()
    throws services.NotImplementedException

Get the number of Communications this service searches over.  Implementations
that do not provide this should throw an exception.

Service: StoreCommunicationService

extends services.Service 
A service that exists so that clients can store Concrete data
structures to implementing servers.

Implement this if you are creating an analytic that wishes to
store its results back to a server. That server may perform
validation, write the new layers to a database, and so forth.

Function: StoreCommunicationService.store 

void store(communication.Communication communication)
    throws services.ServicesException

Store a communication to a server implementing this method.

The communication that is stored should contain the new
analytic layers you wish to append. You may also wish to call
methods that unset annotations you feel the receiver would not
find useful in order to reduce network overhead.