Class Folder
java.lang.Object
com.appiancorp.suiteapi.collaboration.Folder
- All Implemented Interfaces:
LocalId
,Serializable
,Cloneable
Deprecated.
This class represents a folder in the collaboration application.
Copyright: Copyright (c) 2002, 2003
Company: Appian Corporation
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.Access level of administratorstatic final int
Deprecated.Access level of 'no access'static final int
Deprecated.Access level of read-onlystatic final int
Deprecated.Access level of read-writestatic final int
Deprecated.Field signifying that a folder has been approved (or does not require approval)static final int
Deprecated.Field signifying that a folder is pending approval for creationstatic final int
Deprecated.Field signifying that a folder is pending approval for deletionstatic final Integer
Deprecated.Sort by the Admin Permission Only propertystatic final Integer
Deprecated.Sort by the Administrator Groups propertystatic final Integer
Deprecated.Sort by the Administrators propertystatic final Integer
Deprecated.Sort by the Changes Require Approval propertystatic final Integer
Deprecated.Sort by the Creator propertystatic final Integer
Deprecated.Sort by the Date Created propertystatic final Integer
Deprecated.Sort by the Discussion Topic propertystatic final Integer
Deprecated.Sort by the Group Admin Permission Only propertystatic final Integer
Deprecated.Sort by the Group Read Permission Only propertystatic final Integer
Deprecated.Sort by the Group Write Permission Only propertystatic final Integer
Deprecated.Sort by the Id propertystatic final Integer
Deprecated.Sort by the Inherit Security From Parent propertystatic final Integer
Deprecated.Sort by the Knowledge Center Id propertystatic final Integer
Deprecated.Sort by the Knowledge Center Name propertystatic final Integer
Deprecated.Sort by the Knowledge Center Searchable propertystatic final Integer
Deprecated.Sort by the Name propertystatic final Integer
Deprecated.Sort by the Number Of Documents propertystatic final Integer
Deprecated.Sort by the Parent Folder Id propertystatic final Integer
Deprecated.Sort by the Parent Folder Name propertystatic final Integer
Deprecated.Sort by the Pending Approval propertystatic final Integer
Deprecated.Sort by the Read Permission Only propertystatic final Integer
Deprecated.Sort by the Reader Groups propertystatic final Integer
Deprecated.Sort by the Readers propertystatic final Integer
Deprecated.Sort by the Searchable propertystatic final Integer
Deprecated.Sort by the Write Permission Only propertystatic final Integer
Deprecated.Sort by the Writer Groups propertystatic final Integer
Deprecated.Sort by the Writers propertystatic final String
Deprecated.Sort folders by their creatorstatic final String
Deprecated.Sort folders by the last date of modification of any of the subfolders and documents contained in the folders.static final String
Deprecated.Sort folders by namestatic final String
Deprecated.Sort folders by the number of documents they (and their subfolders) containstatic final String
Deprecated.Sort folders by their parent knowledge center name -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.Long[]
Deprecated.Gets the groups which have administrative permissions on this folderString[]
Deprecated.Returns a list of all the administrators for this folder.String[]
Deprecated.Retrieves the list of users who ONLY have administrative permissions on this folderDeprecated.Returns the user who created the folderDeprecated.Gets the date and time that the folder was createdgetForum()
Deprecated.Retrieves the unique ID of the Discussion Topic associated with this foldergetId()
Deprecated.Returns the unique ID of the folderDeprecated.Retrieves the unique ID of the knowledge center which contains the folderDeprecated.Retrieves the name of the knowledge center which contains the foldergetName()
Deprecated.Returns the name of the folderDeprecated.Gets the number of documents in the folderDeprecated.Gets the unique ID of the parent folder which contains this folderDeprecated.Gets the name of the parent folder which contains this folderint
Deprecated.Gets the 'pending approval' status of the folder.Long[]
Deprecated.Gets the groups which have reader permissions on this folderString[]
Deprecated.Retrieves the list of users who have read permissions on this folderString[]
Deprecated.Retrieves the list of users who ONLY have read permissions on this folderstatic Integer
getSortColumn
(String attribute_) Deprecated.getUuid()
Deprecated.String[]
Deprecated.Retrieves the list of users who ONLY have write permissions on this folderLong[]
Deprecated.Gets the groups which have write permissions on this folderString[]
Deprecated.Retrieves the list of users who have write permissions on this folderboolean
Deprecated.Checks whether changes to this folder require approval from an administratorboolean
Deprecated.Checks whether the folder inherits its security settings from its parentboolean
Deprecated.Checks whether the knowledge center that the folder belongs to is searchableboolean
Deprecated.Checks whether this folder is searchablevoid
setAdministratorGroups
(Long[] grids_) Deprecated.Sets the groups which will have administrative permissions on this foldervoid
setAdministrators
(String[] uids_) Deprecated.Retrieves the list of users who have administrative permissions on this foldervoid
setAdminPermissionOnly
(String[] uids_) Deprecated.Sets the list of users who ONLY have administrative permissions on this foldervoid
setChangesRequireApproval
(boolean b_) Deprecated.Checks whether changes to the folder require approval before committingvoid
setCreator
(String uid_) Deprecated.Assigns the user who created the foldervoid
setDateCreated
(Timestamp timestamp_) Deprecated.Sets the date and time that the folder was createdvoid
Deprecated.Associates a Discussion Topic with this foldervoid
Deprecated.Sets the unique ID fo the foldervoid
setInheritSecurityFromParent
(boolean inheritSecurityFromParent_) Deprecated.Sets whether this folder inherits its security settings from its parentvoid
setKnowledgeCenterId
(Long kcid_) Deprecated.Sets the unique ID of the knowledge center which contains this foldervoid
setKnowledgeCenterName
(String kcname_) Deprecated.Sets the name of the knowledge center which contains this foldervoid
setKnowledgeCenterSearchable
(boolean b_) Deprecated.Sets whether the knowledge center that the folder belongs to is searchablevoid
Deprecated.Sets the name of the foldervoid
setNumberOfDocuments
(Long num_) Deprecated.Sets the number of documents in the foldervoid
setParentFolderId
(Long fid_) Deprecated.Sets the unique ID of of the parent folder of this foldervoid
setParentFolderName
(String fname_) Deprecated.Sets the name of the parent folder of this foldervoid
setPendingApproval
(int pendingApproval) Deprecated.Sets the 'pending approval' status of the folder.void
setReaderGroups
(Long[] grids_) Deprecated.Sets the groups that have read permissions on this foldervoid
setReaders
(String[] uids_) Deprecated.Sets the users who have read-only permissions on this foldervoid
setReadPermissionOnly
(String[] uids_) Deprecated.Sets the list of users who ONLY have read permissions on this foldervoid
setSearchable
(boolean b_) Deprecated.Sets whether the folder is searchablevoid
Deprecated.void
setWritePermissionOnly
(String[] uids) Deprecated.Sets the list of users who ONLY have write permissions on this foldervoid
setWriterGroups
(Long[] grids_) Deprecated.Sets the groups that have write permissions on this foldervoid
setWriters
(String[] uids_) Deprecated.Sets the users who have read/write permissions on this folder
-
Field Details
-
SORT_COLUMN_NAME
Deprecated.Sort folders by name- See Also:
-
SORT_COLUMN_LAST_MODIFIED_DATE
Deprecated.Sort folders by the last date of modification of any of the subfolders and documents contained in the folders. The last date of modification of aFolder
is its creation date; the last date of modification of aDocument
is its upload date or the date of its last version.- See Also:
-
SORT_COLUMN_NUMBER_OF_DOCUMENTS
Deprecated.Sort folders by the number of documents they (and their subfolders) contain- See Also:
-
SORT_COLUMN_CREATOR
Deprecated.Sort folders by their creator- See Also:
-
SORT_COLUMN_PARENT_KNOWLEDGE_CENTER_NAME
Deprecated.Sort folders by their parent knowledge center name- See Also:
-
ACCESS_LEVEL_READ_ONLY
public static final int ACCESS_LEVEL_READ_ONLYDeprecated.Access level of read-only- See Also:
-
ACCESS_LEVEL_READ_WRITE
public static final int ACCESS_LEVEL_READ_WRITEDeprecated.Access level of read-write- See Also:
-
ACCESS_LEVEL_ADMINISTRATIVE
public static final int ACCESS_LEVEL_ADMINISTRATIVEDeprecated.Access level of administrator- See Also:
-
ACCESS_LEVEL_NO_ACCESS
public static final int ACCESS_LEVEL_NO_ACCESSDeprecated.Access level of 'no access'- See Also:
-
PENDING_APPROVAL_CREATION
public static final int PENDING_APPROVAL_CREATIONDeprecated.Field signifying that a folder is pending approval for creation- See Also:
-
PENDING_APPROVAL_DELETION
public static final int PENDING_APPROVAL_DELETIONDeprecated.Field signifying that a folder is pending approval for deletion- See Also:
-
APPROVED
public static final int APPROVEDDeprecated.Field signifying that a folder has been approved (or does not require approval)- See Also:
-
SORT_BY_ID
Deprecated.Sort by the Id property -
SORT_BY_NAME
Deprecated.Sort by the Name property -
SORT_BY_PARENT_FOLDER_ID
Deprecated.Sort by the Parent Folder Id property -
SORT_BY_PARENT_FOLDER_NAME
Deprecated.Sort by the Parent Folder Name property -
SORT_BY_KNOWLEDGE_CENTER_ID
Deprecated.Sort by the Knowledge Center Id property -
SORT_BY_KNOWLEDGE_CENTER_NAME
Deprecated.Sort by the Knowledge Center Name property -
SORT_BY_CHANGES_REQUIRE_APPROVAL
Deprecated.Sort by the Changes Require Approval property -
SORT_BY_KNOWLEDGE_CENTER_SEARCHABLE
Deprecated.Sort by the Knowledge Center Searchable property -
SORT_BY_SEARCHABLE
Deprecated.Sort by the Searchable property -
SORT_BY_NUMBER_OF_DOCUMENTS
Deprecated.Sort by the Number Of Documents property -
SORT_BY_INHERIT_SECURITY_FROM_PARENT
Deprecated.Sort by the Inherit Security From Parent property -
SORT_BY_DATE_CREATED
Deprecated.Sort by the Date Created property -
SORT_BY_CREATOR
Deprecated.Sort by the Creator property -
SORT_BY_READERS
Deprecated.Sort by the Readers property -
SORT_BY_WRITERS
Deprecated.Sort by the Writers property -
SORT_BY_ADMINISTRATORS
Deprecated.Sort by the Administrators property -
SORT_BY_READ_PERMISSION_ONLY
Deprecated.Sort by the Read Permission Only property -
SORT_BY_WRITE_PERMISSION_ONLY
Deprecated.Sort by the Write Permission Only property -
SORT_BY_ADMIN_PERMISSION_ONLY
Deprecated.Sort by the Admin Permission Only property -
SORT_BY_READER_GROUPS
Deprecated.Sort by the Reader Groups property -
SORT_BY_WRITER_GROUPS
Deprecated.Sort by the Writer Groups property -
SORT_BY_ADMINISTRATOR_GROUPS
Deprecated.Sort by the Administrator Groups property -
SORT_BY_GROUP_READ_PERMISSION_ONLY
Deprecated.Sort by the Group Read Permission Only property -
SORT_BY_GROUP_WRITE_PERMISSION_ONLY
Deprecated.Sort by the Group Write Permission Only property -
SORT_BY_GROUP_ADMIN_PERMISSION_ONLY
Deprecated.Sort by the Group Admin Permission Only property -
SORT_BY_DISCUSSION_THREAD
Deprecated.Sort by the Discussion Topic property -
SORT_BY_PENDING_APPROVAL
Deprecated.Sort by the Pending Approval property
-
-
Constructor Details
-
Folder
public Folder()Deprecated.
-
-
Method Details
-
getSortColumn
Deprecated. -
getAdministrators
Deprecated.Returns a list of all the administrators for this folder.- Returns:
- a list of the unique IDs of the users who are administrators for this folder.
-
getAdministratorGroups
Deprecated.Gets the groups which have administrative permissions on this folder- Returns:
- a list of unique IDs of groups which have administrative permissions
-
isChangesRequireApproval
public boolean isChangesRequireApproval()Deprecated.Checks whether changes to this folder require approval from an administrator- Returns:
true
if changes to the page require approval;false
if otherwise
-
getCreator
Deprecated.Returns the user who created the folder- Returns:
- the unique ID of the user who create the folder
-
getDateCreated
Deprecated.Gets the date and time that the folder was created- Returns:
- the date and time (combined as a
Timestamp
) that the folder was created
-
getId
Deprecated.Returns the unique ID of the folder -
isKnowledgeCenterSearchable
public boolean isKnowledgeCenterSearchable()Deprecated.Checks whether the knowledge center that the folder belongs to is searchable- Returns:
true
if the knowledge center is searchable;false
if otherwise
-
getKnowledgeCenterId
Deprecated.Retrieves the unique ID of the knowledge center which contains the folder- Returns:
- the unique ID of the knowledge center
-
getKnowledgeCenterName
Deprecated.Retrieves the name of the knowledge center which contains the folder- Returns:
- the name of the knowledge center
-
getName
Deprecated.Returns the name of the folder- Returns:
- the name of the folder
-
getNumberOfDocuments
Deprecated.Gets the number of documents in the folder- Returns:
- the number of documents in the folder
-
getParentFolderId
Deprecated.Gets the unique ID of the parent folder which contains this folder- Returns:
- the unique ID of the parent folder
-
getParentFolderName
Deprecated.Gets the name of the parent folder which contains this folder- Returns:
- the name of the parent folder
-
getReaders
Deprecated.Retrieves the list of users who have read permissions on this folder- Returns:
- an array of unique IDs of the read users
-
getReaderGroups
Deprecated.Gets the groups which have reader permissions on this folder- Returns:
- a list of unique IDs of groups which have reader permissions
-
getWriters
Deprecated.Retrieves the list of users who have write permissions on this folder- Returns:
- an array of unique IDs of the write users
-
getWriterGroups
Deprecated.Gets the groups which have write permissions on this folder- Returns:
- a list of unique IDs of groups which have write permissions
-
setAdministrators
Deprecated.Retrieves the list of users who have administrative permissions on this folder- Parameters:
uids_
- a list of unique IDs of the administrator users
-
setAdministratorGroups
Deprecated.Sets the groups which will have administrative permissions on this folder- Parameters:
grids_
- a list of unique IDs of groups to be given administrative permissions
-
setChangesRequireApproval
public void setChangesRequireApproval(boolean b_) Deprecated.Checks whether changes to the folder require approval before committing- Parameters:
b_
-true
if the changes to the folder require approval;false
if otherwise
-
setCreator
Deprecated.Assigns the user who created the folder- Parameters:
uid_
- the unique ID of the user who created the folder
-
setDateCreated
Deprecated.Sets the date and time that the folder was created- Parameters:
timestamp_
- the date and time (combined as aTimestamp
) when the folder was created
-
setId
Deprecated.Sets the unique ID fo the folder -
setKnowledgeCenterSearchable
public void setKnowledgeCenterSearchable(boolean b_) Deprecated.Sets whether the knowledge center that the folder belongs to is searchable- Parameters:
b_
-true
if the knowledge center is searchable;false
if otherwise
-
setSearchable
public void setSearchable(boolean b_) Deprecated.Sets whether the folder is searchable- Parameters:
b_
-true
if the folder is searchable;false
if otherwise
-
setKnowledgeCenterId
Deprecated.Sets the unique ID of the knowledge center which contains this folder- Parameters:
kcid_
- the unique ID of the knowledge center which contains this folder
-
setKnowledgeCenterName
Deprecated.Sets the name of the knowledge center which contains this folder- Parameters:
kcname_
- the name of the knowledge center which contains this folder
-
setName
Deprecated.Sets the name of the folder- Parameters:
fname_
- the name of the folder
-
setNumberOfDocuments
Deprecated.Sets the number of documents in the folder- Parameters:
num_
- the number of documents in the folder
-
setParentFolderId
Deprecated.Sets the unique ID of of the parent folder of this folder- Parameters:
fid_
- the unique ID of of the parent folder of this folder
-
setParentFolderName
Deprecated.Sets the name of the parent folder of this folder- Parameters:
fname_
- the name of the parent folder of this folder
-
setReaders
Deprecated.Sets the users who have read-only permissions on this folder- Parameters:
uids_
- an array of unique IDs of the users who have read-only permissions on this folder
-
setReaderGroups
Deprecated.Sets the groups that have read permissions on this folder- Parameters:
grids_
- the groups that have read permissions
-
setWriters
Deprecated.Sets the users who have read/write permissions on this folder- Parameters:
uids_
- an array of unique IDs of the users who have read/write permissions on this folder
-
setWriterGroups
Deprecated.Sets the groups that have write permissions on this folder- Parameters:
grids_
- the groups that have write permissions
-
isInheritSecurityFromParent
public boolean isInheritSecurityFromParent()Deprecated.Checks whether the folder inherits its security settings from its parent- Returns:
- true if the folder inherits its security settings from its parent; false otherwise
-
isSearchable
public boolean isSearchable()Deprecated.Checks whether this folder is searchable- Returns:
true
if the folder is searchable;false
if otherwise
-
setInheritSecurityFromParent
public void setInheritSecurityFromParent(boolean inheritSecurityFromParent_) Deprecated.Sets whether this folder inherits its security settings from its parent- Parameters:
inheritSecurityFromParent_
- true if this folder inherits its security settings from its parent; false otherwise
-
getAdminPermissionOnly
Deprecated.Retrieves the list of users who ONLY have administrative permissions on this folder- Returns:
- a list of unique IDs of users
-
getForum
Deprecated.Retrieves the unique ID of the Discussion Topic associated with this folder- Returns:
- the unique ID of the Discussion Topic associated with this folder
-
getReadPermissionOnly
Deprecated.Retrieves the list of users who ONLY have read permissions on this folder- Returns:
- a list of unique IDs of users
-
getWritePermissionOnly
Deprecated.Retrieves the list of users who ONLY have write permissions on this folder- Returns:
- a list of unique IDs of users
-
setAdminPermissionOnly
Deprecated.Sets the list of users who ONLY have administrative permissions on this folder- Parameters:
uids_
- an array of unique IDs of users
-
setForum
Deprecated.Associates a Discussion Topic with this folder- Parameters:
forumId_
- the unique ID of the Discussion Topic
-
setReadPermissionOnly
Deprecated.Sets the list of users who ONLY have read permissions on this folder- Parameters:
uids_
- an array of unique IDs of users
-
setWritePermissionOnly
Deprecated.Sets the list of users who ONLY have write permissions on this folder- Parameters:
uids
- an array of unique IDs of users
-
getPendingApproval
public int getPendingApproval()Deprecated.Gets the 'pending approval' status of the folder.- Returns:
- Returns the 'pending approval': PENDING_APPROVAL_CREATION, PENDING_APPROVAL_DELETION or APPROVED
-
setPendingApproval
public void setPendingApproval(int pendingApproval) Deprecated.Sets the 'pending approval' status of the folder.- Parameters:
pendingApproval
- The 'pending approval' status to set. Can be one of: PENDING_APPROVAL_CREATION, PENDING_APPROVAL_DELETION or APPROVED
-
clone
Deprecated.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Deprecated. -
setUuid
Deprecated.
-
KnowledgeFolder
instead.