A B C D E G H I J K L M N O P R S T U V W X

A

absorb(SOIF) - Method in class com.sun.portal.search.soif.SOIF

Copies all data from another SOIF without replacement.

absorb(SOIF, String[]) - Method in class com.sun.portal.search.soif.SOIF

Copies selected data from another SOIF without replacement Ignores case of all attribute names.

addTab(String, String) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Adds the tab back to the desktop that has been removed before

ALL - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <ALL> string operation

allContentChanged() - Method in interface com.sun.portal.providers.context.ProviderContext

ANY - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <OR> operation

AsciiFormInputExpectedException - exception com.sun.portal.providers.AsciiFormInputExpectedException.

This exception should be thrown from processEdit when it requires ASCII-only encoded form input but is sent something else.

AsciiFormInputExpectedException(String) - Constructor for class com.sun.portal.providers.AsciiFormInputExpectedException

Constructs a new exception with the specified message, indicating a ASCII encoded string is expected but got something else from the input is sent.

attribute - Variable in class com.sun.portal.search.soif.AVPair

Attribute name.

authorOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Compares the input parameter with the authorOp property

AVPair - class com.sun.portal.search.soif.AVPair.

AVPair - a class used to represent a SOIF attribute-value pair.

AVPair(String) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs an empty, named AVPair instance

AVPair(String, byte[]) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs a new AVPairs instance with a byte array value.

AVPair(String, byte[], int) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs an AVPair consisting of a byte array value with the given index.

AVPair(String, byte[], int, String) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs an AVPair consisting of a String value with the given index and encoding.

AVPair(String, String) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs a new AVPairs instance with a String value.

AVPair(String, String, int) - Constructor for class com.sun.portal.search.soif.AVPair

Constructs an AVPair consisting of a String value with the given index.

B

booleanCheckBox(Boolean) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Returns 'CHECKED' if the parameter is true and false otherwise

BOTTOM - Static variable in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Bottom Row in the TableContainerProvider

C

CENTER - Static variable in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Center column in the TableContainerProvider

CHANNEL_NAME_SEPARATOR - Static variable in interface com.sun.portal.providers.context.ContainerProviderContext

TBD

close() - Method in class com.sun.portal.search.soif.SOIFInputStream

Closes the stream.

com.sun.portal.providers - package com.sun.portal.providers

com.sun.portal.providers.containers - package com.sun.portal.providers.containers

com.sun.portal.providers.containers.jsp.single - package com.sun.portal.providers.containers.jsp.single

com.sun.portal.providers.containers.jsp.tab - package com.sun.portal.providers.containers.jsp.tab

com.sun.portal.providers.containers.jsp.table - package com.sun.portal.providers.containers.jsp.table

com.sun.portal.providers.context - package com.sun.portal.providers.context

com.sun.portal.providers.jsp - package com.sun.portal.providers.jsp

com.sun.portal.providers.urlscraper - package com.sun.portal.providers.urlscraper

com.sun.portal.providers.xml - package com.sun.portal.providers.xml

com.sun.portal.search.demo - package com.sun.portal.search.demo

com.sun.portal.search.providers - package com.sun.portal.search.providers

com.sun.portal.search.soif - package com.sun.portal.search.soif

CONTAIN - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <CONTAINS> operation

ContainerProvider - interface com.sun.portal.providers.containers.ContainerProvider.

ContainerProvider defines the interface for implementing a container provider.

ContainerProviderAdapter - class com.sun.portal.providers.containers.ContainerProviderAdapter.

This class provides default implementations of methods in the ContainerProvider interface implemented using a containerProviderContext object as the persistent store.

ContainerProviderAdapter() - Constructor for class com.sun.portal.providers.containers.ContainerProviderAdapter

ContainerProviderContext - interface com.sun.portal.providers.context.ContainerProviderContext.

An environment for container provider execution.

contains(String) - Method in class com.sun.portal.search.soif.SOIF

Tests for attribute existence.

containsKey(Object) - Method in class com.sun.portal.search.soif.SOIF

Case insensistive collection function.

contentChanged(String) - Method in interface com.sun.portal.providers.context.ProviderContext

contentSize() - Method in class com.sun.portal.search.soif.SOIF

contentSize() - Method in class com.sun.portal.search.soif.AVPair

createChannel(String, String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Creates a new global scope channel.

createContainer(String, String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Creates a new global scope container channel.A global scope channel can be referenced globally from all other channels.

CUSTOM_THEME - Static variable in class com.sun.portal.providers.context.Theme

Constant refering to the custom theme.

D

debug - Variable in class com.sun.portal.search.soif.SOIFInputStream

debug

debugError(Object) - Method in interface com.sun.portal.providers.context.ProviderContext

Logs a message if the debugging level is "error".

debugError(Object, Throwable) - Method in interface com.sun.portal.providers.context.ProviderContext

Logs a message and stack trace, if the debugging level is "error".

debugMessage(Object) - Method in interface com.sun.portal.providers.context.ProviderContext

logs a message if the debugging level is "message" or higher.

debugMessage(Object, Throwable) - Method in interface com.sun.portal.providers.context.ProviderContext

Logs a message and stack trace if the debugging level is "message" or higher.

debugWarning(Object) - Method in interface com.sun.portal.providers.context.ProviderContext

Logs a message if the debugging level is "warning" or higher.

debugWarning(Object, Throwable) - Method in interface com.sun.portal.providers.context.ProviderContext

Logs a message and stack trace if the debugging level is "warning" or higher.

defaultEncoding - Static variable in class com.sun.portal.search.soif.SOIF

Default char encoding.

descCheckbox(String) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Compares the parameter with the description property

DescSelectionAttribute(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Helper method used to return the selection for the description menu Compares the parameter value with the description property

DesktopServlet - class com.sun.portal.desktop.DesktopServlet.

The Desktop Servlet is a router of request.

DesktopServlet() - Constructor for class com.sun.portal.desktop.DesktopServlet

docDisplayCheckbox(String) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Compares the parameter with the documentDisplay property

doGet(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.desktop.DesktopServlet

doPost(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.desktop.DesktopServlet

doQuery() - Method in class com.sun.portal.search.demo.Search

Execute the query.

doQuery(int, int) - Method in class com.sun.portal.search.demo.Search

Execute the query, returning viewHits hits starting at firstHit.

E

EDIT_COMPLETE - Static variable in interface com.sun.portal.providers.ProviderEditTypes

Edit page is a complete document.

EDIT_SUBSET - Static variable in interface com.sun.portal.providers.ProviderEditTypes

Edit page is not a complete document.

encodeURL(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Encodes a URL.

EQUAL - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to '=' operation used to compare number type

EXACT - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <EXACT> string operation

execute() - Method in class com.sun.portal.search.providers.SearchContext

Executes the query

existsBooleanProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of a boolean property in the channel.

existsBooleanProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of a boolean property.

existsChannel(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Tests if channel configuration exists.

existsCollectionProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of a collection property.

existsCollectionProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of a collection property.

existsIntegerProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of an integer property in the channel.

existsIntegerProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of an integer property.

existsListProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of a list property in the channel.

existsListProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of a listproperty in the channel.

existsStringProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of a string property in the channel.

existsStringProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Tests for the existence of a string property in the channel.

existsStringProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of a string property.

existsStringProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Tests for the existence of a string property.

expiresOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

G

genMinimizedContent(Map, List, Map, boolean) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Generates the minimized content for the channels that are minimized This method puts an empty stringbuffer in the content Map for the channels that are minimized in the table container.

get(Object) - Method in class com.sun.portal.search.soif.SOIF

Case insensistive collection function.

getAttribute() - Method in class com.sun.portal.search.soif.AVPair

getAttribute(String, ProviderContext, String) - Static method in class com.sun.portal.providers.context.Theme

Gets an attribute value of the selected theme.

getAttribute(String, ProviderContext, String, String) - Static method in class com.sun.portal.providers.context.Theme

Gets an attribute value of a theme.

getAttributeCount() - Method in class com.sun.portal.search.soif.SOIF

getAttributes() - Method in class com.sun.portal.search.soif.SOIF

getAttributesArray() - Method in class com.sun.portal.search.soif.SOIF

getAuthorOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of authorOp

getAuthorVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of authorVal

getAvailableChannels() - Method in interface com.sun.portal.providers.containers.ContainerProvider

Gets the list of available channel names.

getAvailableChannels() - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

getAvailableChannels() - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

getAvailableChannels() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the list of tab topics that are available to be added to the portal page.

getAvailableChannels(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the available channels for the container channel that this is providing an environment for.

getAvailableTabs() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the List of available tab topics.

getAvailableTabs() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the List of available tabs.

getAVPair(String) - Method in class com.sun.portal.search.soif.SOIF

Gets an AVPair by attribute.

getBooleanProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a boolean property for the channel.

getBooleanProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a boolean property for the channel.

getBooleanProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a boolean property property.

getBooleanProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a boolean property property.

getBrowseCategory() - Method in class com.sun.portal.search.providers.SearchRequestBean

Method is used for category browsing and category searching

getBytes() - Method in class com.sun.portal.search.soif.AVPair

getBytes(int) - Method in class com.sun.portal.search.soif.AVPair

getBytes(String) - Method in class com.sun.portal.search.soif.SOIF

Gets a byte array value by attribute.

getBytes(String, int) - Method in class com.sun.portal.search.soif.SOIF

Gets a byte array value by multivalue attribute and index.

getByteValues() - Method in class com.sun.portal.search.soif.AVPair

Gets all valid values of this attribute.

getCachedContent(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the cached content view for a channel.

getCachedTime(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the content view cache time for a channel.

getCategory() - Method in class com.sun.portal.search.providers.SearchContext

Gets the value of category

getCharset() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the character set.

getClassName(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the class name for the provider class that this object will be providing an environment for.

getClientPath() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the client path.

getClientProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets the client property.

getClientProperty(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Get a client property.

getClientType() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the client type.

getClientTypeProperty(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a client type property for the user's client type.

getClientTypeProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a client type property for the given client type.

getCollectionProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a collection property.

getCollectionProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the localized version of a collection property.

getCollectionProperty(String, String, Map) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a collection property.

getCollectionProperty(String, String, Map, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the localized version of a collection property.

getColumn(HttpServletRequest, String) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the column in which this channel should be displayed in.

getConfigProperty(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the named configuration property.

getContainerProviderContext() - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

Gets the ContainerProviderContext for the container provider.

getContainerProviderContext() - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

getContent(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.xml.XMLProvider

getContent(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.urlscraper.URLScraperProvider

Get the provider's content by retrieving HTML content from specified URL.

getContent(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.ProviderAdapter

Calls the getContent(Map) method in this object to provide backwards compatibility.

getContent(HttpServletRequest, HttpServletResponse) - Method in interface com.sun.portal.providers.Provider

Gets the provider's objects default view.

getContent(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

getContent(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.jsp.JSPProvider

Gets the provider's content by executing a JSP.

getContent(HttpServletRequest, HttpServletResponse, String, List, int) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the content view for a set of channels.

getContent(HttpServletRequest, HttpServletResponse, String, String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the content view for the named channel.

getContent(Map) - Method in class com.sun.portal.providers.ProviderAdapter

Deprecated. Using this method has negative performance implications. Use getContent(HttpServletRequest, HttpServletResponse) instead.

getContent(Map) - Method in interface com.sun.portal.providers.Provider

Deprecated. Using this method has negative performance implications. Use getContent(HttpServletRequest, HttpServletResponse) instead.

getContentType() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the content type.

getContentURL(ModifiableTab, HttpServletRequest) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the ContentPage URL.

getDefaultChannelName() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the default channel name.

getDefaultClientType() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the default client type.

getDesc() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Gets the description of the tab

getDescription() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the description

getDescription() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the description for the channel.

getDescription() - Method in interface com.sun.portal.providers.Provider

Gets the description of this provider.

getDesktopType() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the Desktop type.

getDesktopURL(HttpServletRequest) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the Desktop URL.

getDisplayname() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Gets the display name of the tab

getDocumentCount() - Method in class com.sun.portal.search.demo.Search

The total number of documents available to be searched.

getEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.ProviderAdapter

Calls the getEdit(Map) method in this object to provide backwards compatibility.

getEdit(HttpServletRequest, HttpServletResponse) - Method in interface com.sun.portal.providers.Provider

Gets the edit view for the provider.

getEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.jsp.JSPProvider

Gets the provider's edit page by executing a JSP.

getEdit(Map) - Method in class com.sun.portal.providers.ProviderAdapter

Deprecated. Using this method has negative performance implications. Use getEdit(HttpServletRequest, HttpServletResponse) instead.

getEdit(Map) - Method in interface com.sun.portal.providers.Provider

Deprecated. Using this method has negative performance implications. Use getEdit(HttpServletRequest, HttpServletResponse) instead.

getEditType() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the edit type for the channel.

getEditType() - Method in interface com.sun.portal.providers.Provider

Gets the edit form type of the provider.

getEncodedName() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Gets the html encoded name of the tab

getExpiresOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of expiresOp

getExpiresVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of expiresVal

getFirstHit() - Method in class com.sun.portal.search.demo.Search

Get the starting hit offset.

getGlobal(String, ProviderContext) - Static method in class com.sun.portal.providers.context.Theme

Gets the global list of preset theme that is available.

getHelp(HttpServletRequest) - Method in class com.sun.portal.providers.ProviderAdapter

Gets the default help URL for the channel that this object is providing an environment for.

getHelp(HttpServletRequest) - Method in interface com.sun.portal.providers.Provider

Gets the help URL for this provider.

getHelp(HttpServletRequest, String) - Method in class com.sun.portal.providers.ProviderAdapter

Gets the named help URL for the channel that this object is providing an environment for.

getHitCount() - Method in class com.sun.portal.search.demo.Search

The total number of results that matched the search.

getInputEncoding() - Method in class com.sun.portal.providers.urlscraper.URLScraperProvider

Gets the inputEncoding to be used by content.

getIntegerProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets an integer property for the channel.

getIntegerProperty(String, int) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets an integer property for the channel.

getIntegerProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets an integer property.

getIntegerProperty(String, String, int) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets an integer property.

getKeywordsOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of keywordsOp

getKeywordsVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of keywordsVal

getLayout() - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the layout for this container.

getListProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a list property for the channel.

getListProperty(String, List) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a list property for the provider.

getLmodifiedOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the lmodifiedOp property

getLmodifiedVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the lmodifiedVal property

getLocale() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the locale.

getLocaleString() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the string form of the locale.

getLogoutURL() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the logout URL.

getMakeTab() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the make tab, the tab spec to be used for 'Make My Own tab' creation by the user .

getMakeTab() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the make tab, the tab spec to be used for 'Make My Own tab' creation by the user .

getMakeTabName() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user .

getMakeTabName() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the make tab channel Name, the tab spec to be used for 'Make My Own tab' creation by the user .

getMakeTabProviderName() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user .

getMakeTabProviderName() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the make tab provider Name, the tab spec to be used for 'Make My Own tab' creation by the user .

getMap(String, ProviderContext, String) - Static method in class com.sun.portal.providers.context.Theme

Gets the attributes of a theme as a map.

getMapProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a map property for the channel.

getMapProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets the localized version of a map property for the channel.

getMapProperty(String, Map) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a map property for the channel.

getMapProperty(String, Map, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets the localized version of a map property for the channel.

getMaxIndex() - Method in class com.sun.portal.search.soif.AVPair

getMaxTabs() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the maximum number of tabs allowed on the user's desktop.

getMaxTabs() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the maximum number of tabs allowed on the user's desktop.

getMode() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the search mode

getName() - Method in class com.sun.portal.providers.ProviderAdapter

getName() - Method in interface com.sun.portal.providers.Provider

Gets the name of this provider.

getName() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Gets the name of the tab

getNames(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets property names for the channel.

getNowords() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of nowords

getPage() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the current page value

getPage() - Method in class com.sun.portal.search.providers.SearchContext

Gets the current page value

getPopupWindowHeight(HttpServletRequest, String) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

gets the popup window height for the detach window when a channel is detached

getPopupWindowWidth(HttpServletRequest, String) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the popup window width for the detach window when a channel is detached

getProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a property.

getProperty(String, String, Object) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a property.

getProvider(HttpServletRequest, String, String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets a provider.

getProviderContext() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the ProviderContext for the provider.

getProviderName(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the name of the provider that backs the channel that this object provides an environment for.

getQuery() - Method in class com.sun.portal.search.demo.Search

Return the fully formatted query url sent to the server.

getQueryLanguage() - Method in class com.sun.portal.search.demo.Search

Returns the current query language.

getRDMHeaderSOIF() - Method in class com.sun.portal.search.demo.Search

Return the SOIF RDM result header.

getRDMServer() - Method in class com.sun.portal.search.demo.Search

Returns the current RDMServer variable.

getRDMType() - Method in class com.sun.portal.search.demo.Search

Returns the current RDMType.

getRefreshTime() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the refresh time for the channel.

getRefreshTime() - Method in interface com.sun.portal.providers.Provider

Gets the refresh time for this provider, in seconds.

getRefreshTime() - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

getRefreshTime() - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

getRequestServer(HttpServletRequest) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the request server.

getResourceBundle() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the well-knowned ResourceBundle for the provider based on User's locale.

getResourceBundle(String) - Method in class com.sun.portal.providers.ProviderAdapter

Gets a specified ResourceBundle file for the provider based on User's locale.

getResultCount() - Method in class com.sun.portal.search.demo.Search

The number of results returned by the search.

getResultStream() - Method in class com.sun.portal.search.demo.Search

Return results as a DataInputStream.

getRow(HttpServletRequest, String) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the row in which this channel should be displayed in.

getScat() - Method in class com.sun.portal.search.providers.SearchRequestBean

Get the value of scat i.e search all category radio button

getSchemaName() - Method in class com.sun.portal.search.soif.SOIF

getScope() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the query string

getScope() - Method in class com.sun.portal.search.demo.Search

Returns the current scope (query) for the search.

getSelectedChannel() - Method in class com.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider

Gets the selected channel name.

getSelectedChannels() - Method in interface com.sun.portal.providers.containers.ContainerProvider

Gets the list of selected channel names.

getSelectedChannels() - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

getSelectedChannels() - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

getSelectedChannels() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the list of tab names that are available on the portal page.

getSelectedChannels(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Gets the selected channels for the container channel that this is providing an environment for.

getSelectedName(String, ProviderContext) - Static method in class com.sun.portal.providers.context.Theme

Gets the theme name to be used for displaying desktop.

getSelectedTab() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the selected tab, the current selected tab in the user's session .

getSelectedTab() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the selected tab, the current selected tab in the user's session .

getSelectedTabName() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the selected tab Name, the current selected tab in the user's session .

getSelectedTabName() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the selected tab Name, the current selected tab in the user's session .

getSelectedTabs() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the List of selected tabs.

getSelectedTabs() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the List of selected tabs.

getServletConfig() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the ServletConfig.

getSessionID() - Method in class com.sun.portal.search.demo.Search

getSessionID() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the unique session identifier.

getSessionProperty(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Get a session property.

getSince() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of the since property

getStartTab() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the start tab, the tab to be displayed when the user logs in.

getStartTab() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the start tab, the tab to be displayed when the user logs in.

getStartTabName() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the start tab Name, the name of the tab to be displayed when the user logs in.

getStartTabName() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets the start tab Name, the name of the tab to be displayed when the user logs in.

getStaticContentPath() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the URI prefix to web server static content.

getStringAttribute(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a string attribute.

getStringAttribute(String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a string attribute.

getStringProperty(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a string property for the channel.

getStringProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a localized string property for the channel.

getStringProperty(String, String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a string property for the channel.

getStringProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a String property.

getStringProperty(String, String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets a localized string property for the channel.

getStringProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the localized version of a String property.

getStringProperty(String, String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a String property.

getStringProperty(String, String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the localized version of a String property.

getStringResult() - Method in class com.sun.portal.search.demo.Search

Return result.

getStringValues() - Method in class com.sun.portal.search.soif.AVPair

Gets all valid values of this attribute.

getTab(String) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets a tab.

getTab(String) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Gets a tab.

getTabMap() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Gets the TabProperties as a map

getTabURL(UnmodifiableTab, HttpServletRequest) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Gets the Tab URL.

getTemplate(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets template for the provider.

getTemplate(String, Hashtable) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Gets template for the provider, and tag swap the results before returning.

getTemplate(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets a desktop template.

getTemplate(String, String, Hashtable) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets and tag swaps a desktop template.

getTemplateMostSpecificPath(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the most specific template path for the given channel name and the given template name.

getTemplatePath(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Gets the template path for the given channel name and the given template name.

getTimeout() - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the timeout for this container, in seconds.

getTitle() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the title for the channel.

getTitle() - Method in interface com.sun.portal.providers.Provider

Gets the title of this provider.

getTitleOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of titleOp

getTitleVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the title value

getToHit() - Method in class com.sun.portal.search.demo.Search

Gets the last hit value being displayed

getTotalPages() - Method in class com.sun.portal.search.providers.SearchContext

Gets the total pages

getURL() - Method in class com.sun.portal.search.soif.SOIF

getUrlOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of urlOp

getUrlVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of urlVal

getUserID() - Method in interface com.sun.portal.providers.context.ProviderContext

Get the user identifier.

getValue() - Method in class com.sun.portal.search.soif.AVPair

getValue(int) - Method in class com.sun.portal.search.soif.AVPair

getValue(String) - Method in class com.sun.portal.search.soif.SOIF

Gets a String value by attribute.

getValue(String, int) - Method in class com.sun.portal.search.soif.SOIF

Gets a String value by multivalue attribute and index.

getViewAttributes() - Method in class com.sun.portal.search.demo.Search

Returns the SOIF attributes which are retrieved by a search.

getViewHits() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the viewHits value

getViewHits() - Method in class com.sun.portal.search.demo.Search

Get the maximum number of hits returned.

getViewOrder() - Method in class com.sun.portal.search.demo.Search

Gets the sorting order for results.

getWidth() - Method in class com.sun.portal.providers.ProviderAdapter

Gets the width for the channel that this is providing an environment for.

getWidth() - Method in interface com.sun.portal.providers.Provider

Gets the width of this provider.

getWidths(int) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets table's left,center,right width based of the table container's layout property.

getWindowName(String) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Gets the window name for the detach window when a channel is detached

getWordsOp() - Method in class com.sun.portal.search.providers.SearchRequestBean

Get the value of wordsOp

getWordsVal() - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the value of wordsVal

getWrapped() - Method in class com.sun.portal.providers.ProviderException

getWrapped() - Method in class com.sun.portal.providers.context.ProviderContextException

GREATER - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to '>' operation used to compare number type

H

htmlEncode(String) - Static method in class com.sun.portal.search.providers.SearchContext

Encodes > <, ", & characters

I

init(HttpServletRequest) - Method in interface com.sun.portal.providers.context.ProviderContext

Initializes this provider context.

init(ServletConfig) - Method in class com.sun.portal.desktop.DesktopServlet

init(String, HttpServletRequest) - Method in class com.sun.portal.providers.ProviderAdapter

init(String, HttpServletRequest) - Method in interface com.sun.portal.providers.Provider

Initializes the provider.

init(String, HttpServletRequest) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Initializes the JSPTableContainerProvider.

init(String, HttpServletRequest) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Initializes the TabContainerProvider.

init(String, HttpServletRequest) - Method in class com.sun.portal.providers.jsp.JSPProvider

Initializes the JSPProvider.

initProviders(HttpServletRequest, String, List, int) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Initializes a set of channels.

insert(AVPair) - Method in class com.sun.portal.search.soif.SOIF

Inserts an AVPair, which may be either single or multivalued.

insert(byte[], int) - Method in class com.sun.portal.search.soif.AVPair

Inserts a byte array at the given index, no duplicates.

insert(String, byte[]) - Method in class com.sun.portal.search.soif.SOIF

Inserts a byte array valued attribute.

insert(String, byte[], int) - Method in class com.sun.portal.search.soif.SOIF

Inserts a String valued attribute with index.

insert(String, int) - Method in class com.sun.portal.search.soif.AVPair

Inserts a String at the given index, no duplicates.

insert(String, String) - Method in class com.sun.portal.search.soif.SOIF

Inserts a String valued attribute.

insert(String, String, int) - Method in class com.sun.portal.search.soif.SOIF

Inserts a String valued attribute with index.

InvalidEditFormDataException - exception com.sun.portal.providers.InvalidEditFormDataException.

This exception (or a subclass of) should be thrown from the Provider.processEdit method when there is an error in the data input by the user.

InvalidEditFormDataException(String) - Constructor for class com.sun.portal.providers.InvalidEditFormDataException

Constructs a new exception with the specified message, indicating an error in the data input is entered by the user in the edit page.

INVALIDSOIF - Static variable in class com.sun.portal.search.soif.SOIF

Error message for invalid SOIF.

isAllowed(String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Deprecated. use getBooleanProperty()

isDebugEnabled() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets if the debug is enabled

isDebugErrorEnabled() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets if the debug is set to error

isDebugMessageEnabled() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets if the debug level is set to message or higher.

isDebugWarningEnabled() - Method in interface com.sun.portal.providers.context.ProviderContext

Gets if the debug level is set to warning or higher.

isEditable() - Method in class com.sun.portal.providers.ProviderAdapter

Gets if the channel is editable.

isEditable() - Method in interface com.sun.portal.providers.Provider

This method determines if the provider has an edit view.

isEOS() - Method in class com.sun.portal.search.soif.SOIFInputStream

isMV() - Method in class com.sun.portal.search.soif.AVPair

isPredefined() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Determines if the tab is predefined or user created.

isPresentable() - Method in class com.sun.portal.providers.ProviderAdapter

Dictates whether the provider is presentable.

isPresentable() - Method in interface com.sun.portal.providers.Provider

Determines if the provider is presentable based on the client device type.

isPresentable() - Method in class com.sun.portal.providers.jsp.JSPProvider

Dictates whether the provider is presentable.

isRemovable() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Determines if the tab is removable.

isRenamable() - Method in interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab

Determines if the tab is renamable.

J

JSPContainerProviderAdapter - class com.sun.portal.providers.containers.JSPContainerProviderAdapter.

This class provides default implementations of methods in the ContainerProvider interface implemented using a containerProviderContext object as the persistent store and extends JSPProvider to facilitate the execution of JSPs

JSPContainerProviderAdapter() - Constructor for class com.sun.portal.providers.containers.JSPContainerProviderAdapter

JSPProvider - class com.sun.portal.providers.jsp.JSPProvider.

A JSPProvider is a content provider that can use JavaServer Pages (JSPs) to create the content for a channel on the desktop.

JSPProvider() - Constructor for class com.sun.portal.providers.jsp.JSPProvider

Constructs a JSPProvider.

JSPSingleContainerProvider - class com.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider.

This class provides the implementation for JSPSingleContainerProvider and extends JSPContainerProviderAdapter Single Container simply displays a single leaf channel or a container.

JSPSingleContainerProvider() - Constructor for class com.sun.portal.providers.containers.jsp.single.JSPSingleContainerProvider

JSPTabContainerProvider - class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider.

This class provides the implementation for JSPTabContainerProvider and extends JSPContainerProviderAdapter and implements TabContainer A TabContainer provider is a container provider that generates its views primarily by being a client of table container objects.The Tab Container displays one of its contained channels at a time.

JSPTabContainerProvider() - Constructor for class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

JSPTableContainerProvider - class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider.

This class provides the implementation for JSPTableContainerProvider and extends JSPContainerProviderAdapter The table container facilitates the aggregation of multiple channels into a single display.

JSPTableContainerProvider() - Constructor for class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

K

keywordsOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

L

LEFT - Static variable in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Left column in the TableContainerProvider

LESS - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to '<' operation used to compare number type

lmodifiedOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

M

merge(SOIF) - Method in class com.sun.portal.search.soif.SOIF

Copies all data from another SOIF with replacement.

merge(SOIF, String[]) - Method in class com.sun.portal.search.soif.SOIF

Copies selected data from another SOIF with replacement.

ModifiableTab - interface com.sun.portal.providers.containers.jsp.tab.ModifiableTab.

This class represents an instance of the tab that can be modified.

N

noHits() - Method in class com.sun.portal.search.demo.Search

NOT - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <NOT> operation

NOTCONTAIN - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <NOT> <CONTAINS> operation

NOTEQUAL - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to 'not equal to' operation used to compare number type

nthValid(int) - Method in class com.sun.portal.search.soif.AVPair

O

OPERAND - Static variable in class com.sun.portal.search.providers.SearchContext

OPERATION - Static variable in class com.sun.portal.search.providers.SearchContext

The operation in a list element

P

PASSAGE - Static variable in class com.sun.portal.search.providers.SearchContext

corresponds to <PASSAGE> string operation

printConfigAttributes(ServletContext) - Static method in class com.sun.portal.desktop.DesktopServlet

printStackTrace() - Method in class com.sun.portal.providers.ProviderException

printStackTrace() - Method in class com.sun.portal.providers.context.ProviderContextException

printStackTrace(PrintStream) - Method in class com.sun.portal.providers.ProviderException

printStackTrace(PrintStream) - Method in class com.sun.portal.providers.context.ProviderContextException

printStackTrace(PrintWriter) - Method in class com.sun.portal.providers.ProviderException

printStackTrace(PrintWriter) - Method in class com.sun.portal.providers.context.ProviderContextException

processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.ProviderAdapter

Calls the processEdit(Map) method in this object to provide backwards compatibility.

processEdit(HttpServletRequest, HttpServletResponse) - Method in interface com.sun.portal.providers.Provider

Processes a form for this provider.

processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Processes data for this container.

processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Process a form for this provider.

processEdit(HttpServletRequest, HttpServletResponse) - Method in class com.sun.portal.providers.jsp.JSPProvider

Performs the provider's edit page processing by executing a JSP.

processEdit(Map) - Method in class com.sun.portal.providers.ProviderAdapter

Deprecated. Using this method has negative performance implications. Use processEdit(HttpServletRequest, HttpServletResponse) instead.

processEdit(Map) - Method in interface com.sun.portal.providers.Provider

Deprecated. Using this method has negative performance implications. Use processEdit(HttpServletRequest, HttpServletResponse) instead.

ProfileProviderAdapter - class com.sun.portal.providers.ProfileProviderAdapter.

This class adds convenience wrappers around some commonly used methods in the ProviderContext interface.

ProfileProviderAdapter() - Constructor for class com.sun.portal.providers.ProfileProviderAdapter

Provider - interface com.sun.portal.providers.Provider.

Provider defines the interface for implementing the provider component of a channel.

ProviderAdapter - class com.sun.portal.providers.ProviderAdapter.

This class provides default implementations of methods in the Provider interface implemented using a ProviderContext object as the persistent store.

ProviderAdapter() - Constructor for class com.sun.portal.providers.ProviderAdapter

ProviderContext - interface com.sun.portal.providers.context.ProviderContext.

An environment for provider execution.

ProviderContextException - exception com.sun.portal.providers.context.ProviderContextException.

This exception is a generic superclass for all provider related exceptions.

ProviderContextException(String) - Constructor for class com.sun.portal.providers.context.ProviderContextException

Constructs a new exception with the specified message, indicating an error in the provider context as happened.

ProviderContextException(String, Throwable) - Constructor for class com.sun.portal.providers.context.ProviderContextException

Constructs a new exception with the specified message, and the original exception or error, indicating an error in the provider context as happened.

ProviderEditTypes - interface com.sun.portal.providers.ProviderEditTypes.

This class defines the edit types that can be returned from the Provider.getEditType() method.

ProviderException - exception com.sun.portal.providers.ProviderException.

This exception is a generic superclass for all provider related exceptions.

ProviderException(String) - Constructor for class com.sun.portal.providers.ProviderException

Constructs a new exception with the specified message, indicating an error in the provider as happened.

ProviderException(String, Throwable) - Constructor for class com.sun.portal.providers.ProviderException

Constructs a new exception with the specified message, and the original exception or error, indicating an error in the provider as happened.

ProviderWidths - interface com.sun.portal.providers.ProviderWidths.

This class defines the widths that can be returned from the Provider.getWidth() method.

put(Object, Object) - Method in class com.sun.portal.search.soif.SOIF

Case insensistive collection function.

putCachedContent(String, StringBuffer) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Puts the cached content into a map and using the provider name as the key.

R

readSOIF() - Method in class com.sun.portal.search.soif.SOIFInputStream

Reads a single SOIF from the underlying input stream.

refresh() - Method in interface com.sun.portal.providers.context.ProviderContext

remove(int) - Method in class com.sun.portal.search.soif.AVPair

Removes a mutivalued entry by index.

remove(Object) - Method in class com.sun.portal.search.soif.SOIF

Case insensistive collection function.

remove(String) - Method in class com.sun.portal.search.soif.SOIF

Removes an attribute.

remove(String, int) - Method in class com.sun.portal.search.soif.SOIF

Removes an attribute by index.

removeChannel(String) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Removes a global scope channel.

removeTab(String) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Removes the tab.

rename(String, String) - Method in class com.sun.portal.search.soif.SOIF

Renames attribute a to b.

replace(AVPair) - Method in class com.sun.portal.search.soif.SOIF

Replaces an attribute-value pair by name.

replace(byte[], int) - Method in class com.sun.portal.search.soif.AVPair

Replaces the byte array at the given index.

replace(String, int) - Method in class com.sun.portal.search.soif.AVPair

Replaces the string at the given index.

replace(String, String) - Method in class com.sun.portal.search.soif.SOIF

Replaces a single-valued attribute.

replace(String, String, int) - Method in class com.sun.portal.search.soif.SOIF

Replaces a multivalued attribute by index.

RIGHT - Static variable in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Right column in the TableContainerProvider

S

Search - class com.sun.portal.search.demo.Search.

Search encapsulation class.

Search() - Constructor for class com.sun.portal.search.demo.Search

Constructor.

Search(String, String) - Constructor for class com.sun.portal.search.demo.Search

Constructor.

Search(String, String, String, int, int, String, String, String, String) - Constructor for class com.sun.portal.search.demo.Search

Constructor.

SearchContext - class com.sun.portal.search.providers.SearchContext.

This class provides convenient methods to handle advanced search and also evolved from the frontend application requirements.

SearchContext() - Constructor for class com.sun.portal.search.providers.SearchContext

Public Constructor calls super()

SearchEditFormBean - class com.sun.portal.search.providers.SearchEditFormBean.

SearchEditForm is a helper bean for the search edit jsp.

SearchEditFormBean() - Constructor for class com.sun.portal.search.providers.SearchEditFormBean

SearchRequestBean - class com.sun.portal.search.providers.SearchRequestBean.

The SearchRequestBean is a helper bean used by the search JSP's.

SearchRequestBean() - Method in class com.sun.portal.search.providers.SearchRequestBean

Public Constructor

SearchRequestBean() - Constructor for class com.sun.portal.search.providers.SearchRequestBean

setAllowed(Set) - Method in class com.sun.portal.search.soif.SOIFInputStream

Sets a SOIF attribute filter.

setAllowed(Set) - Method in class com.sun.portal.search.soif.SOIFOutputStream

Sets the allowed attributes on oouput.

setAttribute(String) - Method in class com.sun.portal.search.soif.AVPair

(Re)names an AVPair.

setAuthorOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of authorOp

setAuthorVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of authorVal

setAvailableChannels(List) - Method in interface com.sun.portal.providers.containers.ContainerProvider

Sets the list of available channel names.

setAvailableChannels(List) - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

setAvailableChannels(List) - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

setAvailableChannels(List) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the list of available channel names.

setAvailableChannels(String, List) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Sets the available channels for the container channel that this is providing an environment for.

setBooleanProperty(String, boolean) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a boolean property for the channel.

setBooleanProperty(String, String, boolean) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets a boolean property.

setBrowseCategory(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the current category

setCategory(String) - Method in class com.sun.portal.search.providers.SearchContext

Sets the category value.

setCategorySearch(Boolean) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Sets the categorySearch property

setClientProperty(String, String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a client property.

setClientProperty(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Set a client property.

setCollectionProperty(String, String, List) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets a collection property.

setCollectionProperty(String, String, Map) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets a collection property.

setColumn(HttpServletRequest, String, int) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Sets the column for this channel to be displayed in.

setCustomAttribute(String, ProviderContext, String, String) - Static method in class com.sun.portal.providers.context.Theme

Sets an attribute value of the custom theme.

setDatabase(String) - Method in class com.sun.portal.search.demo.Search

setDefaultSearch(Boolean) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Sets the boolean defaultSearch property

setDesc(String) - Method in interface com.sun.portal.providers.containers.jsp.tab.ModifiableTab

Sets the description of the tab

setDescription(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Gets the description.

setDescription(String) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Sets the description property

setDisplayname(String) - Method in interface com.sun.portal.providers.containers.jsp.tab.ModifiableTab

Sets the display name of the tab

setDocumentDisplay(String) - Method in class com.sun.portal.search.providers.SearchEditFormBean

Sets the documentDisplay property

setExpiresOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of expiresOp

setExpiresVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the expiresVal property

setFirstHit(int) - Method in class com.sun.portal.search.demo.Search

Set the starting hit offset.

setIntegerProperty(String, int) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a integer property for the channel.

setIntegerProperty(String, String, int) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets an integer property.

setKeywordsOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of keywordsOp

setKeywordsVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of keywordsVal

setLayout(int) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Sets the layout for this container.

setListProperty(String, List) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a list property for the channel.

setLmodifiedOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the lmodifiedOp property

setLmodifiedVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the lmodifiedVal property

setMapProperty(String, Map) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a map property for the channel.

setMode(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the search mode

setNowords(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of nowords

setPage(int) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the current page value

setPage(int) - Method in class com.sun.portal.search.providers.SearchContext

Sets the current page value.

setProperty(String, String, Object) - Method in interface com.sun.portal.providers.context.ProviderContext

TBD

setQueryLanguage(String) - Method in class com.sun.portal.search.demo.Search

Sets the query language.

setRDMServer(String) - Method in class com.sun.portal.search.demo.Search

Sets the RDMServer variable.

setRDMType(String) - Method in class com.sun.portal.search.demo.Search

Sets the RDM Request type.

setRow(HttpServletRequest, String, int) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Sets the row for this channel to be displayed in.

setScat(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Set the value of the scat radio button

setSchemaName(String) - Method in class com.sun.portal.search.soif.SOIF

Sets the SOIF schema name.

setScope(ArrayList) - Method in class com.sun.portal.search.providers.SearchContext

Sets the list of criteria for the scope.

setScope(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the query string value

setScope(String) - Method in class com.sun.portal.search.demo.Search

Sets the scope (query) for the search.

setSearchAllCategories(boolean) - Method in class com.sun.portal.search.providers.SearchContext

Sets the searchAllCategories property.

setSelectedChannels(List) - Method in interface com.sun.portal.providers.containers.ContainerProvider

Sets the list of selected channel names.

setSelectedChannels(List) - Method in class com.sun.portal.providers.containers.ContainerProviderAdapter

setSelectedChannels(List) - Method in class com.sun.portal.providers.containers.JSPContainerProviderAdapter

setSelectedChannels(List) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the list of selected channel names.

setSelectedChannels(String, List) - Method in interface com.sun.portal.providers.context.ContainerProviderContext

Sets the selected channels for the container channel that this is providing an environment for.

setSelectedName(String, ProviderContext, String) - Static method in class com.sun.portal.providers.context.Theme

Sets the theme to be used for displaying desktop.

setSelectedTab(ModifiableTab) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the selected tab Name in the session.

setSelectedTab(ModifiableTab) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets the selected tab Name in the session.

setSelectedTabName(String) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the selected tab Name in the session

setSelectedTabName(String) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets the selected tab Name in the session

setSessionID(String) - Method in class com.sun.portal.search.demo.Search

setSessionProperty(String, Object) - Method in interface com.sun.portal.providers.context.ProviderContext

Set a session property.

setSince(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the since property

setSOIFParse(boolean) - Method in class com.sun.portal.search.demo.Search

Set whether SOIF parsing is to be done or not.

setStartTabName() - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStartTabName() - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStartTabName(String) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStartTabName(String) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStartTabName(UnmodifiableTab) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStartTabName(UnmodifiableTab) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets the start tab Name, the name of the tab to be displayed when the user logs in.

setStreamMode(boolean) - Method in class com.sun.portal.search.demo.Search

Sets whether streaming is enabled or disabled.

setStringAttribute(String, String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a string attribute.

setStringAttribute(String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets a string attribute.

setStringProperty(String, String) - Method in class com.sun.portal.providers.ProfileProviderAdapter

Sets a string property for the channel.

setStringProperty(String, String, String) - Method in interface com.sun.portal.providers.context.ProviderContext

Sets a string property.

setTab(ModifiableTab) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets a tab.

setTab(ModifiableTab) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets a tab.

setTab(ModifiableTab, boolean) - Method in class com.sun.portal.providers.containers.jsp.tab.JSPTabContainerProvider

Sets a tab.

setTab(ModifiableTab, boolean) - Method in interface com.sun.portal.providers.containers.jsp.tab.TabContainer

Sets a tab.

setTitleOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of titleOp

setTitleVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the titleVal

setupColumns(HttpServletRequest) - Method in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Constructs the channel into three columns, the left column, the center column, and the right column.

setURL(String) - Method in class com.sun.portal.search.soif.SOIF

Sets the SOIF URL.

setUrlOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of urlOp

setUrlVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of urlVal

setViewAttributes(String) - Method in class com.sun.portal.search.demo.Search

Sets the SOIF attributes which are returned for the search.

setViewHits(int) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the viewHits value

setViewHits(int) - Method in class com.sun.portal.search.demo.Search

Set the maximum number of hits returned.

setViewOrder(String) - Method in class com.sun.portal.search.demo.Search

Sets the sorting order for results.

setWordsOp(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of wordsOp

setWordsVal(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

Sets the value of wordsVal

sinceSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

size() - Method in class com.sun.portal.search.soif.AVPair

SOIF - class com.sun.portal.search.soif.SOIF.

SOIF (Summary Object Interchange Format) is a general purpose syntax and data structure for representing meta data.

SOIF() - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIF(byte[]) - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIF(byte[], Set) - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIF(byte[], String) - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIF(byte[], String, Set) - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIF(String, String) - Constructor for class com.sun.portal.search.soif.SOIF

Constructor.

SOIFBuffer - class com.sun.portal.search.soif.SOIFBuffer.

SOIFBuffer is a convenience class for temporary storage of serialized SOIF objects.

SOIFBuffer() - Constructor for class com.sun.portal.search.soif.SOIFBuffer

Creates a new SOIFBuffer with default capacity 2000 bytes

SOIFBuffer(int) - Constructor for class com.sun.portal.search.soif.SOIFBuffer

Creates new SOIFBuffer with specified initial capacity

SOIFException - exception com.sun.portal.search.soif.SOIFException.

SOIFException() - Constructor for class com.sun.portal.search.soif.SOIFException

Creates new SOIFException without detail message.

SOIFException(String) - Constructor for class com.sun.portal.search.soif.SOIFException

Constructs an SOIFException with the specified detail message.

SOIFInputStream - class com.sun.portal.search.soif.SOIFInputStream.

SOIFInputStream class.

SOIFInputStream(byte[]) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from a byte array.

SOIFInputStream(byte[], String) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from a byte array.

SOIFInputStream(InputStream) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from an InputStream.

SOIFInputStream(InputStream, String) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from an InputStream.

SOIFInputStream(SOIFBuffer) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from a SOIFBuffer.

SOIFInputStream(String) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from the named file.

SOIFInputStream(String, String) - Constructor for class com.sun.portal.search.soif.SOIFInputStream

Creates a SOIFInputStream reading from the named file.

SOIFOutputStream - class com.sun.portal.search.soif.SOIFOutputStream.

SOIFOutputStream class.

SOIFOutputStream(OutputStream) - Constructor for class com.sun.portal.search.soif.SOIFOutputStream

Creates a new SOIFOutputStream

SOIFOutputStream(OutputStream, String) - Constructor for class com.sun.portal.search.soif.SOIFOutputStream

Creates a new SOIFOutputStream

SOIFOutputStream(String) - Constructor for class com.sun.portal.search.soif.SOIFOutputStream

Creates a new file based SOIFOutputStream using the default character encoding (UTF-8)

SOIFOutputStream(String, String) - Constructor for class com.sun.portal.search.soif.SOIFOutputStream

Creates a new file based SOIFOutputStream

squeeze() - Method in class com.sun.portal.search.soif.AVPair

Packs the index array by closing all holes towards the index zero.

squeezeMV() - Method in class com.sun.portal.search.soif.SOIF

Squeezes multivalued attributes.

T

TabContainer - interface com.sun.portal.providers.containers.jsp.tab.TabContainer.

TabContainer defines the interface for implementing a Tab Container provider.

Theme - class com.sun.portal.providers.context.Theme.

A Theme is a collection of visual elements to be used when displaying a desktop.

Theme() - Constructor for class com.sun.portal.providers.context.Theme

titleOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

toByteArray() - Method in class com.sun.portal.search.soif.SOIF

Creates a byte array representation of this SOIF.

toByteArray(Set) - Method in class com.sun.portal.search.soif.SOIF

Creates a byte array representation of this SOIF.

toByteArray(String) - Method in class com.sun.portal.search.soif.SOIF

Creates a byte array representation of this SOIF.

toByteArray(String, Set) - Method in class com.sun.portal.search.soif.SOIF

Creates a byte array representation of this SOIF.

TOP - Static variable in class com.sun.portal.providers.containers.jsp.table.JSPTableContainerProvider

Top Row in the TableContainerProvider

toString() - Method in class com.sun.portal.search.demo.Search

Return debug string version of Search instance.

toString() - Method in class com.sun.portal.search.soif.SOIF

*WARNING*: This should be used for debugging only.

toString() - Method in class com.sun.portal.search.soif.AVPair

toString() - Method in class com.sun.portal.providers.ProviderException

toString() - Method in class com.sun.portal.providers.context.ProviderContextException

U

UnknownEditTypeException - exception com.sun.portal.providers.UnknownEditTypeException.

This exception may be thrown from Provider.getEditType() if an unknown or undefined edit type is encountered.

UnknownEditTypeException(String) - Constructor for class com.sun.portal.providers.UnknownEditTypeException

Constructs a new exception with the specified message, indicating an unexpected edit type is encountered.

UnknownEditTypeException(String, Throwable) - Constructor for class com.sun.portal.providers.UnknownEditTypeException

Constructs a new exception with the specified message, and the original exception or error.

UnmodifiableTab - interface com.sun.portal.providers.containers.jsp.tab.UnmodifiableTab.

This interface represents a tab that cannot be modified.

urlOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

URLScraperProvider - class com.sun.portal.providers.urlscraper.URLScraperProvider.

A URLScraperProvider is a content provider that can retrieve and display HTML content from a given URL.

URLScraperProvider() - Constructor for class com.sun.portal.providers.urlscraper.URLScraperProvider

Default constructor.

V

value - Variable in class com.sun.portal.search.soif.AVPair

Attribute value.

VALUE - Static variable in class com.sun.portal.search.providers.SearchContext

The right operand in a list element

valueCount() - Method in class com.sun.portal.search.soif.AVPair

viewhitsSelection(int) - Method in class com.sun.portal.search.providers.SearchRequestBean

W

WIDTH_FULL_BOTTOM - Static variable in interface com.sun.portal.providers.ProviderWidths

Provider can be displayed in a "full" frame at the bottom.

WIDTH_FULL_TOP - Static variable in interface com.sun.portal.providers.ProviderWidths

Provider can be displayed in a "full" frame at the top.

WIDTH_THICK - Static variable in interface com.sun.portal.providers.ProviderWidths

Provider can be displayed in a "thick" frame.

WIDTH_THIN - Static variable in interface com.sun.portal.providers.ProviderWidths

Provider can be displayed in a "thin" frame.

wordsOpSelection(String) - Method in class com.sun.portal.search.providers.SearchRequestBean

write(SOIF) - Method in class com.sun.portal.search.soif.SOIFOutputStream

Writes a SOIF object to this output stream.

write(SOIF, Set) - Method in class com.sun.portal.search.soif.SOIFOutputStream

Writes a SOIF to this output stream including only the allowed attributes.

X

XMLProvider - class com.sun.portal.providers.xml.XMLProvider.

A XML Provider is used to convert and display the XML file according to the specified style sheet.

XMLProvider() - Constructor for class com.sun.portal.providers.xml.XMLProvider

A B C D E G H I J K L M N O P R S T U V W X