Android Open Source - android-store I Store Assets

From Project

Back to project page android-store.

License

The source code is released under:

Copyright (c) 2012 SOOMLA http://project.soom.la/ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to...

If you think the Android project android-store listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.

Java Source Code

/*
 * Copyright (C) 2012-2014 Soomla Inc./*w  w w. j av a  2 s  .  c om*/
 *
 * 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.
 */

package com.soomla.store;

import com.soomla.store.domain.VirtualCategory;
import com.soomla.store.domain.virtualCurrencies.VirtualCurrency;
import com.soomla.store.domain.virtualCurrencies.VirtualCurrencyPack;
import com.soomla.store.domain.virtualGoods.VirtualGood;

/**
 * This interface represents a single game's economy. Use this interface to create your assets
 * class that will be transferred to StoreInfo upon initialization.
 */
public interface IStoreAssets {

    /** Setters and Getters */

    /**
     * Retrieves the current version of your <code>IStoreAssets</code>.
     * This value will determine if the saved data in the database will be deleted or not.
     * Bump the version every time you want to delete the old data in the DB.
     *
     * Real Game Example:
     *   Suppose that your game has a <code>VirtualGood</code> called "Hat".
     *   Let's say your game's <code>IStoreAssets</code> version is currently 0.
     *   Now you want to change the name "Hat" to "Green Hat" - you will need to bump the version
     *   from 0 to 1, in order for the new name, "Green Hat" to replace the old one, "Hat".
     *
     * Explanation: The local database on every one of your users' devices keeps your economy's
     * metadata, such as the <code>VirtualGood</code>'s name "Hat". When you change
     * <code>IStoreAssets</code>, you must bump the version in order for the data to change in
     * your users' local databases.
     *
     * You need to bump the version after ANY change in <code>IStoreAssets</code> for the local
     * database to realize it needs to refresh its data.
     *
     * @return the version of your specific <code>IStoreAssets</code>.
     */
    int getVersion();

    /**
     * Retrieves the array of your game's virtual currencies.
     *
     * @return all virtual currencies in your game
     */
    VirtualCurrency[] getCurrencies();

    /**
     * Retrieves the array of all virtual goods served by your store (all kinds in one array).
     *
     * @return all virtual goods in your game
     */
    VirtualGood[] getGoods();

    /**
     * Retrieves the array of all virtual currency packs served by your store.
     *
     * @return all virtual currency packs in your game
     */
    VirtualCurrencyPack[] getCurrencyPacks();

    /**
     * Retrieves the array of all virtual categories handled in your store.
     *
     * @return all virtual categories in your game
     */
    VirtualCategory[] getCategories();
}

Java Source Code List