com.hds.hcpaw.fss.api.model

Class PathSearchResult

java.lang.Object

com.hds.hcpaw.fss.api.model.BaseFssApiResource

com.hds.hcpaw.fss.api.model.PathSearchResult

public class PathSearchResult
extends BaseFssApiResource

Represents a list of Entry objects from a search result

Field Summary

Fields inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

UTF_8

Method Summary

Modifier and Type	Method and Description
static PathSearchResult	create(FssApiVersion apiVersion, java.util.List<Entry> entries) Returns a versioned PathSearchResult that is compatible with the specified apiVersion.
java.util.List<Entry>	getEntries() Returns the entries that match the search criteria.
static java.lang.Class<? extends PathSearchResult>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the PathSearchResult that corresponds to the specified apiVersion.
void	validate(java.lang.String fieldName, BaseFssApiResource parent) Validates this object.

Methods inherited from class com.hds.hcpaw.fss.api.model.BaseFssApiResource

badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStream

Methods inherited from class java.lang.Object

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

Method Detail

getFssApiClass

public static java.lang.Class<? extends PathSearchResult> getFssApiClass(FssApiVersion apiVersion)

Returns the Class of the PathSearchResult that corresponds to the specified apiVersion.

Parameters:

apiVersion - API version of the class to be returned

Returns:

The Class of the PathSearchResult that corresponds to the specified apiVersion.

create

public static PathSearchResult create(FssApiVersion apiVersion,
                                      java.util.List<Entry> entries)
                               throws AwUnsupportedApiVersionException

Returns a versioned PathSearchResult that is compatible with the specified apiVersion.

Parameters:

apiVersion - API version to be supported by the PathSearchResult

entries - A list of Entry objects that represent a result of searching

Returns:

The constructed PathSearchResult

Throws:

AwUnsupportedApiVersionException

validate

public void validate(java.lang.String fieldName,
                     BaseFssApiResource parent)
              throws AwJsonException

Validates this object.

Specified by:

validate in class BaseFssApiResource

Parameters:

fieldName - name of this object in the parent (containing) object. If this object is a top-level object (not contained within another object), then enter null for this parameter

parent - parent (containing) object that contains the object specified in the fieldName parameter. If this object is a top-level object (not contained within another object), then enter null for this parameter

Throws:

AwJsonException - if any validation errors occur

See Also:

BaseFssApiResource.validate(String, BaseFssApiResource)

getEntries

public java.util.List<Entry> getEntries()

Returns the entries that match the search criteria.

Returns:

the entries that match the search criteria