fr.paris.lutece.portal.service.rbac
Class ResourceIdService

java.lang.Object
  extended by fr.paris.lutece.portal.service.rbac.ResourceIdService
Direct Known Subclasses:
InsertResourceIdService, PageResourceIdService, PortletResourceIdService

public abstract class ResourceIdService
extends java.lang.Object

This class gives the methods to implement in order to allow the restitution of the ids and labels for a given resource type.


Constructor Summary
ResourceIdService()
           
 
Method Summary
 java.lang.String getPluginName()
          Gets the name of the plugin associated
abstract  ReferenceList getResourceIdList(java.util.Locale locale)
          Provide the list of all resources (id - label)
abstract  java.lang.String getTitle(java.lang.String strId, java.util.Locale locale)
          Provide the title of a resource given its id
abstract  void register()
          This method should register permissions and resource type
 void setPluginName(java.lang.String strPluginName)
          Sets the name of the plugin associated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceIdService

public ResourceIdService()
Method Detail

register

public abstract void register()
This method should register permissions and resource type


getResourceIdList

public abstract ReferenceList getResourceIdList(java.util.Locale locale)
Provide the list of all resources (id - label)

Returns:
the list of all resources available for restricted access

getTitle

public abstract java.lang.String getTitle(java.lang.String strId,
                                          java.util.Locale locale)
Provide the title of a resource given its id

Parameters:
strId - the id of the resource
Returns:
the title the corresponding label

setPluginName

public void setPluginName(java.lang.String strPluginName)
Sets the name of the plugin associated

Parameters:
strPluginName - the plugin name

getPluginName

public java.lang.String getPluginName()
Gets the name of the plugin associated

Returns:
the plugin name


Copyright © 2007 Mairie de Paris. All Rights Reserved.