com.aoindustries.aoserv.client.Removable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aoserv-client Show documentation

Java client for the AOServ Platform.

There is a newer version: 1.92.0

/*
 * aoserv-client - Java client for the AOServ platform.
 * Copyright (C) 2001-2013, 2016  AO Industries, Inc.
 *     [email protected]
 *     7262 Bull Pen Cir
 *     Mobile, AL 36695
 *
 * This file is part of aoserv-client.
 *
 * aoserv-client is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aoserv-client is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with aoserv-client.  If not, see .
 */
package com.aoindustries.aoserv.client;

import java.io.IOException;
import java.sql.SQLException;
import java.util.List;

/**
 * Flags an AOServObjects as being able to be removed
 * with a call to the remove() method.
 *
 * @see  AOServObject
 *
 * @author  AO Industries, Inc.
 */
public interface Removable {

	/**
	 * Lists the reasons an object may not be removed.
	 *
	 * @return  an empty List if this object may be removed, or a list of descriptions
	 */
	List getCannotRemoveReasons() throws IOException, SQLException;

	/**
	 * Removes this object, and all dependant objects, from the system.
	 */
	void remove() throws IOException, SQLException;
}