org.eclipse.dirigible.repository.api.IEntity Maven / Gradle / Ivy
/**
* Copyright (c) 2010-2018 SAP and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* SAP - initial API and implementation
*/
package org.eclipse.dirigible.repository.api;
/**
* The {@link IEntity} interface is a base interface for {@link ICollection} and
* {@link IResource}.
* It provides methods that are common for both interfaces.
*/
public interface IEntity {
/**
* Returns the repository that holds this resource.
*
* @return an {@link IRepository} instance
*/
public IRepository getRepository();
/**
* Returns the name of this entity.
*
* This is equal to the content of the path after the last slash in it.
*
* @return the name of the entity
*/
public String getName();
/**
* Returns the path of this entity.
*
* The result may not be null.
*
* Example: /repository/users/test.txt
* Example: /repository/articles
*
* @return the location
*/
public String getPath();
/**
* Returns the collection that holds this entity.
*
* The result could be null should there be no parent (i.e.
* this is the root).
*
* @return an parent {@link ICollection}
*/
public ICollection getParent();
/**
* Returns an instance of IEntityInformation through which one
* can obtain information on the current entity.
*
* This method may not return null, however, the contents of
* the returned {@link IEntityInformation} may return null
* indicating that a given information is not available.
*
* @return an {@link IEntityInformation} instance with the meta-data of the entity
* @throws RepositoryReadException
* if for some reason a connection to the backend could not be
* achieved.
*/
public IEntityInformation getInformation() throws RepositoryReadException;
/**
* Forces this entity to be created at its current path.
*
* Whether the entity will be created as a resource or a collection depends
* on whether it is an instance of {@link IResource} or {@link ICollection}.
*
* @throws RepositoryWriteException
* if for some reason a connection to the backend could not be
* achieved, or if an entity with this path already exists on
* the backend.
*/
public void create() throws RepositoryWriteException;
/**
* Removes this entity from the repository.
*
* If no such resource exists, this method does nothing.
*
* @throws RepositoryWriteException
* if for some reason a connection to the backend could not be
* achieved.
*/
public void delete() throws RepositoryWriteException;
/**
* Changes the name of this entity to the specified value.
*
* @param name
* the new name
* @throws RepositoryWriteException
* if for some reason a connection to the backend could not be achieved
*/
public void renameTo(String name) throws RepositoryWriteException;
/**
* Moves this entity to a collection at the specified path.
*
* If this entity is of type {@link ICollection}, then all child entities
* are copied too.
*
* @param path
* the new location
* @throws RepositoryWriteException
* if for some reason a connection to the backend could not be achieved
*/
public void moveTo(String path) throws RepositoryWriteException;
/**
* Copies this entity to a collection at the specified path.
*
* If this entity is of type {@link ICollection}, then all child entities
* are copied too.
*
* @param path
* the location ot be copied to
* @throws RepositoryWriteException
* if for some reason a connection to the backend could not be achieved
*/
public void copyTo(String path) throws RepositoryWriteException;
/**
* Returns whether this entity is valid and exists on the backend.
*
* @return whether this entity is already materialized
* @throws RepositoryReadException
* if for some reason a connection to the backend could not be
* achieved.
*/
public boolean exists() throws RepositoryReadException;
/**
* Returns whether this entity is empty.
*
* If the entity is a collection, implementations should check to see if it
* has any child entities.
*
* If the entity is a resource, implementations should check to see if it
* has any content.
* Note: Calling this method on a resource can be
* slow.
*
* @return whether this entity is empty
* @throws RepositoryReadException
* if for some reason a connection to the backend could not be
* achieved.
*/
public boolean isEmpty() throws RepositoryReadException;
}