Package com.cheetahdigital.punchcards.core.api

Class PunchcardParams

  • All Implemented Interfaces:
    android.os.Parcelable
    public class PunchcardParams
extends BaseListQueryParams
    Class for setting the query parameters of Punchcard API All Nullable parameters means you can remove the parameter by passing a null value.

    • Field Detail

      • CREATOR

        public static final android.os.Parcelable.Creator<PunchcardParams> CREATOR

    • Constructor Detail

      • PunchcardParams

        public PunchcardParams()

      • PunchcardParams

        protected PunchcardParams​(android.os.Parcel in)

    • Method Detail

      • describeContents

        public int describeContents()
        Specified by:
        describeContents in interface android.os.Parcelable
        Overrides:
        describeContents in class BaseListQueryParams

      • writeToParcel

        public void writeToParcel​(android.os.Parcel dest,
                          int flags)
        Specified by:
        writeToParcel in interface android.os.Parcelable
        Overrides:
        writeToParcel in class BaseListQueryParams

      • setRespondable

        public void setRespondable​(@Nullable
                           java.lang.Boolean respondable)
        Set the property for respondable used in API call
        Parameters:
        respondable - true to retrieve only punchcard types that the user is allowed to obtain

      • getRespondable

        @Nullable
public java.lang.Boolean getRespondable()
        Get the value stored for respondable parameter
        Returns:
        current value of respondable parameter

      • setVirtual

        public void setVirtual​(@Nullable
                       java.lang.Boolean virtual)
        Set the property for virtual used for API call
        Parameters:
        virtual - true to include the punchcard that the user doesn't have but can avail the list

      • getVirtual

        @Nullable
public java.lang.Boolean getVirtual()
        Get the value stored for virtual parameter
        Returns:
        current value of virtual parameter

      • setDetailsSortBy

        public void setDetailsSortBy​(@Nullable
                             java.lang.String sortBy)
        Set the property for sorting that is used to arrange the list in details
        Parameters:
        sortBy - the property used for sorting the punchcard list details

      • getDetailsSortBy

        @Nullable
public java.lang.String getDetailsSortBy()
        Get the value stored for details_sort_by parameter
        Returns:
        current value of details_sort_by parameter

      • setDetailsSortOrder

        public void setDetailsSortOrder​(@Nullable
                                java.lang.String sortOrder)
        Set the property for sorting arrangement that is used to arrange the order of the list in details
        Parameters:
        sortOrder - the property used for sorting order of the punchcard list details

      • getDetailsSortOrder

        @Nullable
public java.lang.String getDetailsSortOrder()
        Get the current value stored for details_sort_dir parameter
        Returns:
        current value of details_sort_dir parameter

      • setPunches

        public void setPunches​(@Nullable
                       java.lang.Integer punches)
        Set the number of punches to be given on the punchcard
        Parameters:
        punches - number of punches to punch on a certain punchcard

      • getPunches

        @Nullable
public java.lang.Integer getPunches()
        Get the current value stored for punches parameter
        Returns:
        current value of punches parameter

      • setPunchcard

        public void setPunchcard​(@Nullable
                         java.lang.String punchcard)
        An optional parameter to specify the name of the punch card type to use
        Parameters:
        punchcard - name of the punchcard type to use

      • getPunchcard

        @Nullable
public java.lang.String getPunchcard()
        Get the current value of punchcard parameter
        Returns:
        current value of punchcard parameter

      • setPunchcardNames

        public void setPunchcardNames​(@Nullable
                              java.lang.String punchcardNames)
        A comma separated string of named punches. (If no punch qty is indicated, a default value of 1 is assumed).

        e.g. "seasonal,regular" or "seasonal:3,regular:2"

        Parameters:
        punchcardNames - punchcards that will be updated

      • getPunchcardNames

        @Nullable
public java.lang.String getPunchcardNames()
        Get the current value of punch_names parameter
        Returns:
        current value of punch_names parameter

      • setPunchcardValues

        public void setPunchcardValues​(@Nullable
                               java.lang.String punchcardValues)
        Similar to punch_names but use the code/value lookup associated to a named punch instead. (If no punch qty is indicated, a default value of 1 is assumed)

        e.g. "VAL001,SKU33456" or "VAL001:2,SKU33456:4"

        Parameters:
        punchcardValues - punchcard code/value that will be updated

      • getPunchcardValues

        @Nullable
public java.lang.String getPunchcardValues()
        Get the current value of punch_value parameter
        Returns:
        current value of punch_value parameter