| 1 | /**
|
|---|
| 2 | * SaveableEntity.java
|
|---|
| 3 | * Copyright (C) 2010 New Zealand Digital Library, http://expeditee.org
|
|---|
| 4 | *
|
|---|
| 5 | * This program is free software: you can redistribute it and/or modify
|
|---|
| 6 | * it under the terms of the GNU General Public License as published by
|
|---|
| 7 | * the Free Software Foundation, either version 3 of the License, or
|
|---|
| 8 | * (at your option) any later version.
|
|---|
| 9 | *
|
|---|
| 10 | * This program is distributed in the hope that it will be useful,
|
|---|
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|---|
| 13 | * GNU General Public License for more details.
|
|---|
| 14 | *
|
|---|
| 15 | * You should have received a copy of the GNU General Public License
|
|---|
| 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|---|
| 17 | */
|
|---|
| 18 |
|
|---|
| 19 | package org.expeditee.taskmanagement;
|
|---|
| 20 |
|
|---|
| 21 |
|
|---|
| 22 | /**
|
|---|
| 23 | * A saveable entity. These can be added to the SaveEntityManager.
|
|---|
| 24 | *
|
|---|
| 25 | * @author Brook Novak
|
|---|
| 26 | *
|
|---|
| 27 | * @see EntitySaveManager
|
|---|
| 28 | *
|
|---|
| 29 | */
|
|---|
| 30 | public interface SaveableEntity {
|
|---|
| 31 |
|
|---|
| 32 | /**
|
|---|
| 33 | * @return
|
|---|
| 34 | * True if the entity needs saving. False if does not need to save
|
|---|
| 35 | */
|
|---|
| 36 | public boolean doesNeedSaving();
|
|---|
| 37 |
|
|---|
| 38 | /**
|
|---|
| 39 | * Perform all save logic here. This will be invoked on a dedicated thread.
|
|---|
| 40 | */
|
|---|
| 41 | public void performSave();
|
|---|
| 42 |
|
|---|
| 43 | /**
|
|---|
| 44 | * @return
|
|---|
| 45 | * A human readable string using sentance captalization rules.
|
|---|
| 46 | * should be short, and should decribe the entity being saved.
|
|---|
| 47 | * <br>For example: "Video: "goodtimes.avi""
|
|---|
| 48 | * <br>or "Audio track".
|
|---|
| 49 | */
|
|---|
| 50 | public String getSaveName();
|
|---|
| 51 |
|
|---|
| 52 | }
|
|---|
