com.sapportals.portal.appintegrator.template_processor.context
Interface IAccessor

All Known Implementing Classes:
AbstractContext

public interface IAccessor

Accessor interface for Url Generator IAccessor should be implemented by so called contexts so that they can be used by the UrlTemplateProcessor. A context in this connection is just a set of properties (Hashtable) containing name-value-pairs within the scope of the context (the scope is identified by the id of the context). A context-value can either be another context (nested context; i.e. an IAccessor) or a leaf property. Copyright (c) SAP Portals Europe GmbH 2001

Version:
$Revision: #1 $

Method Summary
 IAccessor get(java.lang.String id)
          returns the IAccessor member which key equals to id of the current context which must be another (nested) context
 java.lang.String getContextName()
          Returns the name of the context
 java.lang.String getTerminal(java.lang.String id, java.util.Locale loc)
          returns the String value for a leaf property for locale loc
 void setContextName(java.lang.String newName)
          sets the name of the context
 

Method Detail

getContextName

public java.lang.String getContextName()
Returns the name of the context
Returns:
context name

setContextName

public void setContextName(java.lang.String newName)
sets the name of the context
Parameters:
newName - new name of the context

get

public IAccessor get(java.lang.String id)
              throws java.lang.NullPointerException
returns the IAccessor member which key equals to id of the current context which must be another (nested) context
Parameters:
id - the id (i.e. key) of the nested context
Throws:
NullPointerException, - if id is null

getTerminal

public java.lang.String getTerminal(java.lang.String id,
                                    java.util.Locale loc)
                             throws java.lang.NullPointerException
returns the String value for a leaf property for locale loc
Parameters:
id - the id (i.e. key) of the property (maybe local depended)
loc - the desired locale
Throws:
NullPointerException, - if id is null