com.hds.hcpaw.fss.api.model

Class SearchPathRequest

java.lang.Object

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

com.hds.hcpaw.fss.api.model.SearchPathRequest

public abstract class SearchPathRequest
extends BaseFssApiResource

Request for searching for entries under a path

Field Summary

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

UTF_8

Method Summary

Modifier and Type	Method and Description
static SearchPathRequest	create(FssApiVersion apiVersion, java.io.InputStreamReader reader) Constructs a SearchPathRequest from the JSON string representation contained in the reader.
static SearchPathRequest	create(FssApiVersion apiVersion, java.lang.String path, java.lang.String substring, java.lang.Integer maxResults, java.lang.Boolean includeDeleted, java.lang.Long pointInTime) Returns a versioned SearchPathRequest that is compatible with the specified apiVersion.
static java.lang.Class<? extends SearchPathRequest>	getFssApiClass(FssApiVersion apiVersion) Returns the Class of the SearchPathRequest that corresponds to the specified apiVersion.
java.lang.Boolean	getIncludeDeleted() Returns whether deleted entries will be returned in the search results.
java.lang.Integer	getMaxResults() Returns the maximum number of results the search should return, or null if not specified explicitly.
java.lang.String	getPath() Returns the path under which to search.
java.lang.Long	getPointInTime() Returns the point in time where the search should be done.
java.lang.String	getSubstring() Returns the substring that should be contained in the name of matching entries.
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 SearchPathRequest> getFssApiClass(FssApiVersion apiVersion)
                                                                   throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version of the class to be returned

Returns:

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

Throws:

AwUnsupportedApiVersionException

create

public static SearchPathRequest create(FssApiVersion apiVersion,
                                       java.lang.String path,
                                       java.lang.String substring,
                                       java.lang.Integer maxResults,
                                       java.lang.Boolean includeDeleted,
                                       java.lang.Long pointInTime)
                                throws AwUnsupportedApiVersionException

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

Parameters:

apiVersion - API version to be supported by the SearchPathRequest

path - The path under which to match entries

substring - The substring for which we will return matching entries

maxResults - The maximum number of results to return

includeDeleted - Whether or not to include deleted items in the search results.

pointInTime - The point in time where the search should be done.

Returns:

The constructed SearchPathRequest.

Throws:

AwUnsupportedApiVersionException

create

public static SearchPathRequest create(FssApiVersion apiVersion,
                                       java.io.InputStreamReader reader)
                                throws AwJsonException,
                                       AwUnsupportedApiVersionException

Constructs a SearchPathRequest from the JSON string representation contained in the reader.

Parameters:

apiVersion - FSS API version of the object to be read from the reader.

reader - Contains the JSON string representation of a MovePathRequest.

Returns:

The constructed SearchPathRequest

Throws:

AwJsonException

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)

getPath

public java.lang.String getPath()

Returns the path under which to search.

Returns:

The path under which to search

getSubstring

public java.lang.String getSubstring()

Returns the substring that should be contained in the name of matching entries.

Returns:

The substring that should be contained in the name of matching entries

getMaxResults

public java.lang.Integer getMaxResults()

Returns the maximum number of results the search should return, or null if not specified explicitly.

Returns:

the maximum number of results the search should return, or null if not specified explicitly

getIncludeDeleted

public java.lang.Boolean getIncludeDeleted()

Returns whether deleted entries will be returned in the search results.

Returns:

whether deleted entries will be returned in the search results.

getPointInTime

public java.lang.Long getPointInTime()

Returns the point in time where the search should be done.

Returns:

the point in time where the search should be done.