com.clover.sdk.v3.entitlements.MerchantGatewayEntitlement.java Source code

Java tutorial

Introduction

Here is the source code for com.clover.sdk.v3.entitlements.MerchantGatewayEntitlement.java

Source

/**
 * Copyright (C) 2015 Clover Network, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
/**
 * Autogenerated by Avro
 * 
 * DO NOT EDIT DIRECTLY
 */

package com.clover.sdk.v3.entitlements;

import com.clover.sdk.GenericClient;

@SuppressWarnings("all")
public final class MerchantGatewayEntitlement
        implements android.os.Parcelable, com.clover.sdk.v3.Validator, com.clover.sdk.JSONifiable {

    /**
     * Unique identifier
     */
    public java.lang.String getId() {
        return genClient.cacheGet(CacheKey.id);
    }

    /**
     * Entitlement name (e.g. MASTERCARD, VISA, etc.)
     */
    public java.lang.String getName() {
        return genClient.cacheGet(CacheKey.name);
    }

    public java.lang.String getServiceEntitlementNumber() {
        return genClient.cacheGet(CacheKey.serviceEntitlementNumber);
    }

    public java.lang.String getServiceType() {
        return genClient.cacheGet(CacheKey.serviceType);
    }

    /**
     * AlphaID for entitlements. Supplied by First Data.
     */
    public java.lang.String getAlphaID() {
        return genClient.cacheGet(CacheKey.alphaID);
    }

    private enum CacheKey implements com.clover.sdk.ValueExtractorEnum<MerchantGatewayEntitlement> {
        id {
            @Override
            public Object extractValue(MerchantGatewayEntitlement instance) {
                return instance.genClient.extractOther("id", java.lang.String.class);
            }
        },
        name {
            @Override
            public Object extractValue(MerchantGatewayEntitlement instance) {
                return instance.genClient.extractOther("name", java.lang.String.class);
            }
        },
        serviceEntitlementNumber {
            @Override
            public Object extractValue(MerchantGatewayEntitlement instance) {
                return instance.genClient.extractOther("serviceEntitlementNumber", java.lang.String.class);
            }
        },
        serviceType {
            @Override
            public Object extractValue(MerchantGatewayEntitlement instance) {
                return instance.genClient.extractOther("serviceType", java.lang.String.class);
            }
        },
        alphaID {
            @Override
            public Object extractValue(MerchantGatewayEntitlement instance) {
                return instance.genClient.extractOther("alphaID", java.lang.String.class);
            }
        },;
    }

    private GenericClient<MerchantGatewayEntitlement> genClient = new GenericClient<MerchantGatewayEntitlement>(
            this);

    /**
     * Constructs a new empty instance.
     */
    public MerchantGatewayEntitlement() {
    }

    /**
     * Constructs a new instance from the given JSON String.
     */
    public MerchantGatewayEntitlement(String json) throws IllegalArgumentException {
        try {
            genClient.setJsonObject(new org.json.JSONObject(json));
        } catch (org.json.JSONException e) {
            throw new IllegalArgumentException("invalid json", e);
        }
    }

    /**
     * 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.
     */
    public MerchantGatewayEntitlement(org.json.JSONObject jsonObject) {
        genClient.setJsonObject(jsonObject);
    }

    /**
     * Constructs a new instance that is a deep copy of the source instance. It does not copy the bundle or changelog.
     */
    public MerchantGatewayEntitlement(MerchantGatewayEntitlement src) {
        if (src.genClient.getJsonObject() != null) {
            genClient.setJsonObject(com.clover.sdk.v3.JsonHelper.deepCopy(src.genClient.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.
     */
    public org.json.JSONObject getJSONObject() {
        return genClient.getJSONObject();
    }

    @Override
    public void validate() {
        genClient.validateLength(getId(), 13);

        genClient.validateNull(getName(), "name");
        genClient.validateLength(getName(), 128);

        genClient.validateLength(getServiceEntitlementNumber(), 128);

        genClient.validateLength(getServiceType(), 128);

        genClient.validateLength(getAlphaID(), 1);
    }

    /** Checks whether the 'id' field is set and is not null */
    public boolean isNotNullId() {
        return genClient.cacheValueIsNotNull(CacheKey.id);
    }

    /** Checks whether the 'name' field is set and is not null */
    public boolean isNotNullName() {
        return genClient.cacheValueIsNotNull(CacheKey.name);
    }

    /** Checks whether the 'serviceEntitlementNumber' field is set and is not null */
    public boolean isNotNullServiceEntitlementNumber() {
        return genClient.cacheValueIsNotNull(CacheKey.serviceEntitlementNumber);
    }

    /** Checks whether the 'serviceType' field is set and is not null */
    public boolean isNotNullServiceType() {
        return genClient.cacheValueIsNotNull(CacheKey.serviceType);
    }

    /** Checks whether the 'alphaID' field is set and is not null */
    public boolean isNotNullAlphaID() {
        return genClient.cacheValueIsNotNull(CacheKey.alphaID);
    }

    /** Checks whether the 'id' field has been set, however the value could be null */
    public boolean hasId() {
        return genClient.cacheHasKey(CacheKey.id);
    }

    /** Checks whether the 'name' field has been set, however the value could be null */
    public boolean hasName() {
        return genClient.cacheHasKey(CacheKey.name);
    }

    /** Checks whether the 'serviceEntitlementNumber' field has been set, however the value could be null */
    public boolean hasServiceEntitlementNumber() {
        return genClient.cacheHasKey(CacheKey.serviceEntitlementNumber);
    }

    /** Checks whether the 'serviceType' field has been set, however the value could be null */
    public boolean hasServiceType() {
        return genClient.cacheHasKey(CacheKey.serviceType);
    }

    /** Checks whether the 'alphaID' field has been set, however the value could be null */
    public boolean hasAlphaID() {
        return genClient.cacheHasKey(CacheKey.alphaID);
    }

    /**
     * Sets the field 'id'.
     */
    public MerchantGatewayEntitlement setId(java.lang.String id) {
        return genClient.setOther(id, CacheKey.id);
    }

    /**
     * Sets the field 'name'.
     */
    public MerchantGatewayEntitlement setName(java.lang.String name) {
        return genClient.setOther(name, CacheKey.name);
    }

    /**
     * Sets the field 'serviceEntitlementNumber'.
     */
    public MerchantGatewayEntitlement setServiceEntitlementNumber(java.lang.String serviceEntitlementNumber) {
        return genClient.setOther(serviceEntitlementNumber, CacheKey.serviceEntitlementNumber);
    }

    /**
     * Sets the field 'serviceType'.
     */
    public MerchantGatewayEntitlement setServiceType(java.lang.String serviceType) {
        return genClient.setOther(serviceType, CacheKey.serviceType);
    }

    /**
     * Sets the field 'alphaID'.
     */
    public MerchantGatewayEntitlement setAlphaID(java.lang.String alphaID) {
        return genClient.setOther(alphaID, CacheKey.alphaID);
    }

    /** Clears the 'id' field, the 'has' method for this field will now return false */
    public void clearId() {
        genClient.clear(CacheKey.id);
    }

    /** Clears the 'name' field, the 'has' method for this field will now return false */
    public void clearName() {
        genClient.clear(CacheKey.name);
    }

    /** Clears the 'serviceEntitlementNumber' field, the 'has' method for this field will now return false */
    public void clearServiceEntitlementNumber() {
        genClient.clear(CacheKey.serviceEntitlementNumber);
    }

    /** Clears the 'serviceType' field, the 'has' method for this field will now return false */
    public void clearServiceType() {
        genClient.clear(CacheKey.serviceType);
    }

    /** Clears the 'alphaID' field, the 'has' method for this field will now return false */
    public void clearAlphaID() {
        genClient.clear(CacheKey.alphaID);
    }

    /**
     * Returns true if this instance has any changes.
     */
    public boolean containsChanges() {
        return genClient.containsChanges();
    }

    /**
     * Reset the log of changes made to this instance, calling copyChanges() after this would return an empty instance.
     */
    public void resetChangeLog() {
        genClient.resetChangeLog();
    }

    /**
     * Create a copy of this instance that contains only fields that were set after the constructor was called.
     */
    public MerchantGatewayEntitlement copyChanges() {
        MerchantGatewayEntitlement copy = new MerchantGatewayEntitlement();
        copy.mergeChanges(this);
        copy.resetChangeLog();
        return copy;
    }

    /**
     * Copy all the changed fields from the given source to this instance.
     */
    public void mergeChanges(MerchantGatewayEntitlement src) {
        if (src.genClient.getChangeLog() != null) {
            genClient.mergeChanges(new MerchantGatewayEntitlement(src).getJSONObject(), src.genClient);
        }
    }

    /**
     * Gets a Bundle which can be used to get and set data attached to this instance. The attached Bundle will be
     * parcelled but not jsonified.
     */
    public android.os.Bundle getBundle() {
        return genClient.getBundle();
    }

    @Override
    public String toString() {
        return genClient.toString();
    }

    @Override
    public int describeContents() {
        return 0;
    }

    @Override
    public void writeToParcel(android.os.Parcel dest, int flags) {
        genClient.writeToParcel(dest, flags);
    }

    public static final android.os.Parcelable.Creator<MerchantGatewayEntitlement> CREATOR = new android.os.Parcelable.Creator<MerchantGatewayEntitlement>() {
        @Override
        public MerchantGatewayEntitlement createFromParcel(android.os.Parcel in) {
            MerchantGatewayEntitlement instance = new MerchantGatewayEntitlement(
                    com.clover.sdk.v3.JsonParcelHelper.ObjectWrapper.CREATOR.createFromParcel(in).unwrap());
            instance.genClient.setBundle(in.readBundle(getClass().getClassLoader()));
            instance.genClient.setChangeLog(in.readBundle());
            return instance;
        }

        @Override
        public MerchantGatewayEntitlement[] newArray(int size) {
            return new MerchantGatewayEntitlement[size];
        }
    };

    public static final com.clover.sdk.JSONifiable.Creator<MerchantGatewayEntitlement> JSON_CREATOR = new com.clover.sdk.JSONifiable.Creator<MerchantGatewayEntitlement>() {
        @Override
        public MerchantGatewayEntitlement create(org.json.JSONObject jsonObject) {
            return new MerchantGatewayEntitlement(jsonObject);
        }
    };

    public interface Constraints {

        public static final boolean ID_IS_REQUIRED = false;
        public static final long ID_MAX_LEN = 13;

        public static final boolean NAME_IS_REQUIRED = true;
        public static final long NAME_MAX_LEN = 128;

        public static final boolean SERVICEENTITLEMENTNUMBER_IS_REQUIRED = false;
        public static final long SERVICEENTITLEMENTNUMBER_MAX_LEN = 128;

        public static final boolean SERVICETYPE_IS_REQUIRED = false;
        public static final long SERVICETYPE_MAX_LEN = 128;

        public static final boolean ALPHAID_IS_REQUIRED = false;
        public static final long ALPHAID_MAX_LEN = 1;

    }

}