BrightSide Workbench Full Report + Source Code
org.turro.entities.IElephantEntity Interface Reference
Inheritance diagram for org.turro.entities.IElephantEntity:

Public Member Functions

IElephantEntity getController (String entityPath)
 
IElephantEntity getController (Object entity)
 
boolean isEmpty ()
 
String getTreeLabel ()
 
String getStringId ()
 
Object getEntity ()
 
String getName ()
 
String getLabel ()
 
String getNameOrLabel ()
 
String getDescription ()
 
Object getLabelCtrl ()
 
String getImage ()
 
String getRoot ()
 
String getPath ()
 
String getHierarchicalPath ()
 
IElephantEntity getParent ()
 
List< IElephantEntitygetChildren ()
 
String getExtendedPath ()
 
File getFile ()
 
boolean showPath ()
 
boolean showEntity ()
 
boolean canEdit (IContact contact)
 
boolean canPublish (IContact contact)
 
Collection getEntitites (String search, int maxResults)
 
Collection getEntitites (String root, String search, int maxResults)
 
Collection getEntitites (String search, int maxResults, KeyValueMap kvm)
 
Collection getEntitites (String root, String search, int maxResults, KeyValueMap kvm)
 
Collection< String > getAllowedRoots ()
 
IElephantSendable getSendable ()
 
Object configureCtrl (Object ctrl, IContact contact)
 
boolean canShowInContext (IContact contact, Object relatedEntity)
 
Collection< Object > getRelatedByRole (EntityRole role, IContact contact)
 
boolean hasRelatedRole (EntityRole role, IContact contact)
 
String getExtendedWebPath ()
 
String getEntityUrl ()
 
String getMemberUrl ()
 
String getAppUrl ()
 
String getEntityUrl (LinkType type, String contextPath)
 
String getReadAllUrl (LinkType type, String contextPath)
 
String getLinkRoot ()
 
String getUserContext ()
 
Object getControl (String name, IConstructor constructor, IContact contact)
 
Object getControl (String name, String entityPath, IContact contact)
 
Object getControl (String name, IContact contact)
 
Object getParticipationControl (IConstructor constructor, ParticipationReason reason)
 
Object getParticipationControl (IConstructor constructor, IContact contact, ParticipationReason reason)
 
String parseSpamCtrl (IConstructor constructor)
 
String parseFollowCtrl (IConstructor constructor)
 
EntitySet getAllChildren ()
 
Script getActorScript ()
 
boolean isActor (String actor)
 
boolean isActor (IContact contact, String actor)
 
ConceptPermission getConceptPermission (String name)
 
Folder getDeliverables ()
 
Object getObject (Path entityPath)
 
IElephantEntity getMain (Object entity)
 

Static Public Attributes

static final String EMPTY_ID = "#"
 
static final String PATH_SEPARATOR = ";"
 

Detailed Description

Author
Lluis TurrĂ³ Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 39 of file IElephantEntity.java.

Member Function Documentation

◆ canEdit()

boolean org.turro.entities.IElephantEntity.canEdit ( IContact  contact)

◆ canPublish()

boolean org.turro.entities.IElephantEntity.canPublish ( IContact  contact)

◆ canShowInContext()

boolean org.turro.entities.IElephantEntity.canShowInContext ( IContact  contact,
Object  relatedEntity 
)

Checks whether the related entity can be shown to the given contact.

Parameters
contactthe contact to be checked against.
relatedEntitythe related entity to be shown.
Returns
true if can be shown.

Implemented in org.turro.entities.EmptyController, org.turro.entities.StudentsEntities, org.turro.entities.ElephantEntities, org.turro.entities.AllianceEntities, org.turro.entities.PublicationEntities, org.turro.entitites.DossierEntities, org.turro.entities.CrmEntities, org.turro.entities.AttachEntities, org.turro.entities.ContactEntities, and org.turro.entities.FinancialsEntities.

Here is the caller graph for this function:

◆ configureCtrl()

Object org.turro.entities.IElephantEntity.configureCtrl ( Object  ctrl,
IContact  contact 
)

◆ getActorScript()

Script org.turro.entities.IElephantEntity.getActorScript ( )

◆ getAllChildren()

EntitySet org.turro.entities.IElephantEntity.getAllChildren ( )

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getAllowedRoots()

◆ getAppUrl()

String org.turro.entities.IElephantEntity.getAppUrl ( )

Returns the app link for this entity.

Returns
the path string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

◆ getChildren()

◆ getConceptPermission()

ConceptPermission org.turro.entities.IElephantEntity.getConceptPermission ( String  name)

◆ getControl() [1/3]

Object org.turro.entities.IElephantEntity.getControl ( String  name,
IConstructor  constructor,
IContact  contact 
)

Returns a configured control based on this entity

Parameters
namecontrol name
contactcontact viewing this control
Returns
a web control

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getControl() [2/3]

Object org.turro.entities.IElephantEntity.getControl ( String  name,
IContact  contact 
)

◆ getControl() [3/3]

Object org.turro.entities.IElephantEntity.getControl ( String  name,
String  entityPath,
IContact  contact 
)

◆ getController() [1/2]

IElephantEntity org.turro.entities.IElephantEntity.getController ( Object  entity)

Gets a controller for entity.

Parameters
entitythe entity object.
Returns
the elephant entity controller.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

◆ getController() [2/2]

IElephantEntity org.turro.entities.IElephantEntity.getController ( String  entityPath)

Gets a controller for entityPath.

Parameters
entityPathrepresenting the path for entity or entity's root.
Returns
the elephant entity controller.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getDeliverables()

Folder org.turro.entities.IElephantEntity.getDeliverables ( )

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getDescription()

◆ getEntitites() [1/4]

Collection org.turro.entities.IElephantEntity.getEntitites ( String  root,
String  search,
int  maxResults 
)

◆ getEntitites() [2/4]

◆ getEntitites() [3/4]

Collection org.turro.entities.IElephantEntity.getEntitites ( String  search,
int  maxResults 
)

◆ getEntitites() [4/4]

◆ getEntity()

◆ getEntityUrl() [1/2]

String org.turro.entities.IElephantEntity.getEntityUrl ( )

Returns the web url for this entity.

Returns
the path string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getEntityUrl() [2/2]

String org.turro.entities.IElephantEntity.getEntityUrl ( LinkType  type,
String  contextPath 
)

Returns the web link for this entity.

Parameters
typeweb, member or app.
contextPathif specified, will be used instead of defaults.
Returns
the path string.

Implemented in org.turro.entities.EmptyController, org.turro.entities.StudentsEntities, org.turro.entities.ElephantEntities, and org.turro.entities.DefaultElephantEntity.

◆ getExtendedPath()

◆ getExtendedWebPath()

◆ getFile()

◆ getHierarchicalPath()

String org.turro.entities.IElephantEntity.getHierarchicalPath ( )

◆ getImage()

◆ getLabel()

◆ getLabelCtrl()

Object org.turro.entities.IElephantEntity.getLabelCtrl ( )

◆ getLinkRoot()

String org.turro.entities.IElephantEntity.getLinkRoot ( )

Returns the link root, defaults to path root.

Returns
the path string.

Implemented in org.turro.entities.EmptyController, org.turro.entities.DefaultElephantEntity, and org.turro.entitites.DossierEntities.

◆ getMain()

IElephantEntity org.turro.entities.IElephantEntity.getMain ( Object  entity)

◆ getMemberUrl()

String org.turro.entities.IElephantEntity.getMemberUrl ( )

Returns the member link for this entity.

Returns
the path string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getName()

◆ getNameOrLabel()

String org.turro.entities.IElephantEntity.getNameOrLabel ( )

Gets the entity name or label, if name is null.

Returns
the entity string name or label.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getObject()

◆ getParent()

◆ getParticipationControl() [1/2]

Object org.turro.entities.IElephantEntity.getParticipationControl ( IConstructor  constructor,
IContact  contact,
ParticipationReason  reason 
)

◆ getParticipationControl() [2/2]

Object org.turro.entities.IElephantEntity.getParticipationControl ( IConstructor  constructor,
ParticipationReason  reason 
)

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getPath()

String org.turro.entities.IElephantEntity.getPath ( )

Gets the entity's path.

Returns
the entityPath string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getReadAllUrl()

String org.turro.entities.IElephantEntity.getReadAllUrl ( LinkType  type,
String  contextPath 
)

Returns the read all web link for this type of entity.

Parameters
typeweb, member or app.
contextPathif specified, will be used instead of defaults.
Returns
the path string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

◆ getRelatedByRole()

Collection<Object> org.turro.entities.IElephantEntity.getRelatedByRole ( EntityRole  role,
IContact  contact 
)

Gets entities where contact has the specified role.

Parameters
rolethe role to conform.
contactthe contact to check.
Returns
a collection of entities.

Implemented in org.turro.entities.EmptyController, org.turro.entities.DefaultElephantEntity, and org.turro.entities.FinancialsEntities.

◆ getRoot()

String org.turro.entities.IElephantEntity.getRoot ( )

Gets the entity's root.

Returns
the entityPath root string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getSendable()

IElephantSendable org.turro.entities.IElephantEntity.getSendable ( )

Gets sendable control for entity.

Returns
the sendable control.

Implemented in org.turro.entities.EmptyController, org.turro.entities.DefaultElephantEntity, org.turro.entities.PublicationEntities, and org.turro.entities.ContactEntities.

Here is the caller graph for this function:

◆ getStringId()

String org.turro.entities.IElephantEntity.getStringId ( )

Returns de id part of the entity's path.

Returns
the id as a string.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getTreeLabel()

String org.turro.entities.IElephantEntity.getTreeLabel ( )

Returns de string label for the entity or entity's path. Usually a generic when the path is a root, or the entity's name.

Returns
the string label.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ getUserContext()

◆ hasRelatedRole()

boolean org.turro.entities.IElephantEntity.hasRelatedRole ( EntityRole  role,
IContact  contact 
)

Checks whether contact has the specified role.

Parameters
rolethe role to conform.
contactthe contact to check.
Returns
true if contact has role.

Implemented in org.turro.entities.EmptyController, org.turro.entities.DefaultElephantEntity, org.turro.entitites.DossierEntities, and org.turro.entities.FinancialsEntities.

◆ isActor() [1/2]

boolean org.turro.entities.IElephantEntity.isActor ( IContact  contact,
String  actor 
)

◆ isActor() [2/2]

boolean org.turro.entities.IElephantEntity.isActor ( String  actor)

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ isEmpty()

boolean org.turro.entities.IElephantEntity.isEmpty ( )

Is the empty controller.

Returns
true when is the empty controller.

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ parseFollowCtrl()

String org.turro.entities.IElephantEntity.parseFollowCtrl ( IConstructor  constructor)

Implemented in org.turro.entities.EmptyController, and org.turro.entities.DefaultElephantEntity.

Here is the caller graph for this function:

◆ parseSpamCtrl()

String org.turro.entities.IElephantEntity.parseSpamCtrl ( IConstructor  constructor)

◆ showEntity()

◆ showPath()

Member Data Documentation

◆ EMPTY_ID

final String org.turro.entities.IElephantEntity.EMPTY_ID = "#"
static

Definition at line 42 of file IElephantEntity.java.

◆ PATH_SEPARATOR

final String org.turro.entities.IElephantEntity.PATH_SEPARATOR = ";"
static

Definition at line 43 of file IElephantEntity.java.


The documentation for this interface was generated from the following file: