Package com.appiancorp.suiteapi.collaboration

Class Folder

java.lang.Object
com.appiancorp.suiteapi.collaboration.Folder
All Implemented Interfaces:
LocalId, Serializable, Cloneable
@Deprecated public class Folder extends Object implements LocalId, Cloneable
Deprecated.
Use the class KnowledgeFolder instead.

This class represents a folder in the collaboration application.

Copyright: Copyright (c) 2002, 2003

Company: Appian Corporation

See Also:

  • Field Details

    • SORT_COLUMN_NAME

      public static final String SORT_COLUMN_NAME
      Deprecated.
      Sort folders by name
      See Also:

    • SORT_COLUMN_LAST_MODIFIED_DATE

      public static final 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. The last date of modification of a Folder is its creation date; the last date of modification of a Document is its upload date or the date of its last version.
      See Also:

    • SORT_COLUMN_NUMBER_OF_DOCUMENTS

      public static final String SORT_COLUMN_NUMBER_OF_DOCUMENTS
      Deprecated.
      Sort folders by the number of documents they (and their subfolders) contain
      See Also:

    • SORT_COLUMN_CREATOR

      public static final String SORT_COLUMN_CREATOR
      Deprecated.
      Sort folders by their creator
      See Also:

    • SORT_COLUMN_PARENT_KNOWLEDGE_CENTER_NAME

      public static final String 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_ONLY
      Deprecated.
      Access level of read-only
      See Also:

    • ACCESS_LEVEL_READ_WRITE

      public static final int ACCESS_LEVEL_READ_WRITE
      Deprecated.
      Access level of read-write
      See Also:

    • ACCESS_LEVEL_ADMINISTRATIVE

      public static final int ACCESS_LEVEL_ADMINISTRATIVE
      Deprecated.
      Access level of administrator
      See Also:

    • ACCESS_LEVEL_NO_ACCESS

      public static final int ACCESS_LEVEL_NO_ACCESS
      Deprecated.
      Access level of 'no access'
      See Also:

    • PENDING_APPROVAL_CREATION

      public static final int PENDING_APPROVAL_CREATION
      Deprecated.
      Field signifying that a folder is pending approval for creation
      See Also:

    • PENDING_APPROVAL_DELETION

      public static final int PENDING_APPROVAL_DELETION
      Deprecated.
      Field signifying that a folder is pending approval for deletion
      See Also:

    • APPROVED

      public static final int APPROVED
      Deprecated.
      Field signifying that a folder has been approved (or does not require approval)
      See Also:

    • SORT_BY_ID

      public static final Integer SORT_BY_ID
      Deprecated.
      Sort by the Id property

    • SORT_BY_NAME

      public static final Integer SORT_BY_NAME
      Deprecated.
      Sort by the Name property

    • SORT_BY_PARENT_FOLDER_ID

      public static final Integer SORT_BY_PARENT_FOLDER_ID
      Deprecated.
      Sort by the Parent Folder Id property

    • SORT_BY_PARENT_FOLDER_NAME

      public static final Integer SORT_BY_PARENT_FOLDER_NAME
      Deprecated.
      Sort by the Parent Folder Name property

    • SORT_BY_KNOWLEDGE_CENTER_ID

      public static final Integer SORT_BY_KNOWLEDGE_CENTER_ID
      Deprecated.
      Sort by the Knowledge Center Id property

    • SORT_BY_KNOWLEDGE_CENTER_NAME

      public static final Integer SORT_BY_KNOWLEDGE_CENTER_NAME
      Deprecated.
      Sort by the Knowledge Center Name property

    • SORT_BY_CHANGES_REQUIRE_APPROVAL

      public static final Integer SORT_BY_CHANGES_REQUIRE_APPROVAL
      Deprecated.
      Sort by the Changes Require Approval property

    • SORT_BY_KNOWLEDGE_CENTER_SEARCHABLE

      public static final Integer SORT_BY_KNOWLEDGE_CENTER_SEARCHABLE
      Deprecated.
      Sort by the Knowledge Center Searchable property

    • SORT_BY_SEARCHABLE

      public static final Integer SORT_BY_SEARCHABLE
      Deprecated.
      Sort by the Searchable property

    • SORT_BY_NUMBER_OF_DOCUMENTS

      public static final Integer SORT_BY_NUMBER_OF_DOCUMENTS
      Deprecated.
      Sort by the Number Of Documents property

    • SORT_BY_INHERIT_SECURITY_FROM_PARENT

      public static final Integer SORT_BY_INHERIT_SECURITY_FROM_PARENT
      Deprecated.
      Sort by the Inherit Security From Parent property

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Deprecated.
      Sort by the Date Created property

    • SORT_BY_CREATOR

      public static final Integer SORT_BY_CREATOR
      Deprecated.
      Sort by the Creator property

    • SORT_BY_READERS

      public static final Integer SORT_BY_READERS
      Deprecated.
      Sort by the Readers property

    • SORT_BY_WRITERS

      public static final Integer SORT_BY_WRITERS
      Deprecated.
      Sort by the Writers property

    • SORT_BY_ADMINISTRATORS

      public static final Integer SORT_BY_ADMINISTRATORS
      Deprecated.
      Sort by the Administrators property

    • SORT_BY_READ_PERMISSION_ONLY

      public static final Integer SORT_BY_READ_PERMISSION_ONLY
      Deprecated.
      Sort by the Read Permission Only property

    • SORT_BY_WRITE_PERMISSION_ONLY

      public static final Integer SORT_BY_WRITE_PERMISSION_ONLY
      Deprecated.
      Sort by the Write Permission Only property

    • SORT_BY_ADMIN_PERMISSION_ONLY

      public static final Integer SORT_BY_ADMIN_PERMISSION_ONLY
      Deprecated.
      Sort by the Admin Permission Only property

    • SORT_BY_READER_GROUPS

      public static final Integer SORT_BY_READER_GROUPS
      Deprecated.
      Sort by the Reader Groups property

    • SORT_BY_WRITER_GROUPS

      public static final Integer SORT_BY_WRITER_GROUPS
      Deprecated.
      Sort by the Writer Groups property

    • SORT_BY_ADMINISTRATOR_GROUPS

      public static final Integer SORT_BY_ADMINISTRATOR_GROUPS
      Deprecated.
      Sort by the Administrator Groups property

    • SORT_BY_GROUP_READ_PERMISSION_ONLY

      public static final Integer SORT_BY_GROUP_READ_PERMISSION_ONLY
      Deprecated.
      Sort by the Group Read Permission Only property

    • SORT_BY_GROUP_WRITE_PERMISSION_ONLY

      public static final Integer SORT_BY_GROUP_WRITE_PERMISSION_ONLY
      Deprecated.
      Sort by the Group Write Permission Only property

    • SORT_BY_GROUP_ADMIN_PERMISSION_ONLY

      public static final Integer SORT_BY_GROUP_ADMIN_PERMISSION_ONLY
      Deprecated.
      Sort by the Group Admin Permission Only property

    • SORT_BY_DISCUSSION_THREAD

      public static final Integer SORT_BY_DISCUSSION_THREAD
      Deprecated.
      Sort by the Discussion Topic property

    • SORT_BY_PENDING_APPROVAL

      public static final Integer SORT_BY_PENDING_APPROVAL
      Deprecated.
      Sort by the Pending Approval property

  • Constructor Details

    • Folder

      public Folder()
      Deprecated.

  • Method Details

    • getSortColumn

      public static Integer getSortColumn(String attribute_)
      Deprecated.

    • getAdministrators

      public String[] 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

      public Long[] 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

      public String getCreator()
      Deprecated.
      Returns the user who created the folder
      Returns:
      the unique ID of the user who create the folder

    • getDateCreated

      public Timestamp 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

      public Long getId()
      Deprecated.
      Returns the unique ID of the folder
      Specified by:
      getId in interface LocalId
      Returns:
      the unique ID of the folder
      See Also:

    • 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

      public Long getKnowledgeCenterId()
      Deprecated.
      Retrieves the unique ID of the knowledge center which contains the folder
      Returns:
      the unique ID of the knowledge center

    • getKnowledgeCenterName

      public String getKnowledgeCenterName()
      Deprecated.
      Retrieves the name of the knowledge center which contains the folder
      Returns:
      the name of the knowledge center

    • getName

      public String getName()
      Deprecated.
      Returns the name of the folder
      Returns:
      the name of the folder

    • getNumberOfDocuments

      public Long getNumberOfDocuments()
      Deprecated.
      Gets the number of documents in the folder
      Returns:
      the number of documents in the folder

    • getParentFolderId

      public Long getParentFolderId()
      Deprecated.
      Gets the unique ID of the parent folder which contains this folder
      Returns:
      the unique ID of the parent folder

    • getParentFolderName

      public String getParentFolderName()
      Deprecated.
      Gets the name of the parent folder which contains this folder
      Returns:
      the name of the parent folder

    • getReaders

      public String[] 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

      public Long[] 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

      public String[] 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

      public Long[] 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

      public void setAdministrators(String[] uids_)
      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

      public void setAdministratorGroups(Long[] grids_)
      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

      public void setCreator(String uid_)
      Deprecated.
      Assigns the user who created the folder
      Parameters:
      uid_ - the unique ID of the user who created the folder

    • setDateCreated

      public void setDateCreated(Timestamp timestamp_)
      Deprecated.
      Sets the date and time that the folder was created
      Parameters:
      timestamp_ - the date and time (combined as a Timestamp) when the folder was created

    • setId

      public void setId(Long fid_)
      Deprecated.
      Sets the unique ID fo the folder
      Specified by:
      setId in interface LocalId
      Parameters:
      fid_ - the unique ID of the folder
      See Also:

    • 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

      public void setKnowledgeCenterId(Long kcid_)
      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

      public void setKnowledgeCenterName(String kcname_)
      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

      public void setName(String fname_)
      Deprecated.
      Sets the name of the folder
      Parameters:
      fname_ - the name of the folder

    • setNumberOfDocuments

      public void setNumberOfDocuments(Long num_)
      Deprecated.
      Sets the number of documents in the folder
      Parameters:
      num_ - the number of documents in the folder

    • setParentFolderId

      public void setParentFolderId(Long fid_)
      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

      public void setParentFolderName(String fname_)
      Deprecated.
      Sets the name of the parent folder of this folder
      Parameters:
      fname_ - the name of the parent folder of this folder

    • setReaders

      public void setReaders(String[] uids_)
      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

      public void setReaderGroups(Long[] grids_)
      Deprecated.
      Sets the groups that have read permissions on this folder
      Parameters:
      grids_ - the groups that have read permissions

    • setWriters

      public void setWriters(String[] uids_)
      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

      public void setWriterGroups(Long[] grids_)
      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

      public String[] getAdminPermissionOnly()
      Deprecated.
      Retrieves the list of users who ONLY have administrative permissions on this folder
      Returns:
      a list of unique IDs of users

    • getForum

      public Long 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

      public String[] getReadPermissionOnly()
      Deprecated.
      Retrieves the list of users who ONLY have read permissions on this folder
      Returns:
      a list of unique IDs of users

    • getWritePermissionOnly

      public String[] getWritePermissionOnly()
      Deprecated.
      Retrieves the list of users who ONLY have write permissions on this folder
      Returns:
      a list of unique IDs of users

    • setAdminPermissionOnly

      public void setAdminPermissionOnly(String[] uids_)
      Deprecated.
      Sets the list of users who ONLY have administrative permissions on this folder
      Parameters:
      uids_ - an array of unique IDs of users

    • setForum

      public void setForum(Long forumId_)
      Deprecated.
      Associates a Discussion Topic with this folder
      Parameters:
      forumId_ - the unique ID of the Discussion Topic

    • setReadPermissionOnly

      public void setReadPermissionOnly(String[] uids_)
      Deprecated.
      Sets the list of users who ONLY have read permissions on this folder
      Parameters:
      uids_ - an array of unique IDs of users

    • setWritePermissionOnly

      public void setWritePermissionOnly(String[] uids)
      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

      public Object clone() throws CloneNotSupportedException
      Deprecated.
      Overrides:
      clone in class Object
      Throws:
      CloneNotSupportedException

    • getUuid

      @ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()
      Deprecated.

    • setUuid

      public void setUuid(String uuid)
      Deprecated.