Object
Serializable
A client specific context containing customization properties the APIs use to
personalize the request. Specifically, a preferred Locale
is used to internationalize
the titles and descriptions and a HttpServletRequest
to perform
entitlement checking on request attributes.
Object
CustomizationContext
Serializable
Field Summary |
public static final int |
|
public static final int |
|
public static final int |
|
public static final int |
|
public static final |
|
Constructor Summary |
|
|
|
|
|
|
Method Summary |
public void | |
public int |
|
public |
|
public |
|
public boolean |
|
public void |
|
public void |
|
public void |
|
public |
|
Methods from class java.lang. |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int DISASSEMBLER_ACCEPT_DB
public static final int DISASSEMBLER_ACCEPT_DB_UPDATE_MARKUP
public static final int DISASSEMBLER_ACCEPT_TEMPLATE
public static final int DISASSEMBLER_PROPAGATE_EXCEPTION
Related Topics
public static final String
PORTAL_ENTITLEMENT_REQUEST
Related Topics
Constructor Detail |
public CustomizationContext()
A null construtor. This constructor can not stand by itself, all methods requesting a customizationContext require a locale and HttpRequest.
public CustomizationContext(ArrayList
locales,HttpServletRequest
request)
A more complex contructor containing an in order list of preferred locales and a reference to the users dekstop instance id. This contructor is usually called by the framework system and not to be used by the average developer.
public CustomizationContext(ArrayList
locales)
A more complex contructor containing an in ordered list of preferred locales. This contructor is usually called by the framework system and not to be used by the typical developer.
public CustomizationContext(Locale
locale,HttpServletRequest
request)
Create a minimal customization context consisting of one preferred
locale. This is the most common constructor used by developers as
it contains the required preferred Locale
and HttpServletRequest
public CustomizationContext(Locale
locale)
Create a minimal customization context consisting of one preferred locale. The locale is used to localize/internationalize each request. Different locales will result in different titles and descriptions being returned for the model objects.
public CustomizationContext(HttpServletRequest
request)
Create a minimial customization context consisting of a HttpServletRequest
.
Method Detail |
public void addLocale(Locale
locale)
Add a locale to the end of the preferred locale list. The locales in this list are used to search against the database to perform a best match.
public int getDisassemblerTemplateAction()
The action that should be performed if there are collisions between the template and the database dusing disassembly.
public Locale
[] getLocales()
Getter for retrieving the ordered list of preferred locales.
public EntitlementRequest
getRequest()
Return the EntitlementRequest, this method is used internally and has little use for developers.
public boolean isVisitorMode()
Is the API being called in visitor mode (default false).
The same API namely PortalCustomizationManager
is used in the Admin Portal as well as the Visitor Tools.
The flag indicates at what level you what to customize. If this flag is set to false (default) then the changes
made through the API effect the Admin Instance as well as all user instances. so all users will see the change.
If this flag is set to true then only the user calling it will see the changes.
Related Topics
PortalCustomizationManagerImpl
public void setDisassemblerTemplateAction(int disassemblerTemplateAction)
Set the action that should be performed if there are collisions between the template and the database.
Possible values:Related Topics
public void setRequest(HttpServletRequest
request)
Load the HttpServletRequest
. An EntitlementRequest
is created from this request and
put in the HttpServletRequest
as an attribute under the key PORTAL_ENTITLEMENT_REQUEST
.
public void setVisitorMode(boolean visitorMode)
Set how the API is being called. (defaults to false)
The same API namely PortalCustomizationManager
is used in the Admin Portal as well as the Visitor Tools.
The flag indicates at what level you what to customize. If this flag is set to false (default) then the changes
made through the API effect the Admin Instance as well as all user instances. so all users will see the change.
If this flag is set to true then only the user calling it will see the changes.
Related Topics
PortalCustomizationManagerImpl
public String
toString()
Dumps the contents of this customization context, little use except for debugging
Object.toString()