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 java.lang.String
CREATED_AT
static java.lang.String
CREATED_BY_USER
static java.lang.String
ID
static java.lang.String
PARAM_INCLUDE_VALUES
static java.lang.String
VALUES_KEY
static java.lang.String
VALUES_VALUE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deleteAuditEntries(java.lang.String auditAppId, Parameters parameters)
Delete set of audit entitiesvoid
deleteAuditEntry(java.lang.String auditAppId, long auditEntryId, Parameters parameters)
Delete a single audit entry by idAuditApp
getAuditApp(java.lang.String auditAppId, Parameters parameters)
Gets a single audit application by idCollectionWithPagingInfo<AuditApp>
getAuditApps(Paging paging)
Lists audit applicationsAuditEntry
getAuditEntry(java.lang.String auditAppId, long auditEntryId, Parameters parameters)
Get a single audit entry by idCollectionWithPagingInfo<AuditEntry>
listAuditEntries(java.lang.String auditAppId, Parameters parameters)
Lists audit entriesCollectionWithPagingInfo<AuditEntry>
listAuditEntriesByNodeId(java.lang.String nodeId, Parameters parameters)
AuditApp
update(java.lang.String auditAppId, AuditApp auditApp, Parameters parameters)
Updates a single audit application by id
-
-
-
Field Detail
-
VALUES_VALUE
static final java.lang.String VALUES_VALUE
- See Also:
- Constant Field Values
-
VALUES_KEY
static final java.lang.String VALUES_KEY
- See Also:
- Constant Field Values
-
CREATED_BY_USER
static final java.lang.String CREATED_BY_USER
- See Also:
- Constant Field Values
-
CREATED_AT
static final java.lang.String CREATED_AT
- See Also:
- Constant Field Values
-
ID
static final java.lang.String ID
- See Also:
- Constant Field Values
-
PARAM_INCLUDE_VALUES
static final java.lang.String PARAM_INCLUDE_VALUES
- See Also:
- Constant Field Values
-
-
Method Detail
-
getAuditApp
AuditApp getAuditApp(java.lang.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(java.lang.String auditAppId, AuditApp auditApp, Parameters parameters)
Updates a single audit application by id- Parameters:
auditAppId
-auditApp
-parameters
-- Returns:
- an audit entry
-
getAuditEntry
AuditEntry getAuditEntry(java.lang.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(java.lang.String auditAppId, Parameters parameters)
Lists audit entries- Parameters:
auditAppId
- if null then across all audit appsparameters
-- Returns:
- Collection of audit entries
-
deleteAuditEntry
void deleteAuditEntry(java.lang.String auditAppId, long auditEntryId, Parameters parameters)
Delete a single audit entry by id- Parameters:
auditAppId
-auditEntryId
-parameters
-
-
deleteAuditEntries
void deleteAuditEntries(java.lang.String auditAppId, Parameters parameters)
Delete set of audit entities- Parameters:
auditAppId
-parameters
- - required - delete is based on "where" query
-
listAuditEntriesByNodeId
CollectionWithPagingInfo<AuditEntry> listAuditEntriesByNodeId(java.lang.String nodeId, Parameters parameters)
- Parameters:
nodeId
-parameters
-- Returns:
-
-