|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ResourceURLAccessor
Create a URL object that points to a portal resource. Resources can either be icons or generic resources. The resources need to reside inside of the portal web application.
Method Summary | |
---|---|
URL |
getIconURL(java.lang.String aliasname,
PortalResources.State type)
Creates a URL object that points to an icon resource. |
URL |
getResourceURL(java.lang.String name,
Decoration decoration,
PortalResources.Type type)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
Decoration decoration,
PortalResources.Type type,
PortalResources.State state)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
Decoration decoration,
PortalResources.Type type,
PortalResources.State state,
URLContext urlContext)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
Decoration decoration,
PortalResources.Type type,
URLContext urlContext)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
PortalResources.Type type)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
PortalResources.Type type,
PortalResources.State state)
Creates a URL object that points to a generic resource. |
URL |
getResourceURL(java.lang.String name,
Theme theme,
PortalResources.Type type)
Deprecated. Use getResourceURL(String, Decoration, com.ibm.portal.state.accessors.url.PortalResources.Type) |
URL |
getResourceURL(java.lang.String name,
Theme theme,
PortalResources.Type type,
PortalResources.State state)
Deprecated. Use getResourceURL(String, Decoration, com.ibm.portal.state.accessors.url.PortalResources.Type, com.ibm.portal.state.accessors.url.PortalResources.State) |
Methods inherited from interface com.ibm.portal.Disposable |
---|
dispose |
Method Detail |
---|
URL getIconURL(java.lang.String aliasname, PortalResources.State type) throws IconNotFoundException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client, and the theme name.
This method is a convenience method for geResourceURL
called with type PortalResources.TYPE_ICONS
.
aliasname
- Name (without path) of the icontype
- State of the icon
IconNotFoundException
- -
if the icon was unknownURL getResourceURL(java.lang.String name, Theme theme, PortalResources.Type type) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
getResourceURL(String, Decoration, com.ibm.portal.state.accessors.url.PortalResources.Type)
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The theme is passed in as a parameter.
This method is a convenience method for geResourceURL
called
with state PortalResources.NO_STATE
.
name
- Name (potentially the relative path) of the resourcetheme
- theme of the resourcetype
- Portal resource type
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
URL getResourceURL(java.lang.String name, Decoration decoration, PortalResources.Type type) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The Decoration is passed in as a parameter.
This method is a convenience method for geResourceURL
called
with state PortalResources.NO_STATE
.
name
- Name (potentially the relative path) of the resource. Path
names ending with /
indicate a directory and do
only make sense with PortalResources.TYPE_FILESdecoration
- Decoration of the resourcetype
- Portal resource type
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
URL getResourceURL(java.lang.String name, Decoration decoration, PortalResources.Type type, URLContext urlContext) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The Decoration is passed in as a parameter.
This method is a convenience method for geResourceURL
called
with state PortalResources.NO_STATE
.
name
- Name (potentially the relative path) of the resource. Path
names ending with /
indicate a directory and do
only make sense with PortalResources.TYPE_FILESdecoration
- Decoration of the resourcetype
- Portal resource typeurlContext
- The UrlContext object specifies what kind of URL gets generated
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
URL getResourceURL(java.lang.String name, PortalResources.Type type) throws ResourceNotFoundException, InvalidResourceTypeException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client, and the theme name.
This method is a convenience method for geResourceURL
called with state PortalResources.NO_STATE
.
name
- File name (without path) of the resourcetype
- Portal resource type
ResourceNotFoundException
- -
if the resource could not be located
InvalidResourceTypeException
- -
if the resource type is unknownURL getResourceURL(java.lang.String name, PortalResources.Type type, PortalResources.State state) throws ResourceNotFoundException, InvalidResourceTypeException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client, and the theme name.
name
- Name (without path) of the resourcetype
- Portal resource typestate
- Additional resource state
ResourceNotFoundException
- -
if the resource could not be located
InvalidResourceTypeException
- -
if the resource type is unknownURL getResourceURL(java.lang.String name, Theme theme, PortalResources.Type type, PortalResources.State state) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
getResourceURL(String, Decoration, com.ibm.portal.state.accessors.url.PortalResources.Type, com.ibm.portal.state.accessors.url.PortalResources.State)
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The theme is passed in as a parameter.
name
- Name (potentially the relative path) of the resourcetheme
- theme of the resource, not null
type
- Portal resource typestate
- Additional resource state
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
URL getResourceURL(java.lang.String name, Decoration decoration, PortalResources.Type type, PortalResources.State state) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The decoration is passed in as a parameter.
name
- Name (potentially the relative path) of the resource. Path
names ending with /
indicate a directory and do
only make sense with PortalResources.TYPE_FILESdecoration
- Decoration of the resource, not null
type
- Portal resource typestate
- Additional resource state
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
URL getResourceURL(java.lang.String name, Decoration decoration, PortalResources.Type type, PortalResources.State state, URLContext urlContext) throws ResourceNotFoundException, InvalidResourceTypeException, ModelException
The resouce lookup takes additional information of the request into account. This is the current locale, the client device, markup chosen for the client. The decoration is passed in as a parameter.
name
- Name (potentially the relative path) of the resource. Path
names ending with /
indicate a directory and do
only make sense with PortalResources.TYPE_FILESdecoration
- Decoration of the resource, not null
type
- Portal resource typestate
- Additional resource stateurlContext
- The UrlContext object specifies what kind of URL gets generated
ResourceNotFoundException
- - if the resource could not be located
InvalidResourceTypeException
- - if the resource type is unknown
ModelException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |