com.ibm.portal.resolver.webdav.tree.helper
Class DefaultWebdavSupportedPrivilege

java.lang.Object
  com.ibm.portal.resolver.webdav.tree.helper.DefaultWebdavSupportedPrivilege

All Implemented Interfaces:

Localized, WebdavSupportedPrivilege

public abstract class DefaultWebdavSupportedPrivilege
extends java.lang.Object
implements WebdavSupportedPrivilege

Provides information about a resource's supported privilege

Since:

7.0.0.1

Note:

This interface is designed to be implemented by clients.

Constructor Summary

DefaultWebdavSupportedPrivilege(java.util.Map<java.util.Locale,java.lang.String> description, boolean isAbstract)

Method Summary

java.lang.String	addDescription(java.util.Locale aLocale, java.lang.String text)
java.lang.String	getDescription(java.util.Locale aLocale) Returns the description of this object in the given locale.
ListModel<java.util.Locale>	getLocales() Returns a list model containing the locales that are supported by this object.
java.lang.String	getTitle(java.util.Locale aLocale) Returns the title of this object in the given locale.
boolean	isAbstract() Is the privilege abstract? Specifies whether a privilege is abstract.
void	setAbstract(boolean isAbstract)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.portal.resolver.webdav.tree.WebdavSupportedPrivilege

visitContainedPrivileges, visitPrivilege

Constructor Detail

DefaultWebdavSupportedPrivilege

public DefaultWebdavSupportedPrivilege(java.util.Map<java.util.Locale,java.lang.String> description,
                                       boolean isAbstract)

Method Detail

isAbstract

public boolean isAbstract()

Description copied from interface: WebdavSupportedPrivilege

Is the privilege abstract? Specifies whether a privilege is abstract. An abstract privilege cannot be set in an access control element (ACE) on that resource.

Specified by:

isAbstract in interface WebdavSupportedPrivilege

Returns:

if the privilege is abstract: true if it is abstract

setAbstract

public void setAbstract(boolean isAbstract)

getDescription

public java.lang.String getDescription(java.util.Locale aLocale)

Description copied from interface: Localized

Returns the description of this object in the given locale.

Specified by:

getDescription in interface Localized

Parameters:

aLocale - the locale for which to retrieve the description, must not be null.

Returns:

the description of this node in the given locale. If a description is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism

addDescription

public java.lang.String addDescription(java.util.Locale aLocale,
                                       java.lang.String text)

getLocales

public ListModel<java.util.Locale> getLocales()

Description copied from interface: Localized

Returns a list model containing the locales that are supported by this object. The presence of a locale in this list does not mean that a title and description is available, but rather that either one or both are available in that locale.

Specified by:

getLocales in interface Localized

Returns:

a list of locales defined for this object, returns an empty ListModel if no locales are supported.

getTitle

public java.lang.String getTitle(java.util.Locale aLocale)

Description copied from interface: Localized

Returns the title of this object in the given locale.

Specified by:

getTitle in interface Localized

Parameters:

aLocale - the locale for which to retrieve the title, must not be null.

Returns:

the title of this node in the given locale. If a title is not available in the given locale, this method will return null. It is up to the invoker of the method to implement an appropriate fallback mechanism.