public abstract class SearchPathRequest extends BaseFssApiResource
UTF_8| 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.
|
badValue, badValue, fromJson, toJson, toJson, toString, validate, validateFieldInRange, validateFieldInRange, validateFieldIsNull, validateFieldNotNull, validateLocale, validateOptionalField, validateOptionalFieldList, validateRequiredField, validateRequiredFieldList, writeToOutputStreampublic static java.lang.Class<? extends SearchPathRequest> getFssApiClass(FssApiVersion apiVersion) throws AwUnsupportedApiVersionException
Class of the SearchPathRequest that corresponds to the
specified apiVersion.apiVersion - API version of the class to be returnedClass of the SearchPathRequest that corresponds to the
specified apiVersion.AwUnsupportedApiVersionExceptionpublic 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
apiVersion - API version to be supported by the SearchPathRequestpath - The path under which to match entriessubstring - The substring for which we will return matching entriesmaxResults - The maximum number of results to returnincludeDeleted - Whether or not to include deleted items in the search results.pointInTime - The point in time where the search should be done.AwUnsupportedApiVersionExceptionpublic static SearchPathRequest create(FssApiVersion apiVersion, java.io.InputStreamReader reader) throws AwJsonException, AwUnsupportedApiVersionException
apiVersion - FSS API version of the object to be read from the reader.reader - Contains the JSON string representation of a MovePathRequest.AwJsonExceptionAwUnsupportedApiVersionExceptionpublic void validate(java.lang.String fieldName,
BaseFssApiResource parent)
throws AwJsonException
validate in class BaseFssApiResourcefieldName - 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
parameterparent - 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 parameterAwJsonException - if any validation errors occurBaseFssApiResource.validate(String, BaseFssApiResource)public java.lang.String getPath()
public java.lang.String getSubstring()
public java.lang.Integer getMaxResults()
public java.lang.Boolean getIncludeDeleted()
public java.lang.Long getPointInTime()