com.novell.db.object.bean
Class EventSearchStatusBean

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

public class EventSearchStatusBean
extends EventSearchBean

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

The description of the type is:

"An EventSearchStatus object is used to obtain the status of an existing search job without affecting the job's last-accessed time."

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
 
Nested classes/interfaces inherited from class com.novell.db.object.bean.EventSearchBean
EventSearchBean.StatusCodeType, EventSearchBean.TypeType
 
Field Summary
static String EVENTSEARCH
          The "bean name" of the Sentinel data object field 'EventSearch'.
 
Fields inherited from class com.novell.db.object.bean.EventSearchBean
AGGREGATINGOBJECT, AVAILABLECOUNT, DATERANGEEND, DATERANGESTART, FIELDS, FILTER, FOUNDCOUNT, INITIATINGHOSTNAME, INITIATINGIPADDRESS, INITIATINGUSERNAME, JOBENDTIME, JOBSTARTTIME, LASTACCESSEDTIME, MAXIMUMRESULTS, OWNER, PAGESIZE, RESULTS, STATUSCODE, TYPE
 
Constructor Summary
  EventSearchStatusBean()
          Construct an instance of the bean class.
protected EventSearchStatusBean(BeanMetaData<? extends SentinelBean> metadata)
          Constructor for use by derived classes.
 
Method Summary
 EventSearchStatusBean clone()
          Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends EventSearchStatusBean> getBeanMetaData()
          Get the metadata class instance for this type.
 String getEventSearchLink()
          Get the URL for the 'event-search' field.
 boolean isEventSearchLinkClear()
          Get whether the value for the 'event-search' URL field is clear or not.
 boolean isEventSearchLinkNull()
          Get whether the 'event-search' URL field has been set to Null or not.
 
Methods inherited from class com.novell.db.object.bean.EventSearchBean
addToFields, clearAggregatingObjectLink, clearDateRangeEnd, clearDateRangeStart, clearFields, clearFilter, clearInitiatingHostName, clearInitiatingIPAddress, clearInitiatingUserName, clearJobEndTime, clearJobStartTime, clearLastAccessedTime, clearMaximumResults, clearPageSize, clearType, getAggregatingObjectLink, getAvailableCount, getDateRangeEnd, getDateRangeStart, getFields, getFilter, getFoundCount, getInitiatingHostName, getInitiatingIPAddress, getInitiatingUserName, getJobEndTime, getJobStartTime, getLastAccessedTime, getMaximumResults, getOwnerLink, getPageSize, getResultsLink, getStatusCode, getType, isAggregatingObjectLinkClear, isAggregatingObjectLinkNull, isAvailableCountClear, isAvailableCountNull, isDateRangeEndClear, isDateRangeEndNull, isDateRangeStartClear, isDateRangeStartNull, isFieldsClear, isFieldsNull, isFilterClear, isFilterNull, isFoundCountClear, isFoundCountNull, isInitiatingHostNameClear, isInitiatingHostNameNull, isInitiatingIPAddressClear, isInitiatingIPAddressNull, isInitiatingUserNameClear, isInitiatingUserNameNull, isJobEndTimeClear, isJobEndTimeNull, isJobStartTimeClear, isJobStartTimeNull, isLastAccessedTimeClear, isLastAccessedTimeNull, isMaximumResultsClear, isMaximumResultsNull, isOwnerLinkClear, isOwnerLinkNull, isPageSizeClear, isPageSizeNull, isResultsLinkClear, isResultsLinkNull, isStatusCodeClear, isStatusCodeNull, isTypeClear, isTypeNull, setAggregatingObjectLink, setAggregatingObjectLinkNull, setDateRangeEnd, setDateRangeEndNull, setDateRangeStart, setDateRangeStartNull, setFields, setFieldsNull, setFilter, setFilterNull, setInitiatingHostName, setInitiatingHostNameNull, setInitiatingIPAddress, setInitiatingIPAddressNull, setInitiatingUserName, setInitiatingUserNameNull, setJobEndTime, setJobEndTimeNull, setJobStartTime, setJobStartTimeNull, setLastAccessedTime, setLastAccessedTimeNull, setMaximumResults, setMaximumResultsNull, setPageSize, setPageSizeNull, setType, setTypeNull
 
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

EVENTSEARCH

public static final String EVENTSEARCH
The "bean name" of the Sentinel data object field 'EventSearch'. The value is ""event-search"".

The description of the 'event-search' field is:

"The URL referencing the EventSearch object for which the EventSearchStatus object is providing the status."

See Also:
Constant Field Values
Constructor Detail

EventSearchStatusBean

public EventSearchStatusBean()
Construct an instance of the bean class.


EventSearchStatusBean

protected EventSearchStatusBean(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

getEventSearchLink

public String getEventSearchLink()
Get the URL for the 'event-search' field. The description of the 'event-search' field is:

"The URL referencing the EventSearch object for which the EventSearchStatus object is providing the status."

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

isEventSearchLinkNull

public boolean isEventSearchLinkNull()
Get whether the 'event-search' URL field has been set to Null or not. The description of the 'event-search' field is:

"The URL referencing the EventSearch object for which the EventSearchStatus object is providing the status."

See the description of Null values.

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

isEventSearchLinkClear

public boolean isEventSearchLinkClear()
Get whether the value for the 'event-search' URL field is clear or not. The description of the 'event-search' field is:

"The URL referencing the EventSearch object for which the EventSearchStatus object is providing the status."

See the description of cleared values.

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

getBeanMetaData

public static BeanMetaData<? extends EventSearchStatusBean> 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 EventSearchStatusBean clone()
Create a duplicate of this bean instance, including all field values.

Overrides:
clone in class EventSearchBean