com.ibm.workplace.wcm.api
Interface DocumentLibrary

public interface DocumentLibrary

Represents a library containing Documents.

Method Summary

java.lang.String	getDescription() Returns the description for 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.
java.lang.String	getTitle() Returns the title of this DocumentLibrary object.
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	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

Method Detail

getId

java.lang.String getId()

Returns the unique Id of this DocumentLibrary object.

Returns:

the unique id

getName

java.lang.String getName()

Returns the name of this DocumentLibrary object.

Returns:

the name of the library

getTitle

java.lang.String getTitle()

Returns the title of this DocumentLibrary object.

Returns:

the title of the library

setTitle

void setTitle(java.lang.String title)

Set the title of this DocumentLibrary

Parameters:

title - Title to be set

getLibraryResourceAccess

DocumentLibraryACL getLibraryResourceAccess(LibraryResourceType type)

Returns the access control object for a library resource (e.g. Authoring Templates)

Parameters:

type - Library resource type

Returns:

a DocumentLibraryACL which represents the requested library resource access control

getLibraryAccess

DocumentLibraryACL getLibraryAccess()

Returns the access control object for this DocumentLibrary

Returns:

a DocumentLibraryACL which represents the library access control

setLibraryAccess

void setLibraryAccess(DocumentLibraryACL acl)

Set the access control for this DocumentLibrary

Parameters:

acl - the access control object to be set for this library

setLibraryResourceAccess

void setLibraryResourceAccess(LibraryResourceType type,
                              DocumentLibraryACL acl)

Set the access control for the supplied library resource type

Parameters:

type - Library resource type

acl - the access control object to be set for the given library resource

getDescription

java.lang.String getDescription()

Returns the description for this DocumentLibrary

Returns:

the description of the DocumentLibrary

setDescription

void setDescription(java.lang.String description)

Set the description of this DocumentLibrary

Parameters:

description - Description to be set

isEnabled

boolean isEnabled()

Indicates if this DocumentLibrary is enabled

Returns:

a flag indicating if this DocumentLibrary is enabled

setEnabled

void setEnabled(boolean isEnabled)

Set the DocumentLibrary enabled status (enable or disable)

Parameters:

isEnabled - Flag indicating if the DocumentLibrary is to be set enabled

isDeletionProhibited

boolean isDeletionProhibited()

Indicates if this DocumentLibrary has deletion prohibited.

Returns:

a flag indicates if this DocumentLibrary has deletion prohibited

setDeletionProhibited

void setDeletionProhibited(boolean isDeletionProhibited)

Set the DocumentLibrary deletion prohibited status

Parameters:

isDeletionProhibited - Flag indicating if the library should prohibit deletion

getLocale

java.util.Locale getLocale()

Returns the Locale of this DocumentLibrary object.

Returns:

the Locale of the library