IElephantEntity.java

Go to the documentation of this file.

/*
 * Turró i Cutiller Foundation. License notice.
 * Copyright (C) 2017 Lluis Turró Cutiller <http://www.turro.org/>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
package org.turro.entities;
 
import java.io.File;
import java.util.Collection;
import java.util.List;
import org.turro.action.IElephantSendable;
import org.turro.action.LinkType;
import org.turro.collections.KeyValueMap;
import org.turro.elephant.context.IConstructor;
import org.turro.file.Folder;
import org.turro.participation.ParticipationReason;
import org.turro.path.Path;
import org.turro.plugin.contacts.IContact;
import org.turro.script.Script;
import org.turro.security.ConceptPermission;
 
public interface IElephantEntity {
  
  public static final String 
          EMPTY_ID = "#",
          PATH_SEPARATOR = ";";
  
  public IElephantEntity getController(String entityPath);
 
  public IElephantEntity getController(Object entity);
 
  public boolean isEmpty();
  
  public String getTreeLabel();
  
  public String getStringId();
  
  public Object getEntity();
  
  public String getName();
  
  public String getLabel();
  
  public String getNameOrLabel();
  
  public String getDescription();
  
  public Object getLabelCtrl();
  
  public String getImage();
  
  public String getRoot();
          
  public String getPath();
  
  public String getHierarchicalPath();
  
  public IElephantEntity getParent();
  
  public List<IElephantEntity> getChildren();
  
  @Deprecated
  public String getExtendedPath();
  
  @Deprecated
  public File getFile();
  
  public boolean showPath();
  
  public boolean showEntity();
  
  public boolean canEdit(IContact contact);
 
  public boolean canPublish(IContact contact);
 
  /* Search */
  
  public Collection getEntitites(String search, int maxResults);
  public Collection getEntitites(String root, String search, int maxResults);
  
  public Collection getEntitites(String search, int maxResults, KeyValueMap kvm);
  public Collection getEntitites(String root, String search, int maxResults, KeyValueMap kvm);
  
  /* Roots */
  
  public Collection<String> getAllowedRoots();
  
  /* Sendable */
  
  public IElephantSendable getSendable();
  
  /* Controls */
  
  public Object configureCtrl(Object ctrl, IContact contact);
  
  public boolean canShowInContext(IContact contact, Object relatedEntity);
  
  /* Roles */
  
  public Collection<Object> getRelatedByRole(EntityRole role, IContact contact);
  
  public boolean hasRelatedRole(EntityRole role, IContact contact);
  
  /* Web */
  
  public String getExtendedWebPath();  
  
  public String getEntityUrl();
 
  public String getMemberUrl();
  
  public String getAppUrl();
 
  public String getEntityUrl(LinkType type, String contextPath);
 
  public String getReadAllUrl(LinkType type, String contextPath);
 
  public String getLinkRoot();
 
  public String getUserContext();
  
  public Object getControl(String name, IConstructor constructor, IContact contact);
  public Object getControl(String name, String entityPath, IContact contact);
  public Object getControl(String name, IContact contact);
  public Object getParticipationControl(IConstructor constructor, ParticipationReason reason);
  public Object getParticipationControl(IConstructor constructor, IContact contact, ParticipationReason reason);
 
  /* Specialized participations */
  
  public String parseSpamCtrl(IConstructor constructor);
  public String parseFollowCtrl(IConstructor constructor);
  
  /* Children helpers */
  
  public EntitySet getAllChildren();
  
  /* Actors */
  
  public Script getActorScript();
  public boolean isActor(String actor);
  public boolean isActor(IContact contact, String actor);
  
  /* Concept permissions */
  
  public ConceptPermission getConceptPermission(String name);
  
  /* Deliverables */
  
  public Folder getDeliverables();
  
  /* Simple objects */
  
  public Object getObject(Path entityPath);
  public IElephantEntity getMain(Object entity);
}