Package org.alfresco.rest.api

Interface Audit

All Known Implementing Classes:

AuditImpl

public interface Audit

Handles audit (applications & entries)

Author:

janv, anechifor, eknizat

Field Summary

Fields

Modifier and Type	Field	Description
static String	CREATED_AT
static String	CREATED_BY_USER
static String	ID
static String	PARAM_INCLUDE_MAX
static String	PARAM_INCLUDE_MIN
static String	PARAM_INCLUDE_VALUES
static String	VALUES_KEY
static String	VALUES_VALUE

Method Summary

Modifier and Type	Method	Description
void	deleteAuditEntries(String auditAppId, Parameters parameters)	Delete set of audit entities
void	deleteAuditEntry(String auditAppId, long auditEntryId, Parameters parameters)	Delete a single audit entry by id
AuditApp	getAuditApp(String auditAppId, Parameters parameters)	Gets a single audit application by id
CollectionWithPagingInfo<AuditApp>	getAuditApps(Paging paging)	Lists audit applications
AuditEntry	getAuditEntry(String auditAppId, long auditEntryId, Parameters parameters)	Get a single audit entry by id
CollectionWithPagingInfo<AuditEntry>	listAuditEntries(String auditAppId, Parameters parameters)	Lists audit entries
CollectionWithPagingInfo<AuditEntry>	listAuditEntriesByNodeId(String nodeId, Parameters parameters)
AuditApp	update(String auditAppId, AuditApp auditApp, Parameters parameters)	Updates a single audit application by id

Field Detail

VALUES_VALUE

static final String VALUES_VALUE

See Also:

Constant Field Values

VALUES_KEY

static final String VALUES_KEY

See Also:

Constant Field Values

CREATED_BY_USER

static final String CREATED_BY_USER

See Also:

Constant Field Values

CREATED_AT

static final String CREATED_AT

See Also:

Constant Field Values

ID

static final String ID

See Also:

Constant Field Values

PARAM_INCLUDE_VALUES

static final String PARAM_INCLUDE_VALUES

See Also:

Constant Field Values

PARAM_INCLUDE_MAX

static final String PARAM_INCLUDE_MAX

See Also:

Constant Field Values

PARAM_INCLUDE_MIN

static final String PARAM_INCLUDE_MIN

See Also:

Constant Field Values

Method Detail

getAuditApp

AuditApp getAuditApp(String auditAppId,
                     Parameters parameters)

Gets a single audit application by id

Parameters:

auditAppId -

parameters -

Returns:

an audit app

getAuditApps

CollectionWithPagingInfo<AuditApp> getAuditApps(Paging paging)

Lists audit applications

Parameters:

paging -

Returns:

Collection of audit apps

update

AuditApp update(String auditAppId,
                AuditApp auditApp,
                Parameters parameters)

Updates a single audit application by id

Parameters:

auditAppId -

auditApp -

parameters -

Returns:

an audit entry

getAuditEntry

AuditEntry getAuditEntry(String auditAppId,
                         long auditEntryId,
                         Parameters parameters)

Get a single audit entry by id

Parameters:

auditAppId -

auditEntryId -

parameters -

Returns:

an audit entry

listAuditEntries

CollectionWithPagingInfo<AuditEntry> listAuditEntries(String auditAppId,
                                                      Parameters parameters)

Lists audit entries

Parameters:

auditAppId - if null then across all audit apps

parameters -

Returns:

Collection of audit entries

deleteAuditEntry

void deleteAuditEntry(String auditAppId,
                      long auditEntryId,
                      Parameters parameters)

Delete a single audit entry by id

Parameters:

auditAppId -

auditEntryId -

parameters -

deleteAuditEntries

void deleteAuditEntries(String auditAppId,
                        Parameters parameters)

Delete set of audit entities

Parameters:

auditAppId -

parameters - - required - delete is based on "where" query

listAuditEntriesByNodeId

CollectionWithPagingInfo<AuditEntry> listAuditEntriesByNodeId(String nodeId,
                                                              Parameters parameters)

Parameters:

nodeId -

parameters -

Returns: