com.tibco.as.space

Class GetOptions

java.lang.Object

com.tibco.as.space.GetOptions

All Implemented Interfaces:

SpaceOptions<GetOptions>

public abstract class GetOptions
extends java.lang.Object
implements SpaceOptions<GetOptions>

Constructor Summary

Constructors

Constructor and Description
GetOptions()

Method Summary

Modifier and Type	Method and Description
static GetOptions	create()
com.tibco.as.space.impl.data.ASStringList	getASFields()
abstract java.util.Collection<java.lang.String>	getFields() Retrieve the fields that are returned in the result
abstract java.lang.String	getFilter() Retrieve the filter that needs to be matched for the get to succeed
abstract GetOptions	setFields(java.util.Collection<java.lang.String> fieldNames) Update the field list that are returned in the result
abstract GetOptions	setFields(java.lang.String... fieldNames) Update the field list that are returned in the result
abstract GetOptions	setFilter(java.lang.String filter) Update the filter that would be matched for the get to succeed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tibco.as.space.SpaceOptions

getClosure, getResultHandler, setClosure, setResultHandler

Constructor Detail

GetOptions

public GetOptions()

Method Detail

create

public static GetOptions create()

getFilter

public abstract java.lang.String getFilter()

Retrieve the filter that needs to be matched for the get to succeed

Returns:

The current filter

setFilter

public abstract GetOptions setFilter(java.lang.String filter)

Update the filter that would be matched for the get to succeed.

Parameters:

filter - The current filter

Returns:

The updated GetOptions object

getFields

public abstract java.util.Collection<java.lang.String> getFields()

Retrieve the fields that are returned in the result

Returns:

The list of fields

setFields

public abstract GetOptions setFields(java.util.Collection<java.lang.String> fieldNames)

Update the field list that are returned in the result

Parameters:

fieldNames - The field list

Returns:

The updated GetOptions object

setFields

public abstract GetOptions setFields(java.lang.String... fieldNames)

Update the field list that are returned in the result

Parameters:

fieldNames - Enumerated list of field names

Returns:

The updated GetOptions object

getASFields

public com.tibco.as.space.impl.data.ASStringList getASFields()