com.cumulocity.sdk.client.audit
Class AuditRecordApiImpl

java.lang.Object
  com.cumulocity.sdk.client.audit.AuditRecordApiImpl

All Implemented Interfaces:

AuditRecordApi

public class AuditRecordApiImpl
extends Object
implements AuditRecordApi

Constructor Summary

AuditRecordApiImpl(RestConnector restConnector, TemplateUrlParser templateUrlParser, String platformApiUrl)
Deprecated.

AuditRecordApiImpl(RestConnector restConnector, TemplateUrlParser templateUrlParser, String platformApiUrl, int pageSize)

Method Summary

AuditRecordRepresentation	create(AuditRecordRepresentation representation) Creates an audit record in the platform.
AuditRecordRepresentation	getAuditRecord(GId gid) Gets an audit record by id
PagedCollectionResource<AuditRecordCollectionRepresentation>	getAuditRecords() Gets all audit records from the platform
PagedCollectionResource<AuditRecordCollectionRepresentation>	getAuditRecordsByFilter(AuditRecordFilter filter) Gets audit records from the platform based on the specified filter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuditRecordApiImpl

@Deprecated
public AuditRecordApiImpl(RestConnector restConnector,
                                     TemplateUrlParser templateUrlParser,
                                     String platformApiUrl)

Deprecated.

AuditRecordApiImpl

public AuditRecordApiImpl(RestConnector restConnector,
                          TemplateUrlParser templateUrlParser,
                          String platformApiUrl,
                          int pageSize)

Method Detail

getAuditRecord

public AuditRecordRepresentation getAuditRecord(GId gid)
                                         throws SDKException

Description copied from interface: AuditRecordApi

Gets an audit record by id

Specified by:

getAuditRecord in interface AuditRecordApi

Parameters:

gid - id of the audit record to search for

Returns:

the audit record with the given id

Throws:

SDKException - if the audit record is not found

getAuditRecords

public PagedCollectionResource<AuditRecordCollectionRepresentation> getAuditRecords()
                                                                             throws SDKException

Description copied from interface: AuditRecordApi

Gets all audit records from the platform

Specified by:

getAuditRecords in interface AuditRecordApi

Returns:

collection of audit records with paging functionality

Throws:

SDKException - if the query failed

create

public AuditRecordRepresentation create(AuditRecordRepresentation representation)
                                 throws SDKException

Description copied from interface: AuditRecordApi

Creates an audit record in the platform. The id of the audit record must not be set, since it will be generated by the platform

Specified by:

create in interface AuditRecordApi

Parameters:

representation - the audit record to be created

Returns:

the created audit record with the generated id

Throws:

SDKException - if the audit record could not be generated

getAuditRecordsByFilter

public PagedCollectionResource<AuditRecordCollectionRepresentation> getAuditRecordsByFilter(AuditRecordFilter filter)
                                                                                     throws SDKException

Description copied from interface: AuditRecordApi

Gets audit records from the platform based on the specified filter

Specified by:

getAuditRecordsByFilter in interface AuditRecordApi

Parameters:

filter - the filter criteria(s)

Returns:

collection of audit records matched by the filter with paging functionality

Throws:

SDKException - if the query failed