Inheritance diagram for org.turro.entities.StudentsEntities:

Collaboration diagram for org.turro.entities.StudentsEntities:

[legend]

Public Member Functions
	StudentsEntities ()

	StudentsEntities (String entityPath)

	StudentsEntities (Object entity)

Object	getEntity ()

String	getName ()

String	getLabel ()

String	getDescription ()

Object	getLabelCtrl ()

String	getImage ()

String	getHierarchicalPath ()

IElephantEntity	getParent ()

List< IElephantEntity >	getChildren ()

String	getExtendedPath ()

File	getFile ()

boolean	showPath ()

boolean	showEntity ()

boolean	canEdit (IContact contact)

boolean	canPublish (IContact contact)

boolean	canShowInContext (IContact contact, Object relatedEntity)

Collection	getEntitites (String search, int maxResults, KeyValueMap kvm)

Collection	getEntitites (String root, String search, int maxResults, KeyValueMap kvm)

Object	configureCtrl (Object ctrl, IContact contact)

String	getExtendedWebPath ()

String	getUserContext ()

Collection< String >	getAllowedRoots ()

String	getEntityUrl (LinkType type, String contextPath)

Public Member Functions inherited from org.turro.entities.DefaultElephantEntity
	DefaultElephantEntity ()

	DefaultElephantEntity (String entityPath)

	DefaultElephantEntity (Object entity)

IElephantEntity	getController (String entityPath)

IElephantEntity	getController (Object entity)

boolean	isEmpty ()

String	getStringId ()

String	getNameOrLabel ()

String	getRoot ()

String	getPath ()

String	getTreeLabel ()

Collection	getEntitites (String search, int maxResults)

Collection	getEntitites (String root, String search, int maxResults)

IElephantSendable	getSendable ()

Collection< Object >	getRelatedByRole (EntityRole role, IContact contact)

boolean	hasRelatedRole (EntityRole role, IContact contact)

String	getLinkRoot ()

String	getEntityUrl ()

String	getMemberUrl ()

String	getAppUrl ()

String	getReadAllUrl (LinkType type, String contextPath)

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)

int	hashCode ()

boolean	equals (Object obj)

Protected Member Functions
Dao	createDao ()

boolean	itsMine (Object entity)

IElephantEntity	createInstance (String entityPath)

IElephantEntity	createInstance (Object entity)

Path	createPath ()

Protected Member Functions inherited from org.turro.entities.DefaultElephantEntity
boolean	itsMine (String rootPath)

boolean	isValidLongEntity ()

Dao	getDao ()

Additional Inherited Members
Static Public Attributes inherited from org.turro.entities.IElephantEntity
static final String	EMPTY_ID = "#"

static final String	PATH_SEPARATOR = ";"

Protected Attributes inherited from org.turro.entities.DefaultElephantEntity
String	entityPath

Path	path

Object	entity

Detailed Description

Author: Lluis Turró Cutiller lluis.nosp@m.@tur.nosp@m.ro.or.nosp@m.g

Definition at line 56 of file StudentsEntities.java.

Constructor & Destructor Documentation

◆ StudentsEntities() [1/3]

org.turro.entities.StudentsEntities.StudentsEntities ( )

Definition at line 58 of file StudentsEntities.java.

58 {

59 }

Here is the caller graph for this function:

◆ StudentsEntities() [2/3]

org.turro.entities.StudentsEntities.StudentsEntities ( String entityPath )

Definition at line 61 of file StudentsEntities.java.

                                              {
     super(entityPath);
   }

◆ StudentsEntities() [3/3]

org.turro.entities.StudentsEntities.StudentsEntities ( Object entity )

Definition at line 65 of file StudentsEntities.java.

                                          {
     super(entity);
   }

Member Function Documentation

◆ canEdit()

boolean org.turro.entities.StudentsEntities.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 222 of file StudentsEntities.java.

                                            {
     if(getEntity() != null) {
     }
     return false;
   }

Here is the call graph for this function:

◆ canPublish()

boolean org.turro.entities.StudentsEntities.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 229 of file StudentsEntities.java.

                                               {
     if(getEntity() != null) {
       return true;
     }
     return false;
   }

Here is the call graph for this function:

◆ canShowInContext()

boolean org.turro.entities.StudentsEntities.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 237 of file StudentsEntities.java.

                                                                           {
     return true;
   }

◆ configureCtrl()

Object org.turro.entities.StudentsEntities.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 266 of file StudentsEntities.java.

                                                              {
     if(ctrl instanceof VoteItCtrl) {
       VoteItCtrl ictrl = (VoteItCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     } else if(ctrl instanceof StarItCtrl) {
       StarItCtrl ictrl = (StarItCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     } else if(ctrl instanceof CommentItCtrl) {
       CommentItCtrl ictrl = (CommentItCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     } else if(ctrl instanceof AttachCtrl) {
       AttachCtrl ictrl = (AttachCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       ictrl.setPublicOnly(true);
       return ictrl;
     } else if(ctrl instanceof FileAttach) {
       FileAttach ictrl = (FileAttach) ctrl;
       return ictrl;
     } else if(ctrl instanceof DescribeItCtrl) {
       DescribeItCtrl ictrl = (DescribeItCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     } else if(ctrl instanceof PollsCtrl) {
       PollsCtrl ictrl = (PollsCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     } else if(ctrl instanceof IEntityCtrl) {
       IEntityCtrl ictrl = (IEntityCtrl) ctrl;
       ictrl.setEntityPath(getPath());
       return ictrl;
     }
     return ctrl;
   }

Here is the call graph for this function:

◆ createDao()

Dao org.turro.entities.StudentsEntities.createDao ( )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 316 of file StudentsEntities.java.

                             {
     return new StudentsPU();
   }

◆ createInstance() [1/2]

IElephantEntity org.turro.entities.StudentsEntities.createInstance ( Object entity )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 337 of file StudentsEntities.java.

                                                           {
     return new StudentsEntities(entity);
   }

Here is the call graph for this function:

◆ createInstance() [2/2]

IElephantEntity org.turro.entities.StudentsEntities.createInstance ( String entityPath )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 332 of file StudentsEntities.java.

                                                               {
     return new StudentsEntities(entityPath);
   }

Here is the call graph for this function:

◆ createPath()

Path org.turro.entities.StudentsEntities.createPath ( )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 342 of file StudentsEntities.java.

                               {
     return new Path(StudentsPU.getObjectPath(entity));
   }

Here is the call graph for this function:

◆ getAllowedRoots()

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

Implements org.turro.entities.IElephantEntity.

Definition at line 327 of file StudentsEntities.java.

                                               {
     return Arrays.asList("challenge", "response", "practicalwork", "talent-category");
   }

◆ getChildren()

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

Gets the children for this entity.

Returns: the children controllers.

Implements org.turro.entities.IElephantEntity.

Definition at line 183 of file StudentsEntities.java.

                                              {
     if(getEntity() != null) {
       if(entity instanceof Challenge) {
         return new EntityListAdapter(((Challenge) entity).getResponses());
       }
     }
     return Collections.EMPTY_LIST;
   }

Here is the call graph for this function:

◆ getDescription()

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

Gets the entity description.

Returns: the description string.

Implements org.turro.entities.IElephantEntity.

Definition at line 133 of file StudentsEntities.java.

                                  {
     return null;
   }

◆ getEntitites() [1/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 250 of file StudentsEntities.java.

                                                                                               {
     ArrayList<Object> list = new ArrayList<>();
     if(null != root) switch (root) {
       case "challenge":
         list.addAll(searchChallenges(search, maxResults, kvm));
         break;
       case "talent-category":
         list.addAll(searchCategories(search, maxResults, kvm));
         break;
       default:
         break;
     }
     return list;
   }

◆ getEntitites() [2/2]

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

Implements org.turro.entities.IElephantEntity.

Definition at line 242 of file StudentsEntities.java.

                                                                                  {
     ArrayList<Object> list = new ArrayList<>();
     list.addAll(searchChallenges(search, maxResults, kvm));
     list.addAll(searchCategories(search, maxResults, kvm));
     return list;
   }

◆ getEntity()

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

Returns the entity for this controller.

Returns: the entity's object.

Implements org.turro.entities.IElephantEntity.

Definition at line 70 of file StudentsEntities.java.

                             {
     if(entity == null) {
       if(getPath() != null) {
         if(isValidLongEntity()) {
           if(null != path.getRoot()) switch (path.getRoot()) {
             case "challenge":
               entity = getDao().find(Challenge.class, path.getNodeAs(1, Long.class));
               break;
             case "response":
               entity = getDao().find(Response.class, path.getNodeAs(1, Long.class));
               break;
             case "practicalwork":
               entity = getDao().find(PracticalWork.class, path.getNodeAs(1, Long.class));
               break;
             case "talent-category":
               entity = getDao().find(TalentCategory.class, path.getNodeAs(1, Long.class));
               break;
             default:
               break;
           }
         }
       }
     }
     return entity;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEntityUrl()

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

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 365 of file StudentsEntities.java.

                                                                 {
     if("response".equals(getRoot())) {
       return getParent().getEntityUrl(type, contextPath);
     }
     return super.getEntityUrl(type, contextPath);
   }

Here is the call graph for this function:

◆ getExtendedPath()

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

Gets the extended path for this entity.

Returns: the extended path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 193 of file StudentsEntities.java.

                                   {
     return StudentsPU.getObjectExtendedPath(getEntity());
   }

Here is the call graph for this function:

◆ getExtendedWebPath()

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

Returns a unique path for the entity.

Returns: the path string.

Implements org.turro.entities.IElephantEntity.

Definition at line 304 of file StudentsEntities.java.

                                      {
     return null;
   }

◆ getFile()

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

Gets the file represented by the entity.

Returns: the entity file.

Implements org.turro.entities.IElephantEntity.

Definition at line 198 of file StudentsEntities.java.

                         {
     return null;
   }

◆ getHierarchicalPath()

String org.turro.entities.StudentsEntities.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 166 of file StudentsEntities.java.

                                       {
     return getPath();
   }

Here is the call graph for this function:

◆ getImage()

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

Gets the entity image based on its root.

Returns: the string image location.

Implements org.turro.entities.IElephantEntity.

Definition at line 146 of file StudentsEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "challenge":
           return "/_zul/images/challenge.png";
         case "response":
           return "/_zul/images/response.png";
         case "practicalwork":
           return "/_zul/images/operator.png";
         case "talent-category":
           return "/_zul/images/group.png";
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabel()

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

Gets the entity label, based on its root.

Returns: the entity string label.

Implements org.turro.entities.IElephantEntity.

Definition at line 113 of file StudentsEntities.java.

                            {
     if(getPath() != null) {
       String root = path.getRoot();
       if(null != root) switch (root) {
         case "challenge":
           return I_.get("Challenge");
         case "response":
           return I_.get("Answer");
         case "practicalwork":
           return I_.get("Practical work");
         case "talent-category":
           return I_.get("Talent category");
         default:
           break;
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getLabelCtrl()

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

Gets the label control, usually a clickable LabelControl class.

Returns: a clickable label control.

Implements org.turro.entities.IElephantEntity.

Definition at line 138 of file StudentsEntities.java.

                                {
     if(getEntity() != null && !(entity instanceof TalentCategory)) {
       return new LabelControl(getEntity());
     }
     return null;
   }

Here is the call graph for this function:

◆ getName()

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

Gets the entity name.

Returns: the string name.

Implements org.turro.entities.IElephantEntity.

Definition at line 97 of file StudentsEntities.java.

                           {
     if(getEntity() != null) {
       if(entity instanceof Challenge) {
         return ((Challenge) entity).getQuestion();
       } else if(entity instanceof Response) {
         return ((Response) entity).getChallenge().getQuestion();
       } else if(entity instanceof PracticalWork) {
         return ((PracticalWork) entity).getTitle();
       } else if(entity instanceof TalentCategory) {
         return ((TalentCategory) entity).getName();
       }
     }
     return null;
   }

Here is the call graph for this function:

◆ getParent()

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

Gets the parent for this entity.

Returns: the parent controller.

Implements org.turro.entities.IElephantEntity.

Definition at line 171 of file StudentsEntities.java.

                                      {
     if(getEntity() != null) {
       if(entity instanceof Challenge) {
         return ((Challenge) entity).getEntity();
       } else if(entity instanceof Response) {
         return Entities.getController(((Response) entity).getChallenge());
       }
     }
     return null;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserContext()

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

Returns the user context for this type of entity

Returns: the path string;

Implements org.turro.entities.IElephantEntity.

Definition at line 309 of file StudentsEntities.java.

                                  {
     return "challenge".equals(getRoot()) ?
             "/user/" + getLinkRoot() + "s" :
             "/user/my" + getLinkRoot() + "s";
   }

Here is the call graph for this function:

◆ itsMine()

boolean org.turro.entities.StudentsEntities.itsMine ( Object entity )

protected

Reimplemented from org.turro.entities.DefaultElephantEntity.

Definition at line 321 of file StudentsEntities.java.

                                            {
     return (entity instanceof Challenge) || (entity instanceof Response) ||
            (entity instanceof PracticalWork) || (entity instanceof TalentCategory);
   }

◆ showEntity()

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

Shows the view for the entity.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 211 of file StudentsEntities.java.

                               {
     if(getEntity() != null) {
       if(entity instanceof Challenge) {
         StudentsMenu.showChallenge(((Challenge) entity).getId());
         return true;
       }
     }
     return false;
   }

Here is the call graph for this function:

◆ showPath()

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

Shows the view for this path.

Returns: true when a view is shown.

Implements org.turro.entities.IElephantEntity.

Definition at line 203 of file StudentsEntities.java.

                             {
     if(getPath() != null) {
       String root = path.getRoot();
     }
     return false;
   }

Here is the call graph for this function:

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

StudentsEntities.java

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StudentsEntities() [1/3]

◆ StudentsEntities() [2/3]

◆ StudentsEntities() [3/3]

Member Function Documentation

◆ canEdit()

◆ canPublish()

◆ canShowInContext()

◆ configureCtrl()

◆ createDao()

◆ createInstance() [1/2]

◆ createInstance() [2/2]

◆ createPath()

◆ getAllowedRoots()

◆ getChildren()

◆ getDescription()

◆ getEntitites() [1/2]

◆ getEntitites() [2/2]

◆ getEntity()

◆ getEntityUrl()

◆ getExtendedPath()

◆ getExtendedWebPath()

◆ getFile()

◆ getHierarchicalPath()

◆ getImage()

◆ getLabel()

◆ getLabelCtrl()

◆ getName()

◆ getParent()

◆ getUserContext()

◆ itsMine()

◆ showEntity()

◆ showPath()