KnowledgeFolder
instead.@Deprecated public class Folder extends java.lang.Object implements LocalId, java.lang.Cloneable
This class represents a folder in the collaboration application.
Copyright: Copyright (c) 2002, 2003
Company: Appian Corporation
Modifier and Type | Field and Description |
---|---|
static int |
ACCESS_LEVEL_ADMINISTRATIVE
Deprecated.
Access level of administrator
|
static int |
ACCESS_LEVEL_NO_ACCESS
Deprecated.
Access level of 'no access'
|
static int |
ACCESS_LEVEL_READ_ONLY
Deprecated.
Access level of read-only
|
static int |
ACCESS_LEVEL_READ_WRITE
Deprecated.
Access level of read-write
|
static int |
APPROVED
Deprecated.
Field signifying that a folder has been approved (or does not require
approval)
|
static int |
PENDING_APPROVAL_CREATION
Deprecated.
Field signifying that a folder is pending approval for creation
|
static int |
PENDING_APPROVAL_DELETION
Deprecated.
Field signifying that a folder is pending approval for deletion
|
static java.lang.Integer |
SORT_BY_ADMIN_PERMISSION_ONLY
Deprecated.
Sort by the Admin Permission Only property
|
static java.lang.Integer |
SORT_BY_ADMINISTRATOR_GROUPS
Deprecated.
Sort by the Administrator Groups property
|
static java.lang.Integer |
SORT_BY_ADMINISTRATORS
Deprecated.
Sort by the Administrators property
|
static java.lang.Integer |
SORT_BY_CHANGES_REQUIRE_APPROVAL
Deprecated.
Sort by the Changes Require Approval property
|
static java.lang.Integer |
SORT_BY_CREATOR
Deprecated.
Sort by the Creator property
|
static java.lang.Integer |
SORT_BY_DATE_CREATED
Deprecated.
Sort by the Date Created property
|
static java.lang.Integer |
SORT_BY_DISCUSSION_THREAD
Deprecated.
Sort by the Discussion Topic property
|
static java.lang.Integer |
SORT_BY_GROUP_ADMIN_PERMISSION_ONLY
Deprecated.
Sort by the Group Admin Permission Only property
|
static java.lang.Integer |
SORT_BY_GROUP_READ_PERMISSION_ONLY
Deprecated.
Sort by the Group Read Permission Only property
|
static java.lang.Integer |
SORT_BY_GROUP_WRITE_PERMISSION_ONLY
Deprecated.
Sort by the Group Write Permission Only property
|
static java.lang.Integer |
SORT_BY_ID
Deprecated.
Sort by the Id property
|
static java.lang.Integer |
SORT_BY_INHERIT_SECURITY_FROM_PARENT
Deprecated.
Sort by the Inherit Security From Parent property
|
static java.lang.Integer |
SORT_BY_KNOWLEDGE_CENTER_ID
Deprecated.
Sort by the Knowledge Center Id property
|
static java.lang.Integer |
SORT_BY_KNOWLEDGE_CENTER_NAME
Deprecated.
Sort by the Knowledge Center Name property
|
static java.lang.Integer |
SORT_BY_KNOWLEDGE_CENTER_SEARCHABLE
Deprecated.
Sort by the Knowledge Center Searchable property
|
static java.lang.Integer |
SORT_BY_NAME
Deprecated.
Sort by the Name property
|
static java.lang.Integer |
SORT_BY_NUMBER_OF_DOCUMENTS
Deprecated.
Sort by the Number Of Documents property
|
static java.lang.Integer |
SORT_BY_PARENT_FOLDER_ID
Deprecated.
Sort by the Parent Folder Id property
|
static java.lang.Integer |
SORT_BY_PARENT_FOLDER_NAME
Deprecated.
Sort by the Parent Folder Name property
|
static java.lang.Integer |
SORT_BY_PENDING_APPROVAL
Deprecated.
Sort by the Pending Approval property
|
static java.lang.Integer |
SORT_BY_READ_PERMISSION_ONLY
Deprecated.
Sort by the Read Permission Only property
|
static java.lang.Integer |
SORT_BY_READER_GROUPS
Deprecated.
Sort by the Reader Groups property
|
static java.lang.Integer |
SORT_BY_READERS
Deprecated.
Sort by the Readers property
|
static java.lang.Integer |
SORT_BY_SEARCHABLE
Deprecated.
Sort by the Searchable property
|
static java.lang.Integer |
SORT_BY_WRITE_PERMISSION_ONLY
Deprecated.
Sort by the Write Permission Only property
|
static java.lang.Integer |
SORT_BY_WRITER_GROUPS
Deprecated.
Sort by the Writer Groups property
|
static java.lang.Integer |
SORT_BY_WRITERS
Deprecated.
Sort by the Writers property
|
static java.lang.String |
SORT_COLUMN_CREATOR
Deprecated.
Sort folders by their creator
|
static java.lang.String |
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.
|
static java.lang.String |
SORT_COLUMN_NAME
Deprecated.
Sort folders by name
|
static java.lang.String |
SORT_COLUMN_NUMBER_OF_DOCUMENTS
Deprecated.
Sort folders by the number of documents they (and their subfolders)
contain
|
static java.lang.String |
SORT_COLUMN_PARENT_KNOWLEDGE_CENTER_NAME
Deprecated.
Sort folders by their parent knowledge center name
|
Constructor and Description |
---|
Folder()
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Deprecated.
|
java.lang.Long[] |
getAdministratorGroups()
Deprecated.
Gets the groups which have administrative permissions on this folder
|
java.lang.String[] |
getAdministrators()
Deprecated.
Returns a list of all the administrators for this folder.
|
java.lang.String[] |
getAdminPermissionOnly()
Deprecated.
Retrieves the list of users who ONLY have administrative permissions on
this folder
|
java.lang.String |
getCreator()
Deprecated.
Returns the user who created the folder
|
java.sql.Timestamp |
getDateCreated()
Deprecated.
Gets the date and time that the folder was created
|
java.lang.Long |
getForum()
Deprecated.
Retrieves the unique ID of the Discussion Topic associated with this
folder
|
java.lang.Long |
getId()
Deprecated.
Returns the unique ID of the folder
|
java.lang.Long |
getKnowledgeCenterId()
Deprecated.
Retrieves the unique ID of the knowledge center which contains the folder
|
java.lang.String |
getKnowledgeCenterName()
Deprecated.
Retrieves the name of the knowledge center which contains the folder
|
java.lang.String |
getName()
Deprecated.
Returns the name of the folder
|
java.lang.Long |
getNumberOfDocuments()
Deprecated.
Gets the number of documents in the folder
|
java.lang.Long |
getParentFolderId()
Deprecated.
Gets the unique ID of the parent folder which contains this folder
|
java.lang.String |
getParentFolderName()
Deprecated.
Gets the name of the parent folder which contains this folder
|
int |
getPendingApproval()
Deprecated.
Gets the 'pending approval' status of the folder.
|
java.lang.Long[] |
getReaderGroups()
Deprecated.
Gets the groups which have reader permissions on this folder
|
java.lang.String[] |
getReaders()
Deprecated.
Retrieves the list of users who have read permissions on this folder
|
java.lang.String[] |
getReadPermissionOnly()
Deprecated.
Retrieves the list of users who ONLY have read permissions on this folder
|
static java.lang.Integer |
getSortColumn(java.lang.String attribute_)
Deprecated.
|
java.lang.String |
getUuid()
Deprecated.
|
java.lang.String[] |
getWritePermissionOnly()
Deprecated.
Retrieves the list of users who ONLY have write permissions on this folder
|
java.lang.Long[] |
getWriterGroups()
Deprecated.
Gets the groups which have write permissions on this folder
|
java.lang.String[] |
getWriters()
Deprecated.
Retrieves the list of users who have write permissions on this folder
|
boolean |
isChangesRequireApproval()
Deprecated.
Checks whether changes to this folder require approval from an
administrator
|
boolean |
isInheritSecurityFromParent()
Deprecated.
Checks whether the folder inherits its security settings from its parent
|
boolean |
isKnowledgeCenterSearchable()
Deprecated.
Checks whether the knowledge center that the folder belongs to is
searchable
|
boolean |
isSearchable()
Deprecated.
Checks whether this folder is searchable
|
void |
setAdministratorGroups(java.lang.Long[] grids_)
Deprecated.
Sets the groups which will have administrative permissions on this folder
|
void |
setAdministrators(java.lang.String[] uids_)
Deprecated.
Retrieves the list of users who have administrative permissions on this
folder
|
void |
setAdminPermissionOnly(java.lang.String[] uids_)
Deprecated.
Sets the list of users who ONLY have administrative permissions on this
folder
|
void |
setChangesRequireApproval(boolean b_)
Deprecated.
Checks whether changes to the folder require approval before committing
|
void |
setCreator(java.lang.String uid_)
Deprecated.
Assigns the user who created the folder
|
void |
setDateCreated(java.sql.Timestamp timestamp_)
Deprecated.
Sets the date and time that the folder was created
|
void |
setForum(java.lang.Long forumId_)
Deprecated.
Associates a Discussion Topic with this folder
|
void |
setId(java.lang.Long fid_)
Deprecated.
Sets the unique ID fo the folder
|
void |
setInheritSecurityFromParent(boolean inheritSecurityFromParent_)
Deprecated.
Sets whether this folder inherits its security settings from its parent
|
void |
setKnowledgeCenterId(java.lang.Long kcid_)
Deprecated.
Sets the unique ID of the knowledge center which contains this folder
|
void |
setKnowledgeCenterName(java.lang.String kcname_)
Deprecated.
Sets the name of the knowledge center which contains this folder
|
void |
setKnowledgeCenterSearchable(boolean b_)
Deprecated.
Sets whether the knowledge center that the folder belongs to is searchable
|
void |
setName(java.lang.String fname_)
Deprecated.
Sets the name of the folder
|
void |
setNumberOfDocuments(java.lang.Long num_)
Deprecated.
Sets the number of documents in the folder
|
void |
setParentFolderId(java.lang.Long fid_)
Deprecated.
Sets the unique ID of of the parent folder of this folder
|
void |
setParentFolderName(java.lang.String fname_)
Deprecated.
Sets the name of the parent folder of this folder
|
void |
setPendingApproval(int pendingApproval)
Deprecated.
Sets the 'pending approval' status of the folder.
|
void |
setReaderGroups(java.lang.Long[] grids_)
Deprecated.
Sets the groups that have read permissions on this folder
|
void |
setReaders(java.lang.String[] uids_)
Deprecated.
Sets the users who have read-only permissions on this folder
|
void |
setReadPermissionOnly(java.lang.String[] uids_)
Deprecated.
Sets the list of users who ONLY have read permissions on this folder
|
void |
setSearchable(boolean b_)
Deprecated.
Sets whether the folder is searchable
|
void |
setUuid(java.lang.String uuid)
Deprecated.
|
void |
setWritePermissionOnly(java.lang.String[] uids)
Deprecated.
Sets the list of users who ONLY have write permissions on this folder
|
void |
setWriterGroups(java.lang.Long[] grids_)
Deprecated.
Sets the groups that have write permissions on this folder
|
void |
setWriters(java.lang.String[] uids_)
Deprecated.
Sets the users who have read/write permissions on this folder
|
public static final java.lang.String SORT_COLUMN_NAME
public static final java.lang.String SORT_COLUMN_LAST_MODIFIED_DATE
Folder
is its creation date; the last date of modification
of a Document
is its upload date or the date of its last
version.public static final java.lang.String SORT_COLUMN_NUMBER_OF_DOCUMENTS
public static final java.lang.String SORT_COLUMN_CREATOR
public static final java.lang.String SORT_COLUMN_PARENT_KNOWLEDGE_CENTER_NAME
public static final int ACCESS_LEVEL_READ_ONLY
public static final int ACCESS_LEVEL_READ_WRITE
public static final int ACCESS_LEVEL_ADMINISTRATIVE
public static final int ACCESS_LEVEL_NO_ACCESS
public static final int PENDING_APPROVAL_CREATION
public static final int PENDING_APPROVAL_DELETION
public static final int APPROVED
public static final java.lang.Integer SORT_BY_ID
public static final java.lang.Integer SORT_BY_NAME
public static final java.lang.Integer SORT_BY_PARENT_FOLDER_ID
public static final java.lang.Integer SORT_BY_PARENT_FOLDER_NAME
public static final java.lang.Integer SORT_BY_KNOWLEDGE_CENTER_ID
public static final java.lang.Integer SORT_BY_KNOWLEDGE_CENTER_NAME
public static final java.lang.Integer SORT_BY_CHANGES_REQUIRE_APPROVAL
public static final java.lang.Integer SORT_BY_KNOWLEDGE_CENTER_SEARCHABLE
public static final java.lang.Integer SORT_BY_SEARCHABLE
public static final java.lang.Integer SORT_BY_NUMBER_OF_DOCUMENTS
public static final java.lang.Integer SORT_BY_INHERIT_SECURITY_FROM_PARENT
public static final java.lang.Integer SORT_BY_DATE_CREATED
public static final java.lang.Integer SORT_BY_CREATOR
public static final java.lang.Integer SORT_BY_READERS
public static final java.lang.Integer SORT_BY_WRITERS
public static final java.lang.Integer SORT_BY_ADMINISTRATORS
public static final java.lang.Integer SORT_BY_READ_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_WRITE_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_ADMIN_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_READER_GROUPS
public static final java.lang.Integer SORT_BY_WRITER_GROUPS
public static final java.lang.Integer SORT_BY_ADMINISTRATOR_GROUPS
public static final java.lang.Integer SORT_BY_GROUP_READ_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_GROUP_WRITE_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_GROUP_ADMIN_PERMISSION_ONLY
public static final java.lang.Integer SORT_BY_DISCUSSION_THREAD
public static final java.lang.Integer SORT_BY_PENDING_APPROVAL
public static java.lang.Integer getSortColumn(java.lang.String attribute_)
public java.lang.String[] getAdministrators()
public java.lang.Long[] getAdministratorGroups()
public boolean isChangesRequireApproval()
true
if changes to the page require approval;
false
if otherwisepublic java.lang.String getCreator()
public java.sql.Timestamp getDateCreated()
Timestamp
) that
the folder was createdpublic java.lang.Long getId()
getId
in interface LocalId
LocalId.setId(Long)
public boolean isKnowledgeCenterSearchable()
true
if the knowledge center is searchable; false
if otherwisepublic java.lang.Long getKnowledgeCenterId()
public java.lang.String getKnowledgeCenterName()
public java.lang.String getName()
public java.lang.Long getNumberOfDocuments()
public java.lang.Long getParentFolderId()
public java.lang.String getParentFolderName()
public java.lang.String[] getReaders()
public java.lang.Long[] getReaderGroups()
public java.lang.String[] getWriters()
public java.lang.Long[] getWriterGroups()
public void setAdministrators(java.lang.String[] uids_)
uids_
- a list of unique IDs of the administrator userspublic void setAdministratorGroups(java.lang.Long[] grids_)
grids_
- a list of unique IDs of groups to be given administrative
permissionspublic void setChangesRequireApproval(boolean b_)
b_
- true
if the changes to the folder require
approval; false
if otherwisepublic void setCreator(java.lang.String uid_)
uid_
- the unique ID of the user who created the folderpublic void setDateCreated(java.sql.Timestamp timestamp_)
timestamp_
- the date and time (combined as a Timestamp
) when
the folder was createdpublic void setId(java.lang.Long fid_)
setId
in interface LocalId
fid_
- the unique ID of the folderLocalId.getId()
public void setKnowledgeCenterSearchable(boolean b_)
b_
- true
if the knowledge center is searchable; false
if otherwisepublic void setSearchable(boolean b_)
b_
- true
if the folder is searchable; false
if otherwisepublic void setKnowledgeCenterId(java.lang.Long kcid_)
kcid_
- the unique ID of the knowledge center which contains this folderpublic void setKnowledgeCenterName(java.lang.String kcname_)
kcname_
- the name of the knowledge center which contains this folderpublic void setName(java.lang.String fname_)
fname_
- the name of the folderpublic void setNumberOfDocuments(java.lang.Long num_)
num_
- the number of documents in the folderpublic void setParentFolderId(java.lang.Long fid_)
fid_
- the unique ID of of the parent folder of this folderpublic void setParentFolderName(java.lang.String fname_)
fname_
- the name of the parent folder of this folderpublic void setReaders(java.lang.String[] uids_)
uids_
- an array of unique IDs of the users who have read-only
permissions on this folderpublic void setReaderGroups(java.lang.Long[] grids_)
grids_
- the groups that have read permissionspublic void setWriters(java.lang.String[] uids_)
uids_
- an array of unique IDs of the users who have read/write
permissions on this folderpublic void setWriterGroups(java.lang.Long[] grids_)
grids_
- the groups that have write permissionspublic boolean isInheritSecurityFromParent()
public boolean isSearchable()
true
if the folder is searchable; false
if otherwisepublic void setInheritSecurityFromParent(boolean inheritSecurityFromParent_)
inheritSecurityFromParent_
- true if this folder inherits its security settings from its
parent; false otherwisepublic java.lang.String[] getAdminPermissionOnly()
public java.lang.Long getForum()
public java.lang.String[] getReadPermissionOnly()
public java.lang.String[] getWritePermissionOnly()
public void setAdminPermissionOnly(java.lang.String[] uids_)
uids_
- an array of unique IDs of userspublic void setForum(java.lang.Long forumId_)
forumId_
- the unique ID of the Discussion Topicpublic void setReadPermissionOnly(java.lang.String[] uids_)
uids_
- an array of unique IDs of userspublic void setWritePermissionOnly(java.lang.String[] uids)
uids
- an array of unique IDs of userspublic int getPendingApproval()
public void setPendingApproval(int pendingApproval)
pendingApproval
- The 'pending approval' status to set. Can be one of:
PENDING_APPROVAL_CREATION, PENDING_APPROVAL_DELETION or APPROVEDpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in class java.lang.Object
java.lang.CloneNotSupportedException
@ConvertWith(value=com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public java.lang.String getUuid()
public void setUuid(java.lang.String uuid)
Copyright © 2003-2024 Appian Corporation. All Rights Reserved.