Inheritance diagram for org.turro.entities.EmptyController:

Collaboration diagram for org.turro.entities.EmptyController:

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< IElephantEntity >	getChildren ()

String	getExtendedPath ()

File	getFile ()

boolean	showPath ()

boolean	showEntity ()

boolean	canEdit (IContact contact)

boolean	canPublish (IContact contact)

Collection< String >	getAllowedRoots ()

IElephantSendable	getSendable ()

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)

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, IContact contact)

Object	getControl (String name, IConstructor constructor, IContact contact)

Object	getControl (String name, String entityPath, 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)

Additional Inherited Members
Static Public Attributes inherited from org.turro.entities.IElephantEntity
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 41 of file EmptyController.java.

Member Function Documentation

◆ canEdit()

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

Checks when contact has permissions to edit the entity.

Parameters

contact the contact checked.

Returns: true when the contact can edit.

Implements org.turro.entities.IElephantEntity.

Definition at line 149 of file EmptyController.java.

                                            {
     return false;
   }

◆ canPublish()

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

Checks when contact has permissions to see the entity.

Parameters

contact the contact checked.

Returns: true when the contact can see.

Implements org.turro.entities.IElephantEntity.

Definition at line 154 of file EmptyController.java.

                                               {
     return false;
   }

◆ canShowInContext()

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

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

Parameters

contact	the contact to be checked against.
relatedEntity	the related entity to be shown.

Returns: true if can be shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 194 of file EmptyController.java.

                                                                           {
     return true;
   }

◆ configureCtrl()

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

Configures specific entity related controls for the given contact.

Parameters

ctrl	the control to configure.
contact	the contact who receive the control.

Returns: the configured control.

Implements org.turro.entities.IElephantEntity.

Definition at line 189 of file EmptyController.java.

                                                              {
     return ctrl;
   }

◆ getActorScript()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 289 of file EmptyController.java.

                                  {
     return null;
   }

◆ getAllChildren()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 284 of file EmptyController.java.

                                     {
     return (EntitySet) Collections.EMPTY_SET;
   }

◆ getAllowedRoots()

Collection<String> org.turro.entities.EmptyController.getAllowedRoots ( )

Implements org.turro.entities.IElephantEntity.

Definition at line 159 of file EmptyController.java.

                                               {
     return Collections.EMPTY_LIST;
   }

◆ getAppUrl()

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

Returns the app link for this entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 224 of file EmptyController.java.

                             {
     return null;
   }

◆ getChildren()

List<IElephantEntity> org.turro.entities.EmptyController.getChildren ( )

Gets the children for this entity.

Returns: the children controllers.

Implements org.turro.entities.IElephantEntity.

Definition at line 124 of file EmptyController.java.

                                              {
     return Collections.EMPTY_LIST;
   }

◆ getConceptPermission()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 304 of file EmptyController.java.

                                                              {
     return null;
   }

◆ getControl() [1/3]

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

Returns a configured control based on this entity

Parameters

name	control name
contact	contact viewing this control

Returns: a web control

Implements org.turro.entities.IElephantEntity.

Definition at line 254 of file EmptyController.java.

                                                                                     {
     return null;
   }

◆ getControl() [2/3]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 249 of file EmptyController.java.

                                                           {
     return null;
   }

◆ getControl() [3/3]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 259 of file EmptyController.java.

                                                                              {
     return null;
   }

◆ getController() [1/2]

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

Gets a controller for entity.

Parameters

entity the entity object.

Returns: the elephant entity controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 49 of file EmptyController.java.

                                                       {
     return new EmptyController();
   }

◆ getController() [2/2]

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

Gets a controller for entityPath.

Parameters

entityPath representing the path for entity or entity's root.

Returns: the elephant entity controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 44 of file EmptyController.java.

                                                           {
     return new EmptyController();
   }

◆ getDeliverables()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 309 of file EmptyController.java.

                                   {
     return null;
   }

◆ getDescription()

String org.turro.entities.EmptyController.getDescription ( )

Gets the entity description.

Returns: the description string.

Implements org.turro.entities.IElephantEntity.

Definition at line 89 of file EmptyController.java.

                                  {
     return null;
   }

◆ getEntitites() [1/4]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 174 of file EmptyController.java.

                                                                              {
     return getEntitites(root, search, maxResults, new KeyValueMap(new HashMap()));
   }

Here is the call graph for this function:

◆ getEntitites() [2/4]

Collection org.turro.entities.EmptyController.getEntitites	(	String	root,
		String	search,
		int	maxResults,
		KeyValueMap	kvm
	)

Implements org.turro.entities.IElephantEntity.

Definition at line 184 of file EmptyController.java.

                                                                                               {
     return Collections.EMPTY_LIST;
   }

◆ getEntitites() [3/4]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 169 of file EmptyController.java.

                                                                 {
     return getEntitites(search, maxResults, new KeyValueMap(new HashMap()));
   }

Here is the caller graph for this function:

◆ getEntitites() [4/4]

Collection org.turro.entities.EmptyController.getEntitites	(	String	search,
		int	maxResults,
		KeyValueMap	kvm
	)

Implements org.turro.entities.IElephantEntity.

Definition at line 179 of file EmptyController.java.

                                                                                  {
     return Collections.EMPTY_LIST;
   }

◆ getEntity()

Object org.turro.entities.EmptyController.getEntity ( )

Returns the entity for this controller.

Returns: the entity's object.

Implements org.turro.entities.IElephantEntity.

Definition at line 69 of file EmptyController.java.

                             {
     return null;
   }

◆ getEntityUrl() [1/2]

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

Returns the web url for this entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 214 of file EmptyController.java.

                                {
     return null;
   }

◆ getEntityUrl() [2/2]

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

Returns the web link for this entity.

Parameters

type	web, member or app.
contextPath	if specified, will be used instead of defaults.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 229 of file EmptyController.java.

                                                                 {
     return null;
   }

◆ getExtendedPath()

String org.turro.entities.EmptyController.getExtendedPath ( )

Gets the extended path for this entity.

Returns: the extended path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 129 of file EmptyController.java.

                                   {
     return null;
   }

◆ getExtendedWebPath()

String org.turro.entities.EmptyController.getExtendedWebPath ( )

Returns a unique path for the entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 209 of file EmptyController.java.

                                      {
     return null;
   }

◆ getFile()

File org.turro.entities.EmptyController.getFile ( )

Gets the file represented by the entity.

Returns: the entity file.

Implements org.turro.entities.IElephantEntity.

Definition at line 134 of file EmptyController.java.

                         {
     return null;
   }

◆ getHierarchicalPath()

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

Gets the hierarchical path for this entity. Mostly used for sorting purposes.

Returns: the hierarchical path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 114 of file EmptyController.java.

                                       {
     return null;
   }

◆ getImage()

String org.turro.entities.EmptyController.getImage ( )

Gets the entity image based on its root.

Returns: the string image location.

Implements org.turro.entities.IElephantEntity.

Definition at line 99 of file EmptyController.java.

                            {
     return null;
   }

◆ getLabel()

String org.turro.entities.EmptyController.getLabel ( )

Gets the entity label, based on its root.

Returns: the entity string label.

Implements org.turro.entities.IElephantEntity.

Definition at line 79 of file EmptyController.java.

                            {
     return null;
   }

◆ getLabelCtrl()

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

Gets the label control, usually a clickable LabelControl class.

Returns: a clickable label control.

Implements org.turro.entities.IElephantEntity.

Definition at line 94 of file EmptyController.java.

                                {
     return null;
   }

◆ getLinkRoot()

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

Returns the link root, defaults to path root.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 239 of file EmptyController.java.

                               {
     return null;
   }

◆ getMain()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 319 of file EmptyController.java.

                                                 {
     return null;
   }

◆ getMemberUrl()

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

Returns the member link for this entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 219 of file EmptyController.java.

                                {
     return null;
   }

◆ getName()

String org.turro.entities.EmptyController.getName ( )

Gets the entity name.

Returns: the string name.

Implements org.turro.entities.IElephantEntity.

Definition at line 74 of file EmptyController.java.

                           {
     return null;
   }

◆ getNameOrLabel()

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

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

Returns: the entity string name or label.

Implements org.turro.entities.IElephantEntity.

Definition at line 84 of file EmptyController.java.

                                  {
     return null;
   }

◆ getObject()

Object org.turro.entities.EmptyController.getObject ( Path entityPath )

Implements org.turro.entities.IElephantEntity.

Definition at line 314 of file EmptyController.java.

                                            {
     return null;
   }

◆ getParent()

IElephantEntity org.turro.entities.EmptyController.getParent ( )

Gets the parent for this entity.

Returns: the parent controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 119 of file EmptyController.java.

                                      {
     return null;
   }

◆ getParticipationControl() [1/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 269 of file EmptyController.java.

                                                                                                                 {
     return null;
   }

◆ getParticipationControl() [2/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 264 of file EmptyController.java.

                                                                                               {
     return null;
   }

◆ getPath()

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

Gets the entity's path.

Returns: the entityPath string.

Implements org.turro.entities.IElephantEntity.

Definition at line 109 of file EmptyController.java.

                           {
     return null;
   }

◆ getReadAllUrl()

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

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

Parameters

type	web, member or app.
contextPath	if specified, will be used instead of defaults.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 234 of file EmptyController.java.

                                                                  {
     return null;
   }

◆ getRelatedByRole()

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

Gets entities where contact has the specified role.

Parameters

role	the role to conform.
contact	the contact to check.

Returns: a collection of entities.

Implements org.turro.entities.IElephantEntity.

Definition at line 199 of file EmptyController.java.

                                                                                 {
     return null;
   }

◆ getRoot()

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

Gets the entity's root.

Returns: the entityPath root string.

Implements org.turro.entities.IElephantEntity.

Definition at line 104 of file EmptyController.java.

                           {
     return null;
   }

◆ getSendable()

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

Gets sendable control for entity.

Returns: the sendable control.

Implements org.turro.entities.IElephantEntity.

Definition at line 164 of file EmptyController.java.

                                          {
     return null;
   }

◆ getStringId()

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

Returns de id part of the entity's path.

Returns: the id as a string.

Implements org.turro.entities.IElephantEntity.

Definition at line 64 of file EmptyController.java.

                               {
     return EMPTY_ID;
   }

◆ getTreeLabel()

String org.turro.entities.EmptyController.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.

Implements org.turro.entities.IElephantEntity.

Definition at line 59 of file EmptyController.java.

                                {
     return null;
   }

◆ getUserContext()

String org.turro.entities.EmptyController.getUserContext ( )

Returns the user context for this type of entity

Returns: the path string;

Implements org.turro.entities.IElephantEntity.

Definition at line 244 of file EmptyController.java.

                                  {
     return "/user";
   }

◆ hasRelatedRole()

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

Checks whether contact has the specified role.

Parameters

role	the role to conform.
contact	the contact to check.

Returns: true if contact has role.

Implements org.turro.entities.IElephantEntity.

Definition at line 204 of file EmptyController.java.

                                                                    {
     return false;
   }

◆ isActor() [1/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 299 of file EmptyController.java.

                                                          {
     return false;
   }

◆ isActor() [2/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 294 of file EmptyController.java.

                                        {
     return false;
   }

◆ isEmpty()

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

Is the empty controller.

Returns: true when is the empty controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 54 of file EmptyController.java.

                            {
     return true;
   }

◆ parseFollowCtrl()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 279 of file EmptyController.java.

                                                           {
     return null;
   }

◆ parseSpamCtrl()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 274 of file EmptyController.java.

                                                         {
     return null;
   }

◆ showEntity()

boolean org.turro.entities.EmptyController.showEntity ( )

Shows the view for the entity.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 144 of file EmptyController.java.

                               {
     return false;
   }

◆ showPath()

boolean org.turro.entities.EmptyController.showPath ( )

Shows the view for this path.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 139 of file EmptyController.java.

                             {
     return false;
   }

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

EmptyController.java

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ canEdit()

◆ canPublish()

◆ canShowInContext()

◆ configureCtrl()

◆ getActorScript()

◆ getAllChildren()

◆ getAllowedRoots()

◆ getAppUrl()

◆ getChildren()

◆ getConceptPermission()

◆ getControl() [1/3]

◆ getControl() [2/3]

◆ getControl() [3/3]

◆ getController() [1/2]

◆ getController() [2/2]

◆ getDeliverables()

◆ getDescription()

◆ getEntitites() [1/4]

◆ getEntitites() [2/4]

◆ getEntitites() [3/4]

◆ getEntitites() [4/4]

◆ getEntity()

◆ getEntityUrl() [1/2]

◆ getEntityUrl() [2/2]

◆ getExtendedPath()

◆ getExtendedWebPath()

◆ getFile()

◆ getHierarchicalPath()

◆ getImage()

◆ getLabel()

◆ getLabelCtrl()

◆ getLinkRoot()

◆ getMain()

◆ getMemberUrl()

◆ getName()

◆ getNameOrLabel()

◆ getObject()

◆ getParent()

◆ getParticipationControl() [1/2]

◆ getParticipationControl() [2/2]

◆ getPath()

◆ getReadAllUrl()

◆ getRelatedByRole()

◆ getRoot()

◆ getSendable()

◆ getStringId()

◆ getTreeLabel()

◆ getUserContext()

◆ hasRelatedRole()

◆ isActor() [1/2]

◆ isActor() [2/2]

◆ isEmpty()

◆ parseFollowCtrl()

◆ parseSpamCtrl()

◆ showEntity()

◆ showPath()