|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentLibrary
Represents a library containing Document
s.
Method Summary | |
---|---|
java.lang.String |
getDescription()
Returns the description of this DocumentLibrary object. |
java.lang.String |
getDescription(java.util.Locale locale)
Returns the localized description of this DocumentLibrary object. |
java.lang.String |
getDescriptionTextProviderKey()
If a text provider has been configured, this method returns the text provider key for the description of this DocumentLibrary . |
java.lang.String |
getDescriptionTextProviderName()
If a text provider has been configured, this method returns the text provider name for the description of this DocumentLibrary . |
java.lang.String |
getId()
Returns the unique Id of this DocumentLibrary object. |
DocumentLibraryACL |
getLibraryAccess()
Returns the access control object for this DocumentLibrary |
DocumentLibraryACL |
getLibraryResourceAccess(LibraryResourceType type)
Returns the access control object for a library resource (e.g. |
java.util.Locale |
getLocale()
Returns the Locale of this DocumentLibrary object. |
java.lang.String |
getName()
Returns the name of this DocumentLibrary object. |
Folder |
getPresetFolder(com.ibm.workplace.wcm.api.PresetFolderType type)
Returns a reference to the specified preset Folder for the current library |
LibraryProperties |
getProperties()
Returns the properties associated with this Library. |
java.lang.String |
getTitle()
Returns the title of this DocumentLibrary object. |
java.lang.String |
getTitle(java.util.Locale locale)
Returns the localized title of this DocumentLibrary object. |
java.lang.String |
getTitleTextProviderKey()
If a text provider has been configured, this method returns the text provider key for the title of this DocumentLibrary . |
java.lang.String |
getTitleTextProviderName()
If a text provider has been configured, this method returns the text provider name for the title of this DocumentLibrary . |
boolean |
hasLibraryAccess(LibraryMemberRole role,
UserProfile user)
Returns true if the user identified by the supplied UserProfile has the indicated role
in this library |
boolean |
hasLibraryResourceAccess(LibraryResourceType type,
LibraryMemberRole role,
UserProfile user)
Returns true if the user identified by the supplied UserProfile has the indicated role
against the specified resource type of this library |
boolean |
isDeletionProhibited()
Indicates if this DocumentLibrary has deletion prohibited. |
boolean |
isEnabled()
Indicates if this DocumentLibrary is enabled |
void |
setDeletionProhibited(boolean isDeletionProhibited)
Set the DocumentLibrary deletion prohibited status |
void |
setDescription(java.lang.String description)
Set the description of this DocumentLibrary |
void |
setDescriptionTextProviderKey(java.lang.String key)
Set the text provider key for the description of this DocumentLibrary . |
void |
setDescriptionTextProviderName(java.lang.String name)
Set the text provider name for the description of this DocumentLibrary . |
void |
setEnabled(boolean isEnabled)
Set the DocumentLibrary enabled status (enable or disable) |
void |
setLibraryAccess(DocumentLibraryACL acl)
Set the access control for this DocumentLibrary |
void |
setLibraryResourceAccess(LibraryResourceType type,
DocumentLibraryACL acl)
Set the access control for the supplied library resource type |
void |
setTitle(java.lang.String title)
Set the title of this DocumentLibrary . |
void |
setTitleTextProviderKey(java.lang.String key)
Set the text provider key for the title of this DocumentLibrary . |
void |
setTitleTextProviderName(java.lang.String name)
Set the text provider name for the title of this DocumentLibrary . |
Method Detail |
---|
java.lang.String getId()
DocumentLibrary
object.
java.lang.String getName()
DocumentLibrary
object.
This is simply the lower-cased title.
getName
in interface WCMApiObject
java.lang.String getTitle()
DocumentLibrary
object.
void setTitle(java.lang.String title)
DocumentLibrary
.
The title is used in the library URL, so only valid URL characters are allowed.
Valid characters are a-z, A-Z, 0-9 and the special characters " $-_.+!*(),".
title
- Title to be setjava.lang.String getTitle(java.util.Locale locale)
DocumentLibrary
object.
If a text provider has been configured, the localized title retrieved from the
text provider will be returned. If no text provider is configured, the non-localized title
of this DocumentLibrary
object will be returned.
locale
- the locale to use when localizing the title
java.lang.String getTitleTextProviderName()
DocumentLibrary
. Otherwise, null will be returned.
void setTitleTextProviderName(java.lang.String name)
DocumentLibrary
.
name
- the text provider name for the titlejava.lang.String getTitleTextProviderKey()
DocumentLibrary
. Otherwise, null will be returned.
void setTitleTextProviderKey(java.lang.String key)
DocumentLibrary
.
key
- the text provider key for the titlejava.lang.String getDescription()
DocumentLibrary
object.
java.lang.String getDescription(java.util.Locale locale)
DocumentLibrary
object.
If a text provider has been configured, the localized description retrieved from the
text provider will be returned. If no text provider is configured, the non-localized description
of this DocumentLibrary
object will be returned.
locale
- the locale to use when localizing the description
Returns null if this Document does not have a description.
void setDescription(java.lang.String description)
DocumentLibrary
description
- Description to be setjava.lang.String getDescriptionTextProviderName()
DocumentLibrary
. Otherwise, null will be returned.
void setDescriptionTextProviderName(java.lang.String name)
DocumentLibrary
.
name
- the text provider name for the descriptionjava.lang.String getDescriptionTextProviderKey()
DocumentLibrary
. Otherwise, null will be returned.
void setDescriptionTextProviderKey(java.lang.String key)
DocumentLibrary
.
key
- the text provider key for the descriptionboolean hasLibraryResourceAccess(LibraryResourceType type, LibraryMemberRole role, UserProfile user)
UserProfile
has the indicated role
against the specified resource type of this library
Checks against the persisted ACL only. Not any unsaved changes
type
- The resource type access to checkrole
- The role to checkuser
- The user to test
UserProfile
has the indicated role
against the specified resource type of this library, false otherwiseDocumentLibraryACL getLibraryResourceAccess(LibraryResourceType type)
type
- Library resource type
DocumentLibraryACL
which represents the requested library resource access controlboolean hasLibraryAccess(LibraryMemberRole role, UserProfile user)
UserProfile
has the indicated role
in this library
Checks against the persisted ACL only. Not any unsaved changes
role
- The role to checkuser
- The user to test
UserProfile
has the indicated role
in this library, false otherwiseDocumentLibraryACL getLibraryAccess()
DocumentLibrary
DocumentLibraryACL
which represents the library access controlvoid setLibraryAccess(DocumentLibraryACL acl)
DocumentLibrary
acl
- the access control object to be set for this libraryvoid setLibraryResourceAccess(LibraryResourceType type, DocumentLibraryACL acl)
type
- Library resource typeacl
- the access control object to be set for the given library resourceboolean isEnabled()
DocumentLibrary
is enabled
DocumentLibrary
is enabledvoid setEnabled(boolean isEnabled)
DocumentLibrary
enabled status (enable or disable)
isEnabled
- Flag indicating if the DocumentLibrary
is to be set enabledboolean isDeletionProhibited()
DocumentLibrary
has deletion prohibited.
DocumentLibrary
has deletion prohibitedvoid setDeletionProhibited(boolean isDeletionProhibited)
DocumentLibrary
deletion prohibited status
isDeletionProhibited
- Flag indicating if the library should prohibit deletionjava.util.Locale getLocale()
Locale
of this DocumentLibrary
object.
Locale
of the libraryFolder getPresetFolder(com.ibm.workplace.wcm.api.PresetFolderType type) throws com.ibm.workplace.wcm.api.exceptions.AuthorizationException, com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
type
- the type of Preset Folder to return
com.ibm.workplace.wcm.api.exceptions.AuthorizationException
com.ibm.workplace.wcm.api.exceptions.DocumentRetrievalException
LibraryProperties getProperties()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |