org.alfresco.rest.api

Interface Audit

All Known Implementing Classes:

AuditImpl

public interface Audit

Handles audit (applications & entries)

Author:

janv

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREATED_AT
static String	CREATED_BY_USER
static String	ID
static String	PARAM_AUDIT_APP_ID
static String	PARAM_ID
static String	PARAM_INCLUDE_VALUES
static String	VALUES_KEY
static String	VALUES_VALUE

Method Summary

Modifier and Type	Method and Description
AuditApp	getAuditApp(String auditAppId, Parameters parameters) Gets a single audit application by id
CollectionWithPagingInfo<AuditApp>	getAuditApps(Paging paging) Lists audit applications
CollectionWithPagingInfo<AuditEntry>	listAuditEntries(String auditAppId, Parameters parameters) Lists audit entries
AuditApp	update(String auditAppId, AuditApp auditApp, Parameters parameters) Updates a single audit application by id

Field Detail

PARAM_ID

static final String PARAM_ID

See Also:

Constant Field Values

PARAM_AUDIT_APP_ID

static final String PARAM_AUDIT_APP_ID

See Also:

Constant Field Values

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

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

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

Throws:

com.sun.star.auth.InvalidArgumentException