EventSearchBean

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.novell.db.object.bean
Class EventSearchBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.EventSearchBean

Direct Known Subclasses:: EventSearchStatusBean

public class EventSearchBean
extends SentinelBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'event-search'.

The description of the type is:

"An EventSearch object is used to create and event search job and to get the status of current search jobs."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:: SentinelBean, BeanTransporter

Nested Class Summary
`static class`	`EventSearchBean.StatusCodeType` An enumerated type representing values for the field '`status`'.
`static class`	`EventSearchBean.TypeType` An enumerated type representing values for the field '`type`'.

Field Summary
`static String`	`AGGREGATINGOBJECT` The "bean name" of the Sentinel data object field 'AggregatingObject'.
`static String`	`AVAILABLECOUNT` The "bean name" of the Sentinel data object field 'AvailableCount'.
`static String`	`DATERANGEEND` The "bean name" of the Sentinel data object field 'DateRangeEnd'.
`static String`	`DATERANGESTART` The "bean name" of the Sentinel data object field 'DateRangeStart'.
`static String`	`FIELDS` The "bean name" of the Sentinel data object field 'Fields'.
`static String`	`FILTER` The "bean name" of the Sentinel data object field 'Filter'.
`static String`	`FOUNDCOUNT` The "bean name" of the Sentinel data object field 'FoundCount'.
`static String`	`INITIATINGHOSTNAME` The "bean name" of the Sentinel data object field 'InitiatingHostName'.
`static String`	`INITIATINGIPADDRESS` The "bean name" of the Sentinel data object field 'InitiatingIPAddress'.
`static String`	`INITIATINGUSERNAME` The "bean name" of the Sentinel data object field 'InitiatingUserName'.
`static String`	`JOBENDTIME` The "bean name" of the Sentinel data object field 'JobEndTime'.
`static String`	`JOBSTARTTIME` The "bean name" of the Sentinel data object field 'JobStartTime'.
`static String`	`LASTACCESSEDTIME` The "bean name" of the Sentinel data object field 'LastAccessedTime'.
`static String`	`MAXIMUMRESULTS` The "bean name" of the Sentinel data object field 'MaximumResults'.
`static String`	`OWNER` The "bean name" of the Sentinel data object field 'Owner'.
`static String`	`PAGESIZE` The "bean name" of the Sentinel data object field 'PageSize'.
`static String`	`RESULTS` The "bean name" of the Sentinel data object field 'Results'.
`static String`	`STATUSCODE` The "bean name" of the Sentinel data object field 'StatusCode'.
`static String`	`TYPE` The "bean name" of the Sentinel data object field 'Type'.

Constructor Summary
	`EventSearchBean()` Construct an instance of the bean class.
`protected`	`EventSearchBean(BeanMetaData<? extends SentinelBean> metadata)` Constructor for use by derived classes.

Method Summary
`void`	`addToFields(String value)` Add a value to the collection field '`fields`'.
`void`	`clearAggregatingObjectLink()` Clear any current URL value for the '`aggregate-obj`' field in the bean.
`void`	`clearDateRangeEnd()` Clear any current value for the '`end`' field in the bean.
`void`	`clearDateRangeStart()` Clear any current value for the '`start`' field in the bean.
`void`	`clearFields()` Clear any current value for the '`fields`' field in the bean.
`void`	`clearFilter()` Clear any current value for the '`filter`' field in the bean.
`void`	`clearInitiatingHostName()` Clear any current value for the '`InitiatingHostName`' field in the bean.
`void`	`clearInitiatingIPAddress()` Clear any current value for the '`ip`' field in the bean.
`void`	`clearInitiatingUserName()` Clear any current value for the '`init-user`' field in the bean.
`void`	`clearJobEndTime()` Clear any current value for the '`job-end`' field in the bean.
`void`	`clearJobStartTime()` Clear any current value for the '`job-start`' field in the bean.
`void`	`clearLastAccessedTime()` Clear any current value for the '`last-accessed`' field in the bean.
`void`	`clearMaximumResults()` Clear any current value for the '`max-results`' field in the bean.
`void`	`clearPageSize()` Clear any current value for the '`pgsize`' field in the bean.
`void`	`clearType()` Clear any current value for the '`type`' field in the bean.
`EventSearchBean`	`clone()` Create a duplicate of this bean instance, including all field values.
`String`	`getAggregatingObjectLink()` Get the URL for the '`aggregate-obj`' field.
`long`	`getAvailableCount()` Get the value for the '`avail`' field.
`static BeanMetaData<? extends EventSearchBean>`	`getBeanMetaData()` Get the metadata class instance for this type.
`Date`	`getDateRangeEnd()` Get the value for the '`end`' field.
`Date`	`getDateRangeStart()` Get the value for the '`start`' field.
`Collection<String>`	`getFields()` Get the value for the '`fields`' field.
`String`	`getFilter()` Get the value for the '`filter`' field.
`long`	`getFoundCount()` Get the value for the '`found`' field.
`String`	`getInitiatingHostName()` Get the value for the '`InitiatingHostName`' field.
`String`	`getInitiatingIPAddress()` Get the value for the '`ip`' field.
`String`	`getInitiatingUserName()` Get the value for the '`init-user`' field.
`Date`	`getJobEndTime()` Get the value for the '`job-end`' field.
`Date`	`getJobStartTime()` Get the value for the '`job-start`' field.
`Date`	`getLastAccessedTime()` Get the value for the '`last-accessed`' field.
`long`	`getMaximumResults()` Get the value for the '`max-results`' field.
`String`	`getOwnerLink()` Get the URL for the '`owner`' field.
`int`	`getPageSize()` Get the value for the '`pgsize`' field.
`String`	`getResultsLink()` Get the URL for the '`results`' field.
`EventSearchBean.StatusCodeType`	`getStatusCode()` Get the value for the '`status`' field.
`EventSearchBean.TypeType`	`getType()` Get the value for the '`type`' field.
`boolean`	`isAggregatingObjectLinkClear()` Get whether the value for the '`aggregate-obj`' URL field is clear or not.
`boolean`	`isAggregatingObjectLinkNull()` Get whether the '`aggregate-obj`' URL field has been set to Null or not.
`boolean`	`isAvailableCountClear()` Get whether the value for the '`avail`' field is clear or not.
`boolean`	`isAvailableCountNull()` Get whether the '`avail`' field has been set to Null or not.
`boolean`	`isDateRangeEndClear()` Get whether the value for the '`end`' field is clear or not.
`boolean`	`isDateRangeEndNull()` Get whether the '`end`' field has been set to Null or not.
`boolean`	`isDateRangeStartClear()` Get whether the value for the '`start`' field is clear or not.
`boolean`	`isDateRangeStartNull()` Get whether the '`start`' field has been set to Null or not.
`boolean`	`isFieldsClear()` Get whether the value for the '`fields`' field is clear or not.
`boolean`	`isFieldsNull()` Get whether the '`fields`' field has been set to Null or not.
`boolean`	`isFilterClear()` Get whether the value for the '`filter`' field is clear or not.
`boolean`	`isFilterNull()` Get whether the '`filter`' field has been set to Null or not.
`boolean`	`isFoundCountClear()` Get whether the value for the '`found`' field is clear or not.
`boolean`	`isFoundCountNull()` Get whether the '`found`' field has been set to Null or not.
`boolean`	`isInitiatingHostNameClear()` Get whether the value for the '`InitiatingHostName`' field is clear or not.
`boolean`	`isInitiatingHostNameNull()` Get whether the '`InitiatingHostName`' field has been set to Null or not.
`boolean`	`isInitiatingIPAddressClear()` Get whether the value for the '`ip`' field is clear or not.
`boolean`	`isInitiatingIPAddressNull()` Get whether the '`ip`' field has been set to Null or not.
`boolean`	`isInitiatingUserNameClear()` Get whether the value for the '`init-user`' field is clear or not.
`boolean`	`isInitiatingUserNameNull()` Get whether the '`init-user`' field has been set to Null or not.
`boolean`	`isJobEndTimeClear()` Get whether the value for the '`job-end`' field is clear or not.
`boolean`	`isJobEndTimeNull()` Get whether the '`job-end`' field has been set to Null or not.
`boolean`	`isJobStartTimeClear()` Get whether the value for the '`job-start`' field is clear or not.
`boolean`	`isJobStartTimeNull()` Get whether the '`job-start`' field has been set to Null or not.
`boolean`	`isLastAccessedTimeClear()` Get whether the value for the '`last-accessed`' field is clear or not.
`boolean`	`isLastAccessedTimeNull()` Get whether the '`last-accessed`' field has been set to Null or not.
`boolean`	`isMaximumResultsClear()` Get whether the value for the '`max-results`' field is clear or not.
`boolean`	`isMaximumResultsNull()` Get whether the '`max-results`' field has been set to Null or not.
`boolean`	`isOwnerLinkClear()` Get whether the value for the '`owner`' URL field is clear or not.
`boolean`	`isOwnerLinkNull()` Get whether the '`owner`' URL field has been set to Null or not.
`boolean`	`isPageSizeClear()` Get whether the value for the '`pgsize`' field is clear or not.
`boolean`	`isPageSizeNull()` Get whether the '`pgsize`' field has been set to Null or not.
`boolean`	`isResultsLinkClear()` Get whether the value for the '`results`' URL field is clear or not.
`boolean`	`isResultsLinkNull()` Get whether the '`results`' URL field has been set to Null or not.
`boolean`	`isStatusCodeClear()` Get whether the value for the '`status`' field is clear or not.
`boolean`	`isStatusCodeNull()` Get whether the '`status`' field has been set to Null or not.
`boolean`	`isTypeClear()` Get whether the value for the '`type`' field is clear or not.
`boolean`	`isTypeNull()` Get whether the '`type`' field has been set to Null or not.
`void`	`setAggregatingObjectLink(String aggregatingObject)` Set a URL value for the '`aggregate-obj`' field.
`void`	`setAggregatingObjectLinkNull()` Set to Null any current URL value for the '`aggregate-obj`' field in the bean.
`void`	`setDateRangeEnd(Date dateRangeEnd)` Set the value for the '`end`' field.
`void`	`setDateRangeEndNull()` Set to Null any current value for the '`end`' field in the bean.
`void`	`setDateRangeStart(Date dateRangeStart)` Set the value for the '`start`' field.
`void`	`setDateRangeStartNull()` Set to Null any current value for the '`start`' field in the bean.
`void`	`setFields(Collection<? extends String> fields)` Set the value for the '`fields`' field.
`void`	`setFieldsNull()` Set to Null any current value for the '`fields`' field in the bean.
`void`	`setFilter(String filter)` Set the value for the '`filter`' field.
`void`	`setFilterNull()` Set to Null any current value for the '`filter`' field in the bean.
`void`	`setInitiatingHostName(String initiatingHostName)` Set the value for the '`InitiatingHostName`' field.
`void`	`setInitiatingHostNameNull()` Set to Null any current value for the '`InitiatingHostName`' field in the bean.
`void`	`setInitiatingIPAddress(String initiatingIPAddress)` Set the value for the '`ip`' field.
`void`	`setInitiatingIPAddressNull()` Set to Null any current value for the '`ip`' field in the bean.
`void`	`setInitiatingUserName(String initiatingUserName)` Set the value for the '`init-user`' field.
`void`	`setInitiatingUserNameNull()` Set to Null any current value for the '`init-user`' field in the bean.
`void`	`setJobEndTime(Date jobEndTime)` Set the value for the '`job-end`' field.
`void`	`setJobEndTimeNull()` Set to Null any current value for the '`job-end`' field in the bean.
`void`	`setJobStartTime(Date jobStartTime)` Set the value for the '`job-start`' field.
`void`	`setJobStartTimeNull()` Set to Null any current value for the '`job-start`' field in the bean.
`void`	`setLastAccessedTime(Date lastAccessedTime)` Set the value for the '`last-accessed`' field.
`void`	`setLastAccessedTimeNull()` Set to Null any current value for the '`last-accessed`' field in the bean.
`void`	`setMaximumResults(long maximumResults)` Set the value for the '`max-results`' field.
`void`	`setMaximumResultsNull()` Set to Null any current value for the '`max-results`' field in the bean.
`void`	`setPageSize(int pageSize)` Set the value for the '`pgsize`' field.
`void`	`setPageSizeNull()` Set to Null any current value for the '`pgsize`' field in the bean.
`void`	`setType(EventSearchBean.TypeType type)` Set the value for the '`type`' field.
`void`	`setTypeNull()` Set to Null any current value for the '`type`' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean
`clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values`

Methods inherited from class java.lang.Object
`finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

AVAILABLECOUNT

public static final String AVAILABLECOUNT

The "bean name" of the Sentinel data object field 'AvailableCount'. The value is ""avail"".

The description of the 'avail' field is:

"The available count number indicates the total number of events that are currently available in the results that can be obtained from the search job."

See Also:: Constant Field Values

MAXIMUMRESULTS

public static final String MAXIMUMRESULTS

The "bean name" of the Sentinel data object field 'MaximumResults'. The value is ""max-results"".

The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

See Also:: Constant Field Values

PAGESIZE

public static final String PAGESIZE

The "bean name" of the Sentinel data object field 'PageSize'. The value is ""pgsize"".

The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

See Also:: Constant Field Values

INITIATINGUSERNAME

public static final String INITIATINGUSERNAME

The "bean name" of the Sentinel data object field 'InitiatingUserName'. The value is ""init-user"".

The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

See Also:: Constant Field Values

AGGREGATINGOBJECT

public static final String AGGREGATINGOBJECT

The "bean name" of the Sentinel data object field 'AggregatingObject'. The value is ""aggregate-obj"".

The description of the 'aggregate-obj' field is:

"An "aggregating object" is a Sentinel object that has events associated with it. Current objects are Incidents and Correlated Events. Specifying an aggregating object restricts the results of the event search to only those events associated with the aggregating object."

See Also:: Constant Field Values

INITIATINGIPADDRESS

public static final String INITIATINGIPADDRESS

The "bean name" of the Sentinel data object field 'InitiatingIPAddress'. The value is ""ip"".

The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

See Also:: Constant Field Values

OWNER

public static final String OWNER

The "bean name" of the Sentinel data object field 'Owner'. The value is ""owner"".

The description of the 'owner' field is:

"The owner link is a URL that is used to obtain the user object of the user which started the search job. The link will be empty for SYSTEM search jobs."

See Also:: Constant Field Values

FILTER

public static final String FILTER

The "bean name" of the Sentinel data object field 'Filter'. The value is ""filter"".

The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

See Also:: Constant Field Values

LASTACCESSEDTIME

public static final String LASTACCESSEDTIME

The "bean name" of the Sentinel data object field 'LastAccessedTime'. The value is ""last-accessed"".

The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

See Also:: Constant Field Values

DATERANGEEND

public static final String DATERANGEEND

The "bean name" of the Sentinel data object field 'DateRangeEnd'. The value is ""end"".

The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

See Also:: Constant Field Values

FOUNDCOUNT

public static final String FOUNDCOUNT

The "bean name" of the Sentinel data object field 'FoundCount'. The value is ""found"".

The description of the 'found' field is:

"The found count number indicates the total number of events found that match the search job parameters."

See Also:: Constant Field Values

JOBSTARTTIME

public static final String JOBSTARTTIME

The "bean name" of the Sentinel data object field 'JobStartTime'. The value is ""job-start"".

The description of the 'job-start' field is:

"The job start time is the time the search job started running."

See Also:: Constant Field Values

FIELDS

public static final String FIELDS

The "bean name" of the Sentinel data object field 'Fields'. The value is ""fields"".

The description of the 'fields' field is:

"Fields is the set of event field names whose values are to be returned in the search results. Limiting the result fields can descrease the amount of data that must be transported. The special value "none" indicates that no field values are to be returned. An empty set indicates that all field values are to be returned."

See Also:: Constant Field Values

INITIATINGHOSTNAME

public static final String INITIATINGHOSTNAME

The "bean name" of the Sentinel data object field 'InitiatingHostName'. The value is ""InitiatingHostName"".

The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

See Also:: Constant Field Values

STATUSCODE

public static final String STATUSCODE

The "bean name" of the Sentinel data object field 'StatusCode'. The value is ""status"".

The description of the 'status' field is:

"The status of a search job reflects the search job's current state. Values are: 0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable), 5 (Canceled), 6 (Access Denied)."

See Also:: Constant Field Values

RESULTS

public static final String RESULTS

The "bean name" of the Sentinel data object field 'Results'. The value is ""results"".

The description of the 'results' field is:

"The results link is a URL that is used to obtain the first page of the results of the search job."

See Also:: Constant Field Values

JOBENDTIME

public static final String JOBENDTIME

The "bean name" of the Sentinel data object field 'JobEndTime'. The value is ""job-end"".

The description of the 'job-end' field is:

"The job end time is the time the search job finished."

See Also:: Constant Field Values

DATERANGESTART

public static final String DATERANGESTART

The "bean name" of the Sentinel data object field 'DateRangeStart'. The value is ""start"".

The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

See Also:: Constant Field Values

TYPE

public static final String TYPE

The "bean name" of the Sentinel data object field 'Type'. The value is ""type"".

The description of the 'type' field is:

"The type of a search job indicates the use for which the search job is started. Values are: "SYSTEM", an internal Sentinel job. "USER", started by a Sentinel user. "REPORT", used to obtain the results for use in a report. "DATASYNC", started to obtain results that will be synchronized from the event store to a relational database. "DIST", indicating a search started on behalf of a remote search console."

See Also:: Constant Field Values

Constructor Detail

EventSearchBean

public EventSearchBean()

Construct an instance of the bean class.

EventSearchBean

protected EventSearchBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:: metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getInitiatingHostName

public String getInitiatingHostName()

Get the value for the 'InitiatingHostName' field. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: INITIATINGHOSTNAME

isInitiatingHostNameNull

public boolean isInitiatingHostNameNull()

Get whether the 'InitiatingHostName' field has been set to Null or not. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setInitiatingHostNameNull(), INITIATINGHOSTNAME

isInitiatingHostNameClear

public boolean isInitiatingHostNameClear()

Get whether the value for the 'InitiatingHostName' field is clear or not. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearInitiatingHostName(), INITIATINGHOSTNAME

setInitiatingHostName

public void setInitiatingHostName(String initiatingHostName)

Set the value for the 'InitiatingHostName' field. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

Parameters:: initiatingHostName - Value to set
See Also:: INITIATINGHOSTNAME

clearInitiatingHostName

public void clearInitiatingHostName()

Clear any current value for the 'InitiatingHostName' field in the bean. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

Using this method will not clear the server value when the bean is PUT to the server. Use the setInitiatingHostNameNull() method to clear the server's value.

See the description of cleared values.

See Also:: INITIATINGHOSTNAME

setInitiatingHostNameNull

public void setInitiatingHostNameNull()

Set to Null any current value for the 'InitiatingHostName' field in the bean. The description of the 'InitiatingHostName' field is:

"The hostname of the system that initiated the search job, if available."

Using this method will clear the server value when the bean is PUT to the server. Use the clearInitiatingHostName() method to avoid clearing the server's value.

See the description of Null values.

See Also:: INITIATINGHOSTNAME

getStatusCode

public EventSearchBean.StatusCodeType getStatusCode()

Get the value for the 'status' field. The description of the 'status' field is:

"The status of a search job reflects the search job's current state. Values are: 0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable), 5 (Canceled), 6 (Access Denied)."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: STATUSCODE

isStatusCodeNull

public boolean isStatusCodeNull()

Get whether the 'status' field has been set to Null or not. The description of the 'status' field is:

"The status of a search job reflects the search job's current state. Values are: 0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable), 5 (Canceled), 6 (Access Denied)."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: STATUSCODE

isStatusCodeClear

public boolean isStatusCodeClear()

Get whether the value for the 'status' field is clear or not. The description of the 'status' field is:

"The status of a search job reflects the search job's current state. Values are: 0 (Pending), 1 (Running), 2 (Completed), 3 (Completed with Errors), 4 (Unavailable), 5 (Canceled), 6 (Access Denied)."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: STATUSCODE

getPageSize

public int getPageSize()

Get the value for the 'pgsize' field. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: PAGESIZE

isPageSizeNull

public boolean isPageSizeNull()

Get whether the 'pgsize' field has been set to Null or not. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setPageSizeNull(), PAGESIZE

isPageSizeClear

public boolean isPageSizeClear()

Get whether the value for the 'pgsize' field is clear or not. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearPageSize(), PAGESIZE

setPageSize

public void setPageSize(int pageSize)

Set the value for the 'pgsize' field. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

Parameters:: pageSize - Value to set
See Also:: PAGESIZE

clearPageSize

public void clearPageSize()

Clear any current value for the 'pgsize' field in the bean. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

Using this method will not clear the server value when the bean is PUT to the server. Use the setPageSizeNull() method to clear the server's value.

See the description of cleared values.

See Also:: PAGESIZE

setPageSizeNull

public void setPageSizeNull()

Set to Null any current value for the 'pgsize' field in the bean. The description of the 'pgsize' field is:

"The page size specifies the number of event objects that will be returned in a single request for the results of the search job."

Using this method will clear the server value when the bean is PUT to the server. Use the clearPageSize() method to avoid clearing the server's value.

See the description of Null values.

See Also:: PAGESIZE

getLastAccessedTime

public Date getLastAccessedTime()

Get the value for the 'last-accessed' field. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: LASTACCESSEDTIME

isLastAccessedTimeNull

public boolean isLastAccessedTimeNull()

Get whether the 'last-accessed' field has been set to Null or not. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setLastAccessedTimeNull(), LASTACCESSEDTIME

isLastAccessedTimeClear

public boolean isLastAccessedTimeClear()

Get whether the value for the 'last-accessed' field is clear or not. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearLastAccessedTime(), LASTACCESSEDTIME

setLastAccessedTime

public void setLastAccessedTime(Date lastAccessedTime)

Set the value for the 'last-accessed' field. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

Parameters:: lastAccessedTime - Value to set
See Also:: LASTACCESSEDTIME

clearLastAccessedTime

public void clearLastAccessedTime()

Clear any current value for the 'last-accessed' field in the bean. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

Using this method will not clear the server value when the bean is PUT to the server. Use the setLastAccessedTimeNull() method to clear the server's value.

See the description of cleared values.

See Also:: LASTACCESSEDTIME

setLastAccessedTimeNull

public void setLastAccessedTimeNull()

Set to Null any current value for the 'last-accessed' field in the bean. The description of the 'last-accessed' field is:

"The last accessed time is the last time the search job was accessed for the purposes of getting search results."

Using this method will clear the server value when the bean is PUT to the server. Use the clearLastAccessedTime() method to avoid clearing the server's value.

See the description of Null values.

See Also:: LASTACCESSEDTIME

getAvailableCount

public long getAvailableCount()

Get the value for the 'avail' field. The description of the 'avail' field is:

"The available count number indicates the total number of events that are currently available in the results that can be obtained from the search job."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: AVAILABLECOUNT

isAvailableCountNull

public boolean isAvailableCountNull()

Get whether the 'avail' field has been set to Null or not. The description of the 'avail' field is:

"The available count number indicates the total number of events that are currently available in the results that can be obtained from the search job."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: AVAILABLECOUNT

isAvailableCountClear

public boolean isAvailableCountClear()

Get whether the value for the 'avail' field is clear or not. The description of the 'avail' field is:

"The available count number indicates the total number of events that are currently available in the results that can be obtained from the search job."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: AVAILABLECOUNT

getJobStartTime

public Date getJobStartTime()

Get the value for the 'job-start' field. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: JOBSTARTTIME

isJobStartTimeNull

public boolean isJobStartTimeNull()

Get whether the 'job-start' field has been set to Null or not. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setJobStartTimeNull(), JOBSTARTTIME

isJobStartTimeClear

public boolean isJobStartTimeClear()

Get whether the value for the 'job-start' field is clear or not. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearJobStartTime(), JOBSTARTTIME

setJobStartTime

public void setJobStartTime(Date jobStartTime)

Set the value for the 'job-start' field. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

Parameters:: jobStartTime - Value to set
See Also:: JOBSTARTTIME

clearJobStartTime

public void clearJobStartTime()

Clear any current value for the 'job-start' field in the bean. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

Using this method will not clear the server value when the bean is PUT to the server. Use the setJobStartTimeNull() method to clear the server's value.

See the description of cleared values.

See Also:: JOBSTARTTIME

setJobStartTimeNull

public void setJobStartTimeNull()

Set to Null any current value for the 'job-start' field in the bean. The description of the 'job-start' field is:

"The job start time is the time the search job started running."

Using this method will clear the server value when the bean is PUT to the server. Use the clearJobStartTime() method to avoid clearing the server's value.

See the description of Null values.

See Also:: JOBSTARTTIME

getType

public EventSearchBean.TypeType getType()

Get the value for the 'type' field. The description of the 'type' field is:

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: TYPE

isTypeNull

public boolean isTypeNull()

Get whether the 'type' field has been set to Null or not. The description of the 'type' field is:

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setTypeNull(), TYPE

isTypeClear

public boolean isTypeClear()

Get whether the value for the 'type' field is clear or not. The description of the 'type' field is:

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearType(), TYPE

setType

public void setType(EventSearchBean.TypeType type)

Set the value for the 'type' field. The description of the 'type' field is:

Parameters:: type - Value to set
See Also:: TYPE

clearType

public void clearType()

Clear any current value for the 'type' field in the bean. The description of the 'type' field is:

Using this method will not clear the server value when the bean is PUT to the server. Use the setTypeNull() method to clear the server's value.

See the description of cleared values.

See Also:: TYPE

setTypeNull

public void setTypeNull()

Set to Null any current value for the 'type' field in the bean. The description of the 'type' field is:

Using this method will clear the server value when the bean is PUT to the server. Use the clearType() method to avoid clearing the server's value.

See the description of Null values.

See Also:: TYPE

getInitiatingIPAddress

public String getInitiatingIPAddress()

Get the value for the 'ip' field. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: INITIATINGIPADDRESS

isInitiatingIPAddressNull

public boolean isInitiatingIPAddressNull()

Get whether the 'ip' field has been set to Null or not. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setInitiatingIPAddressNull(), INITIATINGIPADDRESS

isInitiatingIPAddressClear

public boolean isInitiatingIPAddressClear()

Get whether the value for the 'ip' field is clear or not. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearInitiatingIPAddress(), INITIATINGIPADDRESS

setInitiatingIPAddress

public void setInitiatingIPAddress(String initiatingIPAddress)

Set the value for the 'ip' field. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

Parameters:: initiatingIPAddress - Value to set
See Also:: INITIATINGIPADDRESS

clearInitiatingIPAddress

public void clearInitiatingIPAddress()

Clear any current value for the 'ip' field in the bean. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

Using this method will not clear the server value when the bean is PUT to the server. Use the setInitiatingIPAddressNull() method to clear the server's value.

See the description of cleared values.

See Also:: INITIATINGIPADDRESS

setInitiatingIPAddressNull

public void setInitiatingIPAddressNull()

Set to Null any current value for the 'ip' field in the bean. The description of the 'ip' field is:

"The IP address of the system from which the search job was initiated."

Using this method will clear the server value when the bean is PUT to the server. Use the clearInitiatingIPAddress() method to avoid clearing the server's value.

See the description of Null values.

See Also:: INITIATINGIPADDRESS

getAggregatingObjectLink

public String getAggregatingObjectLink()

Get the URL for the 'aggregate-obj' field. The description of the 'aggregate-obj' field is:

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: AGGREGATINGOBJECT

isAggregatingObjectLinkNull

public boolean isAggregatingObjectLinkNull()

Get whether the 'aggregate-obj' URL field has been set to Null or not. The description of the 'aggregate-obj' field is:

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setAggregatingObjectLinkNull(), AGGREGATINGOBJECT

isAggregatingObjectLinkClear

public boolean isAggregatingObjectLinkClear()

Get whether the value for the 'aggregate-obj' URL field is clear or not. The description of the 'aggregate-obj' field is:

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearAggregatingObjectLink(), AGGREGATINGOBJECT

setAggregatingObjectLink

public void setAggregatingObjectLink(String aggregatingObject)

Set a URL value for the 'aggregate-obj' field. The description of the 'aggregate-obj' field is:

Parameters:: aggregatingObject - Value to set
See Also:: AGGREGATINGOBJECT

clearAggregatingObjectLink

public void clearAggregatingObjectLink()

Clear any current URL value for the 'aggregate-obj' field in the bean. The description of the 'aggregate-obj' field is:

Using this method will not clear the server value when the bean is PUT to the server. Use the setAggregatingObjectLinkNull() method to clear the server's value.

See the description of cleared values.

See Also:: AGGREGATINGOBJECT

setAggregatingObjectLinkNull

public void setAggregatingObjectLinkNull()

Set to Null any current URL value for the 'aggregate-obj' field in the bean. The description of the 'aggregate-obj' field is:

Using this method will clear the server value when the bean is PUT to the server. Use the clearAggregatingObjectLink() method to avoid clearing the server's value.

See the description of Null values.

See Also:: AGGREGATINGOBJECT

getResultsLink

public String getResultsLink()

Get the URL for the 'results' field. The description of the 'results' field is:

"The results link is a URL that is used to obtain the first page of the results of the search job."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: RESULTS

isResultsLinkNull

public boolean isResultsLinkNull()

Get whether the 'results' URL field has been set to Null or not. The description of the 'results' field is:

"The results link is a URL that is used to obtain the first page of the results of the search job."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: RESULTS

isResultsLinkClear

public boolean isResultsLinkClear()

Get whether the value for the 'results' URL field is clear or not. The description of the 'results' field is:

"The results link is a URL that is used to obtain the first page of the results of the search job."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: RESULTS

getDateRangeStart

public Date getDateRangeStart()

Get the value for the 'start' field. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: DATERANGESTART

isDateRangeStartNull

public boolean isDateRangeStartNull()

Get whether the 'start' field has been set to Null or not. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setDateRangeStartNull(), DATERANGESTART

isDateRangeStartClear

public boolean isDateRangeStartClear()

Get whether the value for the 'start' field is clear or not. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearDateRangeStart(), DATERANGESTART

setDateRangeStart

public void setDateRangeStart(Date dateRangeStart)

Set the value for the 'start' field. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

Parameters:: dateRangeStart - Value to set
See Also:: DATERANGESTART

clearDateRangeStart

public void clearDateRangeStart()

Clear any current value for the 'start' field in the bean. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDateRangeStartNull() method to clear the server's value.

See the description of cleared values.

See Also:: DATERANGESTART

setDateRangeStartNull

public void setDateRangeStartNull()

Set to Null any current value for the 'start' field in the bean. The description of the 'start' field is:

"The start of the search date range specifies the earliest date and time for which events will be returned. The start of the range is inclusive."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDateRangeStart() method to avoid clearing the server's value.

See the description of Null values.

See Also:: DATERANGESTART

getMaximumResults

public long getMaximumResults()

Get the value for the 'max-results' field. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: MAXIMUMRESULTS

isMaximumResultsNull

public boolean isMaximumResultsNull()

Get whether the 'max-results' field has been set to Null or not. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setMaximumResultsNull(), MAXIMUMRESULTS

isMaximumResultsClear

public boolean isMaximumResultsClear()

Get whether the value for the 'max-results' field is clear or not. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearMaximumResults(), MAXIMUMRESULTS

setMaximumResults

public void setMaximumResults(long maximumResults)

Set the value for the 'max-results' field. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

Parameters:: maximumResults - Value to set
See Also:: MAXIMUMRESULTS

clearMaximumResults

public void clearMaximumResults()

Clear any current value for the 'max-results' field in the bean. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

Using this method will not clear the server value when the bean is PUT to the server. Use the setMaximumResultsNull() method to clear the server's value.

See the description of cleared values.

See Also:: MAXIMUMRESULTS

setMaximumResultsNull

public void setMaximumResultsNull()

Set to Null any current value for the 'max-results' field in the bean. The description of the 'max-results' field is:

"The maximum results number specifies the maximum event objects that the search job will return. This may be less that the maximum event objects that match the search parameters."

Using this method will clear the server value when the bean is PUT to the server. Use the clearMaximumResults() method to avoid clearing the server's value.

See the description of Null values.

See Also:: MAXIMUMRESULTS

getJobEndTime

public Date getJobEndTime()

Get the value for the 'job-end' field. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: JOBENDTIME

isJobEndTimeNull

public boolean isJobEndTimeNull()

Get whether the 'job-end' field has been set to Null or not. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setJobEndTimeNull(), JOBENDTIME

isJobEndTimeClear

public boolean isJobEndTimeClear()

Get whether the value for the 'job-end' field is clear or not. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearJobEndTime(), JOBENDTIME

setJobEndTime

public void setJobEndTime(Date jobEndTime)

Set the value for the 'job-end' field. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

Parameters:: jobEndTime - Value to set
See Also:: JOBENDTIME

clearJobEndTime

public void clearJobEndTime()

Clear any current value for the 'job-end' field in the bean. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

Using this method will not clear the server value when the bean is PUT to the server. Use the setJobEndTimeNull() method to clear the server's value.

See the description of cleared values.

See Also:: JOBENDTIME

setJobEndTimeNull

public void setJobEndTimeNull()

Set to Null any current value for the 'job-end' field in the bean. The description of the 'job-end' field is:

"The job end time is the time the search job finished."

Using this method will clear the server value when the bean is PUT to the server. Use the clearJobEndTime() method to avoid clearing the server's value.

See the description of Null values.

See Also:: JOBENDTIME

getInitiatingUserName

public String getInitiatingUserName()

Get the value for the 'init-user' field. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: INITIATINGUSERNAME

isInitiatingUserNameNull

public boolean isInitiatingUserNameNull()

Get whether the 'init-user' field has been set to Null or not. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setInitiatingUserNameNull(), INITIATINGUSERNAME

isInitiatingUserNameClear

public boolean isInitiatingUserNameClear()

Get whether the value for the 'init-user' field is clear or not. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearInitiatingUserName(), INITIATINGUSERNAME

setInitiatingUserName

public void setInitiatingUserName(String initiatingUserName)

Set the value for the 'init-user' field. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

Parameters:: initiatingUserName - Value to set
See Also:: INITIATINGUSERNAME

clearInitiatingUserName

public void clearInitiatingUserName()

Clear any current value for the 'init-user' field in the bean. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

Using this method will not clear the server value when the bean is PUT to the server. Use the setInitiatingUserNameNull() method to clear the server's value.

See the description of cleared values.

See Also:: INITIATINGUSERNAME

setInitiatingUserNameNull

public void setInitiatingUserNameNull()

Set to Null any current value for the 'init-user' field in the bean. The description of the 'init-user' field is:

"The name of the user that initiated the search job. This may be different than the Owner username if the search job is for a distributed search."

Using this method will clear the server value when the bean is PUT to the server. Use the clearInitiatingUserName() method to avoid clearing the server's value.

See the description of Null values.

See Also:: INITIATINGUSERNAME

getFilter

public String getFilter()

Get the value for the 'filter' field. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: FILTER

isFilterNull

public boolean isFilterNull()

Get whether the 'filter' field has been set to Null or not. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setFilterNull(), FILTER

isFilterClear

public boolean isFilterClear()

Get whether the value for the 'filter' field is clear or not. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearFilter(), FILTER

setFilter

public void setFilter(String filter)

Set the value for the 'filter' field. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

Parameters:: filter - Value to set
See Also:: FILTER

clearFilter

public void clearFilter()

Clear any current value for the 'filter' field in the bean. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

Using this method will not clear the server value when the bean is PUT to the server. Use the setFilterNull() method to clear the server's value.

See the description of cleared values.

See Also:: FILTER

setFilterNull

public void setFilterNull()

Set to Null any current value for the 'filter' field in the bean. The description of the 'filter' field is:

"The filter is the search query string that specifies the set of events that the event search job will return."

Using this method will clear the server value when the bean is PUT to the server. Use the clearFilter() method to avoid clearing the server's value.

See the description of Null values.

See Also:: FILTER

getDateRangeEnd

public Date getDateRangeEnd()

Get the value for the 'end' field. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: DATERANGEEND

isDateRangeEndNull

public boolean isDateRangeEndNull()

Get whether the 'end' field has been set to Null or not. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setDateRangeEndNull(), DATERANGEEND

isDateRangeEndClear

public boolean isDateRangeEndClear()

Get whether the value for the 'end' field is clear or not. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearDateRangeEnd(), DATERANGEEND

setDateRangeEnd

public void setDateRangeEnd(Date dateRangeEnd)

Set the value for the 'end' field. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

Parameters:: dateRangeEnd - Value to set
See Also:: DATERANGEEND

clearDateRangeEnd

public void clearDateRangeEnd()

Clear any current value for the 'end' field in the bean. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDateRangeEndNull() method to clear the server's value.

See the description of cleared values.

See Also:: DATERANGEEND

setDateRangeEndNull

public void setDateRangeEndNull()

Set to Null any current value for the 'end' field in the bean. The description of the 'end' field is:

"The end of the search date range specifies the latest date and time for which events will be returned. The end of the range is exclusive."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDateRangeEnd() method to avoid clearing the server's value.

See the description of Null values.

See Also:: DATERANGEEND

getFields

public Collection<String> getFields()

Get the value for the 'fields' field. The description of the 'fields' field is:

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: FIELDS

isFieldsNull

public boolean isFieldsNull()

Get whether the 'fields' field has been set to Null or not. The description of the 'fields' field is:

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: setFieldsNull(), FIELDS

isFieldsClear

public boolean isFieldsClear()

Get whether the value for the 'fields' field is clear or not. The description of the 'fields' field is:

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: clearFields(), FIELDS

setFields

public void setFields(Collection<? extends String> fields)

Set the value for the 'fields' field. The description of the 'fields' field is:

Parameters:: fields - Value to set
See Also:: FIELDS

clearFields

public void clearFields()

Clear any current value for the 'fields' field in the bean. The description of the 'fields' field is:

Using this method will not clear the server value when the bean is PUT to the server. Use the setFieldsNull() method to clear the server's value.

See the description of cleared values.

See Also:: FIELDS

setFieldsNull

public void setFieldsNull()

Set to Null any current value for the 'fields' field in the bean. The description of the 'fields' field is:

Using this method will clear the server value when the bean is PUT to the server. Use the clearFields() method to avoid clearing the server's value.

See the description of Null values.

See Also:: FIELDS

addToFields

public void addToFields(String value)

Add a value to the collection field 'fields'. The description of the 'fields' field is:

Parameters:: value - Value to add to collection.
See Also:: FIELDS

getFoundCount

public long getFoundCount()

Get the value for the 'found' field. The description of the 'found' field is:

"The found count number indicates the total number of events found that match the search job parameters."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: FOUNDCOUNT

isFoundCountNull

public boolean isFoundCountNull()

Get whether the 'found' field has been set to Null or not. The description of the 'found' field is:

"The found count number indicates the total number of events found that match the search job parameters."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: FOUNDCOUNT

isFoundCountClear

public boolean isFoundCountClear()

Get whether the value for the 'found' field is clear or not. The description of the 'found' field is:

"The found count number indicates the total number of events found that match the search job parameters."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: FOUNDCOUNT

getOwnerLink

public String getOwnerLink()

Get the URL for the 'owner' field. The description of the 'owner' field is:

"The owner link is a URL that is used to obtain the user object of the user which started the search job. The link will be empty for SYSTEM search jobs."

Returns:: The field's value in the bean instance, if any (may return null).
See Also:: OWNER

isOwnerLinkNull

public boolean isOwnerLinkNull()

Get whether the 'owner' URL field has been set to Null or not. The description of the 'owner' field is:

"The owner link is a URL that is used to obtain the user object of the user which started the search job. The link will be empty for SYSTEM search jobs."

See the description of Null values.

Returns:: true if the field value has been marked as null, false otherwise.
See Also:: OWNER

isOwnerLinkClear

public boolean isOwnerLinkClear()

Get whether the value for the 'owner' URL field is clear or not. The description of the 'owner' field is:

"The owner link is a URL that is used to obtain the user object of the user which started the search job. The link will be empty for SYSTEM search jobs."

See the description of cleared values.

Returns:: true if the field value has been cleared, false otherwise.
See Also:: OWNER

getBeanMetaData

public static BeanMetaData<? extends EventSearchBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public EventSearchBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:: clone in class Object

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.novell.db.object.bean Class EventSearchBean

AVAILABLECOUNT

MAXIMUMRESULTS

PAGESIZE

INITIATINGUSERNAME

AGGREGATINGOBJECT

INITIATINGIPADDRESS

OWNER

FILTER

LASTACCESSEDTIME

DATERANGEEND

FOUNDCOUNT

JOBSTARTTIME

FIELDS

INITIATINGHOSTNAME

STATUSCODE

RESULTS

JOBENDTIME

DATERANGESTART

TYPE

EventSearchBean

EventSearchBean

getInitiatingHostName

isInitiatingHostNameNull

isInitiatingHostNameClear

setInitiatingHostName

clearInitiatingHostName

setInitiatingHostNameNull

getStatusCode

isStatusCodeNull

isStatusCodeClear

getPageSize

isPageSizeNull

isPageSizeClear

setPageSize

clearPageSize

setPageSizeNull

getLastAccessedTime

isLastAccessedTimeNull

isLastAccessedTimeClear

setLastAccessedTime

clearLastAccessedTime

setLastAccessedTimeNull

getAvailableCount

isAvailableCountNull

isAvailableCountClear

getJobStartTime

isJobStartTimeNull

isJobStartTimeClear

setJobStartTime

clearJobStartTime

setJobStartTimeNull

getType

isTypeNull

isTypeClear

setType

clearType

setTypeNull

getInitiatingIPAddress

isInitiatingIPAddressNull

isInitiatingIPAddressClear

setInitiatingIPAddress

clearInitiatingIPAddress

setInitiatingIPAddressNull

getAggregatingObjectLink

isAggregatingObjectLinkNull

isAggregatingObjectLinkClear

setAggregatingObjectLink

clearAggregatingObjectLink

setAggregatingObjectLinkNull

getResultsLink

isResultsLinkNull

isResultsLinkClear

getDateRangeStart

isDateRangeStartNull

isDateRangeStartClear

setDateRangeStart

clearDateRangeStart

setDateRangeStartNull

getMaximumResults

com.novell.db.object.bean
Class EventSearchBean