com.arangodb.ArangoView Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of arangodb-java-driver Show documentation

ArangoDB Java Driver

There is a newer version: 7.15.0

/*
 * DISCLAIMER
 *
 * Copyright 2018 ArangoDB GmbH, Cologne, Germany
 *
 * 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.
 *
 * Copyright holder is ArangoDB GmbH, Cologne, Germany
 */

package com.arangodb;

import com.arangodb.entity.ViewEntity;

/**
 * Interface for operations on ArangoDB view level.
 * 
 * @see View API Documentation
 * @author Mark Vollmary
 * @since ArangoDB 3.4.0
 */
public interface ArangoView extends ArangoSerializationAccessor {

	/**
	 * The the handler of the database the collection is within
	 * 
	 * @return database handler
	 */
	public ArangoDatabase db();

	/**
	 * The name of the view
	 * 
	 * @return view name
	 */
	public String name();

	/**
	 * Checks whether the view exists.
	 * 
	 * @return true if the view exists, otherwise false
	 * @throws ArangoDBException
	 */
	boolean exists() throws ArangoDBException;

	/**
	 * Deletes the view from the database.
	 * 
	 * @see API Documentation
	 * @throws ArangoDBException
	 */
	void drop() throws ArangoDBException;

	/**
	 * Renames the view.
	 * 
	 * @see API Documentation
	 * @param newName
	 *            The new name
	 * @return information about the view
	 * @throws ArangoDBException
	 */
	ViewEntity rename(String newName) throws ArangoDBException;

	/**
	 * Returns information about the view.
	 * 
	 * @see API
	 *      Documentation
	 * @return information about the view
	 * @throws ArangoDBException
	 */
	ViewEntity getInfo() throws ArangoDBException;

}