| org.apache.cocoon.portal.LinkService
All known Subclasses: org.apache.cocoon.portal.impl.DefaultLinkService,
| LinkService | | public interface LinkService extends Component(Code) | |
author:
Carsten Ziegeler
author:
Volker Schmitt
version:
CVS $Id: LinkService.java 433543 2006-08-22 06:22:54Z crossley $ |
| Inner Class :static class ParameterDescription | |
| DEFAULT_CONVERTABLE_EVENT_PARAMETER_NAME | | String DEFAULT_CONVERTABLE_EVENT_PARAMETER_NAME(Code) | | |
| DEFAULT_REQUEST_EVENT_PARAMETER_NAME | | String DEFAULT_REQUEST_EVENT_PARAMETER_NAME(Code) | | |
| addEventToLink | | void addEventToLink(Event event)(Code) | | Add this event to the list of events contained in the uri
Parameters:
event - Event to add |
| addParameterToLink | | void addParameterToLink(String name, String value)(Code) | | Add this parameter to every link.
If the link already contains a parameter with this name,
then the link will have both parameters with the same
name, but different values.
Parameters:
name - The request parameter name
Parameters:
value - The value for the parameter
See Also: LinkService.addUniqueParameterToLink(String,String) |
| addUniqueParameterToLink | | void addUniqueParameterToLink(String name, String value)(Code) | | Add this parameter to every link.
If the link already contains a parameter with this name,
then this old parameter will be removed and replaced by
the new one.
Parameters:
name - The request parameter name
Parameters:
value - The value for the parameter
See Also: LinkService.addUniqueParameterToLink(String,String) |
| getLinkURI | | String getLinkURI(Event event)(Code) | | Get the uri for this coplet containing the additional event
Parameters:
event - The event to add (null is also allowed for convenience) A URI |
| getLinkURI | | String getLinkURI(Event event, Boolean secure)(Code) | | Get the uri for this coplet containing the additional event and using a secure
protocol if requested.
Parameters:
event - The event to add (null is also allowed for convenience)
Parameters:
secure - true if a secure protocol is required, false otherwise. A URI |
| getLinkURI | | String getLinkURI(List events)(Code) | | Get the uri for this coplet containing the additional events.
Parameters:
events - The events to add: These can either be Events or ParameterDescriptions. A URI |
| getLinkURI | | String getLinkURI(List events, Boolean secure)(Code) | | Get a uri for this coplet containing the additional events. Use a secure
protocol if requested.
Parameters:
events - The events to add: These can either be Events or ParameterDescriptions.
Parameters:
secure - true if a secure protocol is required, false otherwise. A URI |
| getRefreshLinkURI | | String getRefreshLinkURI()(Code) | | Get a link that simply refreshs the portal
A URI |
| getRefreshLinkURI | | String getRefreshLinkURI(Boolean secure)(Code) | | Get a link that simply refreshs the portal
Parameters:
secure - true if a secure protocol is required, false otherwise. A URI |
| isSecure | | boolean isSecure()(Code) | | Determine whether the current url is using a secure protocol
true if the current url is using a secure protocol |
|
|