com.adobe.livecycle.rightsmanagement.client.infomodel
Class EventSearchFilter

java.lang.Object
  com.adobe.livecycle.rightsmanagement.client.infomodel.EventSearchFilter

public class EventSearchFilter
extends java.lang.Object

Enables you to define search criteria that are used while searching for events. You pass this object to the searchForEvents method. To see an object of this type used in a code example, see the Searching for events using the Java API quick start in Programming with LiveCycle ES4.

Constructor Summary

EventSearchFilter()
A constructor that creates an EventSearchFilter instance.

Method Summary

java.lang.String	getDocumentId() Retrieves the document identifier of the document associated with the event.
java.lang.String	getEventCode() Retrieves the event code of the event.
java.lang.String	getEventName() Retrieves the event name of the event.
java.lang.String	getEventNamespace() Retrieves the event namespace of the event.
java.util.Date	getFirstTime() Retrieves the starting time for any policies matching the search.
java.util.Date	getLastTime() Retrieves the ending time for any policies matching the search.
java.lang.String	getPolicyId() Retrieves the policy identifier of the policy associated with the event.
java.lang.String	getUserOid() Retrieves the name of the user associated with the event.
void	setDocumentId(java.lang.String documentId) Sets the document identifier of the document associated with the event.
void	setEventCode(java.lang.String eventCode) Sets the event code of the event.
void	setEventName(java.lang.String eventName) Sets the event name of the event.
void	setEventNamespace(java.lang.String eventNamespace) Sets the event namespace of the event.
void	setFirstTime(java.util.Date firstTime) Sets the starting time for any policies matching the search.
void	setLastTime(java.util.Date lastTime) Sets the ending time for any policies matching the search.
void	setPolicyId(java.lang.String policyId) Sets the policy identifier of the policy associated with the event.
void	setUserOid(java.lang.String userOid) Sets the name of the user associated with the event.
void	setWasAllowed(java.lang.Boolean wasAllowed) Sets a Boolean value that specifies whether the event was allowed.
java.lang.Boolean	wasAllowed() Retrieves A Boolean value that specifies whether the event was allowed.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventSearchFilter

public EventSearchFilter()

A constructor that creates an EventSearchFilter instance.

Method Detail

getDocumentId

public java.lang.String getDocumentId()

Retrieves the document identifier of the document associated with the event.

Returns:

A string value that contains the document identifier.

setDocumentId

public void setDocumentId(java.lang.String documentId)

Sets the document identifier of the document associated with the event.

Parameters:

documentId - A string value that contains the document.

getEventCode

public java.lang.String getEventCode()

Retrieves the event code of the event.

Returns:

A constant that represents the type of the event. Constants are defined in the EventManager interface.

See Also:

EventManager

setEventCode

public void setEventCode(java.lang.String eventCode)

Sets the event code of the event.

Parameters:

eventCode - A constant that represents the type of the event. It must be one of the integer constants defined in the EventManager interface.

See Also:

EventManager

getEventName

public java.lang.String getEventName()

Retrieves the event name of the event.

Returns:

The name of the event.

See Also:

EventManager

setEventName

public void setEventName(java.lang.String eventName)

Sets the event name of the event.

Parameters:

eventName - A string value that specifies the name of the event.

See Also:

EventManager

getEventNamespace

public java.lang.String getEventNamespace()

Retrieves the event namespace of the event.

Returns:

The name of the event.

See Also:

EventManager

setEventNamespace

public void setEventNamespace(java.lang.String eventNamespace)

Sets the event namespace of the event.

Parameters:

eventNamespace - A String that specifies the namespace of the event.

See Also:

EventManager

getFirstTime

public java.util.Date getFirstTime()

Retrieves the starting time for any policies matching the search.

Returns:

A java.util.Date object that contains the starting time.

setFirstTime

public void setFirstTime(java.util.Date firstTime)

Sets the starting time for any policies matching the search.

Parameters:

firstTime - A java.util.Date object that specifies the starting time.

getLastTime

public java.util.Date getLastTime()

Retrieves the ending time for any policies matching the search.

Returns:

A java.util.Date that contains the ending time.

setLastTime

public void setLastTime(java.util.Date lastTime)

Sets the ending time for any policies matching the search.

Parameters:

lastTime - A java.util.Date that specifies the ending time.

getPolicyId

public java.lang.String getPolicyId()

Retrieves the policy identifier of the policy associated with the event.

Returns:

A string value that contains the policy identifier.

setPolicyId

public void setPolicyId(java.lang.String policyId)

Sets the policy identifier of the policy associated with the event.

Parameters:

policyId - A string value that contains the policy.

getUserOid

public java.lang.String getUserOid()

Retrieves the name of the user associated with the event.

Returns:

A string value that represents a user name.

setUserOid

public void setUserOid(java.lang.String userOid)

Sets the name of the user associated with the event.

Parameters:

userOid - A string value that contains the user name.

wasAllowed

public java.lang.Boolean wasAllowed()

Retrieves A Boolean value that specifies whether the event was allowed.

Returns:

A Boolean value that specifies whether the event was allowed.

setWasAllowed

public void setWasAllowed(java.lang.Boolean wasAllowed)

Sets a Boolean value that specifies whether the event was allowed.

Parameters:

wasAllowed - A Boolean value that specifies whether the event was allowed.