Package com.clover.sdk.v3.apps
Class AppSuggestRecord
- java.lang.Object
-
- com.clover.sdk.GenericParcelable
-
- com.clover.sdk.v3.apps.AppSuggestRecord
-
- All Implemented Interfaces:
Parcelable
,JSONifiable
,Validator
public class AppSuggestRecord extends GenericParcelable implements Validator, JSONifiable
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AppSuggestRecord.Constraints
-
Nested classes/interfaces inherited from interface com.clover.sdk.JSONifiable
JSONifiable.Creator<T>
-
Nested classes/interfaces inherited from interface android.os.Parcelable
Parcelable.ClassLoaderCreator<T extends Object>, Parcelable.Creator<T extends Object>
-
-
Field Summary
Fields Modifier and Type Field Description static Parcelable.Creator<AppSuggestRecord>
CREATOR
static JSONifiable.Creator<AppSuggestRecord>
JSON_CREATOR
-
Fields inherited from interface android.os.Parcelable
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description AppSuggestRecord()
Constructs a new empty instance.protected
AppSuggestRecord(boolean noInit)
Constructs a new empty instance.AppSuggestRecord(AppSuggestRecord src)
Constructs a new instance that is a deep copy of the source instance.AppSuggestRecord(String json)
Constructs a new instance from the given JSON String.AppSuggestRecord(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
clearApp()
Clears the 'app' field, the 'has' method for this field will now return falsevoid
clearHighlight()
Clears the 'highlight' field, the 'has' method for this field will now return falsevoid
clearScore()
Clears the 'score' field, the 'has' method for this field will now return falseboolean
containsChanges()
Returns true if this instance has any changes.AppSuggestRecord
copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.Reference
getApp()
protected GenericClient
getGenericClient()
Map<String,String>
getHighlight()
The app attribute that matched, mapped to the matching text.JSONObject
getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.Double
getScore()
Relevancy score.boolean
hasApp()
Checks whether the 'app' field has been set, however the value could be nullboolean
hasHighlight()
Checks whether the 'highlight' field has been set, however the value could be nullboolean
hasScore()
Checks whether the 'score' field has been set, however the value could be nullboolean
isNotEmptyHighlight()
Checks whether the 'highlight' field is set and is not null and is not emptyboolean
isNotNullApp()
Checks whether the 'app' field is set and is not nullboolean
isNotNullHighlight()
Checks whether the 'highlight' field is set and is not nullboolean
isNotNullScore()
Checks whether the 'score' field is set and is not nullvoid
mergeChanges(AppSuggestRecord src)
Copy all the changed fields from the given source to this instance.void
resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.AppSuggestRecord
setApp(Reference app)
Sets the field 'app'.AppSuggestRecord
setHighlight(Map<String,String> highlight)
Sets the field 'highlight'.AppSuggestRecord
setScore(Double score)
Sets the field 'score'.void
validate()
-
Methods inherited from class com.clover.sdk.GenericParcelable
describeContents, getBundle, toString, writeToParcel
-
-
-
-
Field Detail
-
CREATOR
public static final Parcelable.Creator<AppSuggestRecord> CREATOR
-
JSON_CREATOR
public static final JSONifiable.Creator<AppSuggestRecord> JSON_CREATOR
-
-
Constructor Detail
-
AppSuggestRecord
public AppSuggestRecord()
Constructs a new empty instance.
-
AppSuggestRecord
protected AppSuggestRecord(boolean noInit)
Constructs a new empty instance.
-
AppSuggestRecord
public AppSuggestRecord(String json) throws IllegalArgumentException
Constructs a new instance from the given JSON String.- Throws:
IllegalArgumentException
-
AppSuggestRecord
public AppSuggestRecord(JSONObject jsonObject)
Construct a new instance backed by the given JSONObject, the parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
AppSuggestRecord
public AppSuggestRecord(AppSuggestRecord src)
Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
-
-
Method Detail
-
getApp
public Reference getApp()
-
getHighlight
public Map<String,String> getHighlight()
The app attribute that matched, mapped to the matching text.
-
getScore
public Double getScore()
Relevancy score.
-
getGenericClient
protected GenericClient getGenericClient()
- Specified by:
getGenericClient
in classGenericParcelable
-
getJSONObject
public JSONObject getJSONObject()
Returns the internal JSONObject backing this instance, the return value is not a copy so changes to it will be reflected in this instance and vice-versa.- Specified by:
getJSONObject
in interfaceJSONifiable
-
isNotNullApp
public boolean isNotNullApp()
Checks whether the 'app' field is set and is not null
-
isNotNullHighlight
public boolean isNotNullHighlight()
Checks whether the 'highlight' field is set and is not null
-
isNotEmptyHighlight
public boolean isNotEmptyHighlight()
Checks whether the 'highlight' field is set and is not null and is not empty
-
isNotNullScore
public boolean isNotNullScore()
Checks whether the 'score' field is set and is not null
-
hasApp
public boolean hasApp()
Checks whether the 'app' field has been set, however the value could be null
-
hasHighlight
public boolean hasHighlight()
Checks whether the 'highlight' field has been set, however the value could be null
-
hasScore
public boolean hasScore()
Checks whether the 'score' field has been set, however the value could be null
-
setApp
public AppSuggestRecord setApp(Reference app)
Sets the field 'app'. The parameter is not copied so changes to it will be reflected in this instance and vice-versa.
-
setHighlight
public AppSuggestRecord setHighlight(Map<String,String> highlight)
Sets the field 'highlight'.
-
setScore
public AppSuggestRecord setScore(Double score)
Sets the field 'score'.
-
clearApp
public void clearApp()
Clears the 'app' field, the 'has' method for this field will now return false
-
clearHighlight
public void clearHighlight()
Clears the 'highlight' field, the 'has' method for this field will now return false
-
clearScore
public void clearScore()
Clears the 'score' field, the 'has' method for this field will now return false
-
containsChanges
public boolean containsChanges()
Returns true if this instance has any changes.
-
resetChangeLog
public void resetChangeLog()
Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
-
copyChanges
public AppSuggestRecord copyChanges()
Create a copy of this instance that contains only fields that were set after the constructor was called.
-
mergeChanges
public void mergeChanges(AppSuggestRecord src)
Copy all the changed fields from the given source to this instance.
-
-