org.alfresco.module.org_alfresco_module_rm.audit

Class RecordsManagementAuditQueryParameters

java.lang.Object

org.alfresco.module.org_alfresco_module_rm.audit.RecordsManagementAuditQueryParameters

@AlfrescoPublicApi
public final class RecordsManagementAuditQueryParameters
extends Object

Class to represent the parameters for a Records Management audit log query.

Author:

Gavin Cornwell

Constructor Summary

Constructors

Constructor and Description
RecordsManagementAuditQueryParameters() Default constructor.

Method Summary

Modifier and Type	Method and Description
Date	getDateFrom()
Date	getDateTo()
String	getEvent()
int	getMaxEntries()
org.alfresco.service.cmr.repository.NodeRef	getNodeRef()
org.alfresco.service.namespace.QName	getProperty()
String	getUser()
void	setDateFrom(Date dateFrom) Restricts the retrieved audit trail to only those entries that occurred after the given date.
void	setDateTo(Date dateTo) Restricts the retrieved audit trail to only those entries that occurred before the given date.
void	setEvent(String event) Restricts the retrieved audit trail to only those entries that match the given event string.
void	setMaxEntries(int maxEntries) Restricts the retrieved audit trail to the last maxEntries entries.
void	setNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef) Restricts the retrieved audit trail to only those entries created by the give node.
void	setProperty(org.alfresco.service.namespace.QName property) Restricts the audit trail to only those entries that involve the given property.
void	setUser(String user) Restricts the retrieved audit trail to entries made by the provided user.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordsManagementAuditQueryParameters

public RecordsManagementAuditQueryParameters()

Default constructor.

Method Detail

getUser

public String getUser()

Returns:

The username to filter by

setUser

public void setUser(String user)

Restricts the retrieved audit trail to entries made by the provided user.

Parameters:

user - The username to filter by

getMaxEntries

public int getMaxEntries()

Returns:

The maximum number of audit log entries to retrieve

setMaxEntries

public void setMaxEntries(int maxEntries)

Restricts the retrieved audit trail to the last maxEntries entries.

Parameters:

maxEntries - Maximum number of entries

getNodeRef

public org.alfresco.service.cmr.repository.NodeRef getNodeRef()

Returns:

The node to get entries for

setNodeRef

public void setNodeRef(org.alfresco.service.cmr.repository.NodeRef nodeRef)

Restricts the retrieved audit trail to only those entries created by the give node.

Parameters:

nodeRef - The node to get entries for

getDateFrom

public Date getDateFrom()

Returns:

The date to retrieve entries from

setDateFrom

public void setDateFrom(Date dateFrom)

Restricts the retrieved audit trail to only those entries that occurred after the given date.

Parameters:

dateFrom - Date to retrieve entries after

getDateTo

public Date getDateTo()

Returns:

The date to retrive entries to

setDateTo

public void setDateTo(Date dateTo)

Restricts the retrieved audit trail to only those entries that occurred before the given date.

Parameters:

dateTo - Date to retrieve entries before

getEvent

public String getEvent()

Returns:

The event to retrive entries for

setEvent

public void setEvent(String event)

Restricts the retrieved audit trail to only those entries that match the given event string.

Parameters:

event - Event to retrieve entries for

getProperty

public org.alfresco.service.namespace.QName getProperty()

Returns:

The property to retrieve entries for

setProperty

public void setProperty(org.alfresco.service.namespace.QName property)

Restricts the audit trail to only those entries that involve the given property.

Parameters:

property - The property to retrieve entries for

toString

public String toString()

Overrides:

toString in class Object