GetProjectsAction (Ametys 4.4.x - API)

java.lang.Object
- org.apache.avalon.framework.logger.AbstractLogEnabled
- - org.apache.cocoon.acting.AbstractAction
  - - org.apache.cocoon.acting.ServiceableAction
    - - org.ametys.plugins.mobileapp.action.AbstractPostAction
      - org.ametys.plugins.mobileapp.action.AbstractLoggedAction
        
        org.ametys.plugins.mobileapp.action.GetProjectsAction

All Implemented Interfaces:

Component, LogEnabled, Serviceable, Action
```
public class GetProjectsAction
extends AbstractLoggedAction
```
Returns the list of projects for a user

Field Summary

Fields
Modifier and Type Field Description

private ProjectsCatalogueManager _projectsCatalogueManager
The project catalogue manager component
- Fields inherited from class org.ametys.plugins.mobileapp.action.AbstractLoggedAction
  _currentUserProvider
- Fields inherited from class org.ametys.plugins.mobileapp.action.AbstractPostAction
  _jsonUtils
- Fields inherited from class org.apache.cocoon.acting.ServiceableAction
  manager
- Fields inherited from class org.apache.cocoon.acting.AbstractAction
  EMPTY_MAP
- Fields inherited from interface org.apache.cocoon.acting.Action
  ROLE

Constructor Summary

Constructors
Constructor Description

GetProjectsAction()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`private Map<String,Object>`	`_mapResult(Map<String,Object> userProject)`	Map a json used for project list to a map used by the mobile app
`protected Map<String,Object>`	`doLoggedInAction(Request request, Map<String,Object> jsonParams)`	Execute the action that requires to be logged in
`void`	`service(ServiceManager smanager)`

Methods inherited from class org.ametys.plugins.mobileapp.action.AbstractLoggedAction
doAction

Methods inherited from class org.ametys.plugins.mobileapp.action.AbstractPostAction
act, getParameter, getParameters

Methods inherited from class org.apache.avalon.framework.logger.AbstractLogEnabled
enableLogging, getLogger, setupLogger, setupLogger, setupLogger

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - _projectsCatalogueManager
```
private ProjectsCatalogueManager _projectsCatalogueManager
```
    The project catalogue manager component
- Constructor Detail
  - GetProjectsAction
```
public GetProjectsAction()
```
- Method Detail
  - service
```
public void service(ServiceManager smanager)
             throws ServiceException
```
    Specified by:
    
    service in interface Serviceable
    
    Overrides:
    
    service in class AbstractLoggedAction
    
    Throws:
    
    ServiceException
  - doLoggedInAction
```
protected Map<String,Object> doLoggedInAction(Request request,
                                                    Map<String,Object> jsonParams)
```
    Description copied from class: AbstractLoggedAction
    
    Execute the action that requires to be logged in
    
    Specified by:
    
    doLoggedInAction in class AbstractLoggedAction
    
    Parameters:
    
    request - the request
    
    jsonParams - map of parameters passed in the post body as json
    
    Returns:
    
    the json map to return
  - _mapResult
```
private Map<String,Object> _mapResult(Map<String,Object> userProject)
```
    Map a json used for project list to a map used by the mobile app
    
    Parameters:
    
    userProject - a map representing a project
    
    Returns:
    
    a map used by the mobile app