com.ibm.portal.admin
Interface ModifiableClient

All Superinterfaces:

Client, Identifiable, Modifiable, ModifiableIdentifiable, TimeStamped

public interface ModifiableClient
extends Client, ModifiableIdentifiable

An interface representing a modifiable client instance.

Since:

7.0.0

Method Summary

boolean	addCapabilities(java.util.Set<java.lang.String> aCapabilitiesSet) Adds all capabilities specified by the set.
boolean	addCapability(java.lang.String aCapability) Adds a capability.
boolean	confirmAddCapabilities(java.util.Set<java.lang.String> aCapabilitiesSet) Indicates if the specified capabilities may be set.
boolean	confirmAddCapability(java.lang.String aCapability) Indicates if the specified capability may be set.
boolean	confirmRemoveCapabilities() Indicates if all capabilities may be removed.
boolean	confirmRemoveCapabilities(java.lang.String aCapabilities) Indicates if the specified capabilities may be removed.
boolean	confirmSetManufacturer(java.lang.String aManufacturer) Indicates if the given manufacturer may be set.
boolean	confirmSetMarkup(Markup aMarkup) Indicates if the given markup may be set.
boolean	confirmSetMarkupVersion(java.lang.String aMarkupVersion) Indicates if the given markup version may be set.
boolean	confirmSetModel(java.lang.String aModel) Indicates if the given model may be set.
boolean	confirmSetUserAgentPattern(java.lang.String aUserAgentPattern) Indicates if the given user agent pattern may be set.
boolean	confirmSetVersion(java.lang.String aVersion) Indicates if the given version may be set.
java.util.Iterator<java.lang.String>	getCapabilities() Return a collection of Strings that denote the client capabilities.
boolean	removeCapabilities() Clears all capabilities.
boolean	removeCapability(java.lang.String aCapability) Removes a capability.
java.lang.String	setManufacturer(java.lang.String aManufacturer) Sets the client's manufacturer String.
Markup	setMarkup(Markup aMarkup) Sets the client's markup.
java.lang.String	setMarkupVersion(java.lang.String aMarkupVersion) Sets the client's markup version.
java.lang.String	setModel(java.lang.String aModel) Sets the client's model specification.
java.lang.String	setUserAgentPattern(java.lang.String aUserAgentPattern) Sets the client's user agent pattern.
java.lang.String	setVersion(java.lang.String aVersion) Sets the client's version string.

Methods inherited from interface com.ibm.portal.admin.Client

getManufacturer, getMarkup, getMarkupVersion, getModel, getUserAgentPattern, getVersion

Methods inherited from interface com.ibm.portal.TimeStamped

getCreated, getLastModified

Methods inherited from interface com.ibm.portal.ModifiableIdentifiable

getModifiableObjectID

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Method Detail

setUserAgentPattern

java.lang.String setUserAgentPattern(java.lang.String aUserAgentPattern)
                                     throws CannotModifyPropertyException,
                                            ModelException

Sets the client's user agent pattern.

Parameters:

aUserAgentPattern - The new user agent pattern

Returns:

the former user agent pattern or null if none has been set.

Throws:

CannotModifyPropertyException - in case the user agent pattern cannot be set

ModelException

confirmSetUserAgentPattern

boolean confirmSetUserAgentPattern(java.lang.String aUserAgentPattern)

Indicates if the given user agent pattern may be set.

Parameters:

aUserAgentPattern - The user agent pattern to set

Returns:

true if the specified user agent pattern may be set, false otherwise

setManufacturer

java.lang.String setManufacturer(java.lang.String aManufacturer)
                                 throws CannotModifyPropertyException,
                                        ModelException

Sets the client's manufacturer String.

Parameters:

aManufacturer - The new manufacturer String

Returns:

the former manufacturer String or null if none has been set.

Throws:

CannotModifyPropertyException - in case the manufacturer String cannot be set

ModelException

confirmSetManufacturer

boolean confirmSetManufacturer(java.lang.String aManufacturer)

Indicates if the given manufacturer may be set.

Parameters:

aManufacturer - The manufacturer to set

Returns:

true if the specified manufacturer may be set, false otherwise

setModel

java.lang.String setModel(java.lang.String aModel)
                          throws CannotModifyPropertyException,
                                 ModelException

Sets the client's model specification.

Parameters:

aModel - The new model specification

Returns:

the former model specification or null if none has been set.

Throws:

CannotModifyPropertyException - in case the model specification cannot be set

ModelException

confirmSetModel

boolean confirmSetModel(java.lang.String aModel)

Indicates if the given model may be set.

Parameters:

aModel - The model to set

Returns:

true if the specified model may be set, false otherwise

setVersion

java.lang.String setVersion(java.lang.String aVersion)
                            throws CannotModifyPropertyException,
                                   ModelException

Sets the client's version string.

Parameters:

aVersion - The new version string

Returns:

the former version string or null if none has been set.

Throws:

CannotModifyPropertyException - in case the version string cannot be set

ModelException

confirmSetVersion

boolean confirmSetVersion(java.lang.String aVersion)

Indicates if the given version may be set.

Parameters:

aVersion - The version to set

Returns:

true if the specified version may be set, false otherwise

setMarkupVersion

java.lang.String setMarkupVersion(java.lang.String aMarkupVersion)
                                  throws CannotModifyPropertyException,
                                         ModelException

Sets the client's markup version.

Parameters:

aMarkupVersion - The new markup version

Returns:

the former markup version string or null if none has been set.

Throws:

CannotModifyPropertyException - in case the markup version string cannot be set

ModelException

confirmSetMarkupVersion

boolean confirmSetMarkupVersion(java.lang.String aMarkupVersion)

Indicates if the given markup version may be set.

Parameters:

aMarkupVersion - The markup version to set

Returns:

true if the specified markup version may be set, false otherwise

setMarkup

Markup setMarkup(Markup aMarkup)
                 throws CannotModifyPropertyException,
                        ModelException

Sets the client's markup.

Parameters:

aMarkup - The new markup

Returns:

the former markup or null if none has been set.

Throws:

CannotModifyPropertyException - in case the markup cannot be set

ModelException

confirmSetMarkup

boolean confirmSetMarkup(Markup aMarkup)

Indicates if the given markup may be set.

Parameters:

aMarkup - The markup to set

Returns:

true if the specified markup may be set, false otherwise

getCapabilities

java.util.Iterator<java.lang.String> getCapabilities()
                                                     throws CannotModifyPropertyException,
                                                            ModelException

Return a collection of Strings that denote the client capabilities. The capabilities definitions specifies features that the client can support (Examples: JavaScript, XSL, etc). These can be used inside the JSP resources. The purpose of the Client capabilities is to trigger client specific code sequences inside JSPs.

Specified by:

getCapabilities in interface Client

Returns:

Iterator a collection of String objects that specify the Client capabilities

Throws:

CannotModifyPropertyException - in case the user agent pattern cannot be set are set only partially

ModelException - - An error occurs wile accessing the database

addCapability

boolean addCapability(java.lang.String aCapability)
                      throws CannotModifyPropertyException

Adds a capability.

Parameters:

aCapability - capability to add; must not be null

Returns:

true if this ModifiableClient was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the capability cannot be added

addCapabilities

boolean addCapabilities(java.util.Set<java.lang.String> aCapabilitiesSet)
                        throws CannotModifyPropertyException

Adds all capabilities specified by the set.

Parameters:

aCapabilitiesSet - set with the capabilities to add

Returns:

true if this Client was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a capability cannot be added; in this case the capabilities are added only partially

removeCapability

boolean removeCapability(java.lang.String aCapability)
                         throws CannotModifyPropertyException

Removes a capability.

Parameters:

aCapability - capability to remove; must not be null

Returns:

true if this Client was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the capability cannot be removed

removeCapabilities

boolean removeCapabilities()
                           throws CannotModifyPropertyException

Clears all capabilities.

Returns:

true if this Client was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a capability cannot be removed; in this case the capabilities are removed only partially

confirmAddCapability

boolean confirmAddCapability(java.lang.String aCapability)

Indicates if the specified capability may be set.

Parameters:

aCapability - capability for which to indicate if it may be set; must not be null

Returns:

true if the specified capability may be set, false otherwise

confirmAddCapabilities

boolean confirmAddCapabilities(java.util.Set<java.lang.String> aCapabilitiesSet)

Indicates if the specified capabilities may be set.

Parameters:

aCapabilitiesSet - set of capabilities (represented as Strings) for which to indicate if they may be set; must not be null

Returns:

true if the specified capabilities may be set, false otherwise

confirmRemoveCapabilities

boolean confirmRemoveCapabilities(java.lang.String aCapabilities)

Indicates if the specified capabilities may be removed.

Parameters:

aCapabilities - capabilities for which to indicate if it may be removed; must not be null

Returns:

true if the capabilities may be removed, false otherwise

confirmRemoveCapabilities

boolean confirmRemoveCapabilities()

Indicates if all capabilities may be removed.

Returns:

true if all capabilities may be removed, false otherwise