Back to project page adventure.datetime.
The source code is released under:
MIT License
If you think the Android project adventure.datetime listed in this page is inappropriate, such as containing malicious code/tools or violating the copyright, please email info at java2s dot com, thanks.
/* * Copyright (c) 2013 Andrew Fontaine, James Finlay, Jesse Tucker, Jacob Viau, and * Evan DeGraff//from w w w . j a v a 2s .c o m * * Permission is hereby granted, free of charge, to any person obtaining a copy of * this software and associated documentation files (the "Software"), to deal in * the Software without restriction, including without limitation the rights to * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of * the Software, and to permit persons to whom the Software is furnished to do so, * subject to the following conditions: * * The above copyright notice and this permission notice shall be included in all * copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ package ca.cmput301f13t03.adventure_datetime.model.Interfaces; import ca.cmput301f13t03.adventure_datetime.model.Bookmark; import ca.cmput301f13t03.adventure_datetime.model.Story; import ca.cmput301f13t03.adventure_datetime.model.StoryFragment; import java.util.ArrayList; import java.util.UUID; public interface ILocalStorage { /** * Grabs a story with the given id from the local database * * @param id The GUID of the story * * @return The Story object or null if the id doesn't exist in the database */ public abstract Story getStory(UUID id); /** * Retrieves all stories located on local storage * * @return Collection of all stories on local storage. Collection is empty if there are no stories */ public abstract ArrayList<Story> getStories(); /** * Retrieves all stories located on local storage by an author * * @return Collection of all stories on local storage by an author. Collection is empty if there are no stories by * author. * * @return Collection of all stories on local storage by an author. Collection is empty if there are no stories by * author. */ public abstract ArrayList<Story> getStoriesAuthoredBy(String author); /** * Retrieves story fragments by specific ID from local storage * * @param id The GUID of the fragment * * @return StoryFragment instance or null */ public abstract StoryFragment getStoryFragment(UUID id); /** * Retrieves all StoryFragments for a particular Story's _ID * * @param storyid The _ID for a story * * @return A Collection of StoryFragments. Empty if none exist. */ public abstract ArrayList<StoryFragment> getStoryFragments(UUID storyid); /** * Gets the Bookmark from the story ID * * @param storyid The _ID of the story * * @return The Bookmark object */ public abstract Bookmark getBookmark(UUID storyid); /** * Gets all Bookmarks in the database * * @return An ArrayList containing all bookmarks */ public abstract ArrayList<Bookmark> getAllBookmarks(); /** * Checks if a Story id is in the AuthoredStories table * * @param storyId ID of story to check for * * @return Whether or not the Story is there */ public abstract boolean getAuthoredStory(UUID storyId); /** * Gets the list of all AuthoredStories * * @return List containing all UUIDs in the AuthoredStories table */ public abstract ArrayList<UUID> getAuthoredStories(); /** * Inserts or updates a bookmark into the Database * * @param bookmark The updated bookmark to be inserted * * @return True if successful, false if not. */ public abstract boolean setBookmark(Bookmark bookmark); /** * Inserts or Updates a Story in the Database * * @param story The story to push into the Database * * @return True if successful, false if not */ public abstract boolean setStory(Story story); /** * Inserts or pushes a story fragment to the database * * @param frag The fragment to insert or update * * @return True if successful, false if not */ public abstract boolean setStoryFragment(StoryFragment frag); /** * Inserts a Story id to AuthoredStories * * @param story The story to set to Authored * * @return True if successful, false if not */ public abstract boolean setAuthoredStory(Story story); /** * Deletes a story and all it's related things (StoryFragments, Bookmark) from the database * @param id The UUID of the story * @return Roughly whether or not the story was deleted */ public boolean deleteStory(UUID id); /** * Deletes all fragments with a specific storyID from the database * @param storyID The UUID of the story * @return Roughly whether or not any fragments have been deleted */ public boolean deleteStoryFragments(UUID storyID); public boolean deleteImage(UUID imageId); /** * Deletes a fragment with a specific fragment ID * @param fragmentID The UUID of a fragment * @return Roughly whether or not a fragment was deleted */ public boolean deleteStoryFragment(UUID fragmentID); /** * Deletes all Bookmarks with a specific storyID from the database * @param storyID The UUID of the story * @return Roughly whether or not a bookmark was deleted */ public boolean deleteBookmarkByStory(UUID storyID); /** * Deletes all Bookmarks with a specific fragmentID from the database * @param fragmentID The UUID of the story * @return Roughly whether or not a bookmark was deleted */ public boolean deleteBookmarkByFragment(UUID fragmentID); /** * Deletes the story from AuthoredStories with the given UUID * @param storyID The UUID of the Story * @return Roughly whether or not an AuthoredStory was deleted */ public boolean deleteAuthoredStory(UUID storyID); }