|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Interface that represents a document folder or a collection of metadata about a document folder. To retrieve an
existing folder use IDocumentManager.getFolder
. To insert a
newly created folder, first obtain a new empty folder using
IDocumentManager.createNewFolder
, set some of the
metadata, then store the document folder by calling
IDocumentManager.insertNewFolder
.
Any modifications made to the metadata of a document folder will not be stored permanently until
store
is called.
Method Summary | |
AccessLevel |
getAccessLevel(RoleType roleType)
Returns document folder access level for a given role type. |
IProject |
getContainingProject()
Returns an IProject instance representing the project that this document folder belongs to. |
java.util.Date |
getCreatedDate()
Returns the date on which the document was created. |
java.lang.String |
getDescription()
Returns the document folder description. |
java.lang.String |
getDetailsURL()
Returns the URL that can be used to view the document folder details. |
java.lang.String |
getEmailAddress()
Returns the folder email address. |
int |
getID()
Returns the document folder ID. |
java.util.Date |
getLastModifiedDate()
Returns the last modified date. |
java.lang.String |
getName()
Returns the document folder name. |
int |
getOwnerUserID()
Returns the user ID of the owner of this document folder. |
IDocumentFolder |
getParentFolder()
Returns the parent folder, or null if this is the top-level folder for a project. |
java.lang.String |
getPath(java.lang.String pathSeparationString)
Returns a string representation of the path of a document folder. |
boolean |
hasCreatedDate()
Returns true if the created date is available, else false . |
boolean |
hasLastModifiedDate()
Returns true if last modified date is available, else false . |
boolean |
isActionAllowed(DocumentFolderPermission permission)
Returns whether a given DocumentFolderPermission is allowed for this document folder. |
boolean |
isDefaultSecurity()
Indicates whether this document folder uses project-default security. |
void |
setAccessLevel(RoleType roleType,
AccessLevel accessLevel)
Sets document folder access level for a given role type. |
void |
setDefaultSecurity(boolean isDefaultSecurity)
Enables or disables this document folder's use of project default security. |
void |
setDescription(java.lang.String description)
Sets the document folder description. |
void |
setName(java.lang.String name)
Sets the document folder name. |
void |
store()
Stores a document folder. |
Method Detail |
public AccessLevel getAccessLevel(RoleType roleType)
roleType
- the role type for which to get the access level ; cannot be null
.
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic IProject getContainingProject() throws CollaborationException, java.rmi.RemoteException
IProject
instance representing the project that this document folder belongs to.
CollaborationException
- if the method call resulted in an error
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removed
java.rmi.RemoteException
- if there was a communication problem during the execution of the remote method callpublic java.util.Date getCreatedDate()
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic java.lang.String getDescription()
java.lang.IllegalStateException
- if the document folder has already been removedpublic java.lang.String getDetailsURL()
public java.lang.String getEmailAddress()
null
if email support has not been enabled for Collaboration
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic int getID()
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic java.util.Date getLastModifiedDate()
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic java.lang.String getName()
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic int getOwnerUserID()
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic IDocumentFolder getParentFolder() throws CollaborationException, java.rmi.RemoteException
null
if this is the top-level folder for a project.
null
if this is the top-level folder for a project
CollaborationException
java.rmi.RemoteException
public java.lang.String getPath(java.lang.String pathSeparationString)
pathSeparationString
- the string to insert between path components; cannot be null
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removedpublic boolean hasCreatedDate()
true
if the created date is available, else false
.
true
if the created date is available, else false
java.lang.IllegalStateException
- if the document folder has already been removed.public boolean hasLastModifiedDate()
true
if last modified date is available, else false
.
true
if last modified date is available, else false
java.lang.IllegalStateException
- if the document folder has already been removedpublic boolean isActionAllowed(DocumentFolderPermission permission) throws CollaborationException, java.rmi.RemoteException
DocumentFolderPermission
is allowed for this document folder.
This method can be used to determine if a user can perform a given action within the context of a document folder such as
editing a document folder, copying a document folder, editing document folder security, etc. See the enumeration type
DocumentFolderPermission
for details about specific document folder permissions.
permission
- document folder permission ; cannot be null
true
if the user can perform the given action, else false
java.rmi.RemoteException
- if there was a communication problem during the execution of the remote method call
java.lang.IllegalStateException
- if the document folder has not yet been inserted or has already been removed
CollaborationException
- if the call resulted in an errorpublic boolean isDefaultSecurity()
true
, modifying security on the current document folder will not be possible.
setDefaultSecurity
must be set to false
in order to modify individual document folders'
security. The default value for isDefaultSecurity
is true
.
true
if the document folder uses project-default security, false
if the document folder is
enabled to use its own security
java.lang.IllegalStateException
- if the document folder has already been removedpublic void setAccessLevel(RoleType roleType, AccessLevel accessLevel)
false
by calling
setDefaultSecurity(false)
.
roleType
- the role type for which access level will be set ; cannot be null
accessLevel
- the access level
java.lang.IllegalStateException
- if the document folder has not yet been inserted, has already been removed, or is set to
use default securitypublic void setDefaultSecurity(boolean isDefaultSecurity)
true
will enable defaultSecurity
, calling it with
false
will disable defaultSecurity
. defaultSecurity
set to true
. To modify security on an individual document folder, the document folder
must have defaultSecurity
disabled before modification. After this method is called, any
project-level security modification will not be applied to the document folder, and only the individual document folder's security
will be used.isDefaultSecurity
, which would
indicate if the current document folder has defaultSecurity
enabled.
Note: Adjusting the security on a folder makes no changes to the security on any of its contained
documents or folders.
isDefaultSecurity
- true
if it uses default security, otherwise false
java.lang.IllegalStateException
- if the document folder has already been removedpublic void setDescription(java.lang.String description)
description
- the document folder description; cannot be null
java.lang.IllegalStateException
- if the document folder has already been removedpublic void setName(java.lang.String name)
name
- the document folder name; cannot be null
.
java.lang.IllegalStateException
- if the document folder has already been removedpublic void store() throws PermissionDeniedException, CollaborationException, java.rmi.RemoteException
PermissionDeniedException
- if the user does not have the permission to edit the folder
CollaborationException
- if the method call resulted in an error
java.rmi.RemoteException
- if there was a communication problem during the execution of the remote method call
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.