Class KnowledgeCenter
java.lang.Object
com.appiancorp.suiteapi.collaboration.KnowledgeCenter
- All Implemented Interfaces:
LocalId
,Serializable
,Cloneable
Deprecated.
This class represents a knowledge center 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 Integer
Deprecated.Sort by the KnowledgeCenter Administrator Groups propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Administrators propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Auto Approve for Read Access propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Changes Requires Approval propertystatic final Integer
Deprecated.Sort by the Community ID property to which KnowledgeCenter belongs.static final Integer
Deprecated.Sort by the Community Name property to which the KnowledgeCenter belongsstatic final Integer
Deprecated.Sort by the KnowledgeCenter Creator propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Date Created propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Description propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Discussion Topic/Topic propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Document pending Approval propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Expiration Days propertystatic final Integer
Deprecated.static final Integer
Deprecated.Sort by the KnowledgeCenter Folders pending Approval propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter ID propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Is Searchable propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Name propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Number of Documents propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Partition propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Reader Groups propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Readers propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Size propertystatic final Integer
Deprecated.Sort by the type of KnowledgeCenter propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Users Pending Approval propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Versions pending Approval propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Writer Groups propertystatic final Integer
Deprecated.Sort by the KnowledgeCenter Writers propertystatic final String
Deprecated.Sort knowledge centers by their creatorstatic final String
Deprecated.Sort knowledge centers by descriptionstatic final String
Deprecated.Sort knowledge centers by the last date of modification of any of the folders and documents contained in the knowledge centers.static final String
Deprecated.Sort knowledge centers by namestatic final String
Deprecated.Sort knowledge centers by the number of documents they containstatic final Long
Deprecated.Type field for a community knowledge centerstatic final Long
Deprecated.Type field for a personal knowledge centerstatic final Long
Deprecated.User status of pendingstatic final Long
Deprecated.User status of subscribedstatic final Long
Deprecated.User status of unsubscribed -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.int
Deprecated.Gets the access level of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())Long[]
Deprecated.Gets the groups which have administrative permissions on this knowledge centerString[]
Deprecated.Gets the users who have administrative permissions on this knowledge centerDeprecated.Gets the unique ID of the community that contains this knowledge centerDeprecated.Gets the name of the community that this knowledge center belongs toDeprecated.Gets the user who created this knowledge centerDeprecated.Gets the date and time that this knowledge center was createdDeprecated.Gets the description of this knowledge centerLong[]
Deprecated.Gets all the documents in the knowledge center which are pending administrative approvalDeprecated.Gets the number of days after upload to this knowledge center that a document will expireLong[]
Deprecated.Gets the folders contained in this knowledge centerLong[]
Deprecated.Gets all the folders in the knowledge center which are pending administrative approvalgetForum()
Deprecated.Gets the Discussion Topic which is associated with this knowledge centergetId()
Deprecated.Gets the unique ID of this knowledge centergetName()
Deprecated.Gets the name of this knowledge centerDeprecated.Retrieves the total number of documents in this knowledge centerDeprecated.Retrieves the path where the collaboration application stores the physical knowledge center on the driveLong[]
Deprecated.Gets the groups which have reader permissions on this knowledge centerString[]
Deprecated.Gets the users who have read permissions on this knowledge centergetSize()
Deprecated.Gets the amount of physical space the documents contained within this knowledge center occupystatic Integer
getSortColumn
(String attribute_) Deprecated.getType()
Deprecated.Gets the type of this knowledge center (either TYPE_COMMUNITY or TYPE_PERSONAL)String[]
Deprecated.Gets the users who are awaiting approval for access on this knowledge centerDeprecated.Gets the user status of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())Long[]
Deprecated.Gets the documents in this knowledge center which are awaiting administrative approvalLong[]
Deprecated.Gets the groups which have write permissions on this knowledge centerString[]
Deprecated.Gets the users who have write permissions on this knowledge centerboolean
Deprecated.Checks whether approval is automatically given for any request for read-only access to this knowledge centerboolean
Deprecated.Checks whether changes to this knowledge center requires administrator approval before being committedboolean
Deprecated.Checks whether the knowledge center is searchablevoid
setAccessLevel
(int access_) Deprecated.Sets the access level of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())void
setAdministratorGroups
(Long[] grids_) Deprecated.Sets the groups which will have administrative permissions on this knowledge centervoid
setAdministrators
(String[] uids_) Deprecated.Sets the users which will have administrative permissions on this knowledge centervoid
setAutoApproveForReadOnlyAccess
(boolean autoApproveForReadOnlyAccess_) Deprecated.Sets whether approval is automatically given for any request for read-only access to this knowledge centervoid
setChangesRequireApproval
(boolean b_) Deprecated.Sets whether changes to this folder require administrative approval before committing.void
setCommunityId
(Long coid_) Deprecated.Sets the community which contains this knowledge centervoid
setCommunityName
(String commname_) Deprecated.Sets the name of the community that contains this knowledge centervoid
setCreator
(String uid_) Deprecated.Sets the user who created thiei knowledge centervoid
setDateCreated
(Timestamp dtcreated_) Deprecated.Sets the date and time that this knowledge center was createdvoid
setDescription
(String desc_) Deprecated.Sets the description of this knowledge centervoid
setDocumentsPendingApproval
(Long[] doids_) Deprecated.Sets the documents in this knowledge center which are awaiting administrative approvalvoid
setExpirationDays
(Long expirationDays_) Deprecated.Sets the number of days after upload to this knowledge center that a document will expirevoid
setFolders
(Long[] foids_) Deprecated.Sets the folders contained in this knowledge centervoid
setFoldersPendingApproval
(Long[] foids_) Deprecated.Sets the folders in this knowledge center that are awaiting administrative approval.void
Deprecated.Sets the Discussion Topic which is associated wit this knowledge centervoid
Deprecated.Sets the unique ID of this knowledge centervoid
setIsSearchable
(boolean isSearchable_) Deprecated.Sets whether this knowledge center is searchablevoid
Deprecated.Sets the name of the knowledge centervoid
setNumberOfDocuments
(Long num_) Deprecated.Sets the total number of documents stored in the knowledge centervoid
setPartition
(String partition_) Deprecated.Sets the path where the collaboration application stores the physical knowledge on the drivevoid
setReaderGroups
(Long[] grids_) Deprecated.Sets the groups that have read permissions on this knowledge centervoid
setReaders
(String[] uids_) Deprecated.Sets the users that have read permissions on this knowledge centervoid
Deprecated.Sets the amount of physical space the documents contained within this knowledge center occupyvoid
Deprecated.Sets the type of the knowledge center (either TYPE_COMMUNITY or TYPE_PERSONAL)void
setUsersPendingApproval
(String[] uids_) Deprecated.Sets the users who are awaiting approval for access to this knowledge centervoid
setUserStatus
(Long userStatus_) Deprecated.Sets the user status of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())void
setVersionsPendingApproval
(Long[] versionsPendingApproval_) Deprecated.Registers the documents which are awaiting administrative approvalvoid
setWriterGroups
(Long[] grids_) Deprecated.Sets the groups that have write permissions on this knowledge centervoid
setWriters
(String[] uids_) Deprecated.Sets the users that have write permissions on this knowledge center
-
Field Details
-
SORT_COLUMN_NAME
Deprecated.Sort knowledge centers by name- See Also:
-
SORT_COLUMN_DESCRIPTION
Deprecated.Sort knowledge centers by description- See Also:
-
SORT_COLUMN_LAST_MODIFIED_DATE
Deprecated.Sort knowledge centers by the last date of modification of any of the folders and documents contained in the knowledge centers. 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 knowledge centers by the number of documents they contain- See Also:
-
SORT_COLUMN_CREATOR
Deprecated.Sort knowledge centers by their creator- See Also:
-
TYPE_COMMUNITY
Deprecated.Type field for a community knowledge center -
TYPE_PERSONAL
Deprecated.Type field for a personal knowledge center -
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:
-
USER_STATUS_UNSUBSCRIBED
Deprecated.User status of unsubscribed -
USER_STATUS_SUBSCRIBED
Deprecated.User status of subscribed -
USER_STATUS_PENDING
Deprecated.User status of pending -
SORT_BY_ID
Deprecated.Sort by the KnowledgeCenter ID property -
SORT_BY_NAME
Deprecated.Sort by the KnowledgeCenter Name property -
SORT_BY_DESCRIPTION
Deprecated.Sort by the KnowledgeCenter Description property -
SORT_BY_TYPE
Deprecated.Sort by the type of KnowledgeCenter property -
SORT_BY_COMMUNITY_ID
Deprecated.Sort by the Community ID property to which KnowledgeCenter belongs. -
SORT_BY_COMMUNITY_NAME
Deprecated.Sort by the Community Name property to which the KnowledgeCenter belongs -
SORT_BY_FOLDERS
Deprecated. -
SORT_BY_IS_SEARCHABLE
Deprecated.Sort by the KnowledgeCenter Is Searchable property -
SORT_BY_CHANGES_REQUIRE_APPROVAL
Deprecated.Sort by the KnowledgeCenter Changes Requires Approval property -
SORT_BY_AUTO_APPROVE_FOR_READ_ONLY_ACCESS
Deprecated.Sort by the KnowledgeCenter Auto Approve for Read Access property -
SORT_BY_PARTITION
Deprecated.Sort by the KnowledgeCenter Partition property -
SORT_BY_NUMBER_OF_DOCUMENTS
Deprecated.Sort by the KnowledgeCenter Number of Documents property -
SORT_BY_SIZE
Deprecated.Sort by the KnowledgeCenter Size property -
SORT_BY_DISCUSSION_THREAD
Deprecated.Sort by the KnowledgeCenter Discussion Topic/Topic property -
SORT_BY_EXPIRATION_DAYS
Deprecated.Sort by the KnowledgeCenter Expiration Days property -
SORT_BY_DATE_CREATED
Deprecated.Sort by the KnowledgeCenter Date Created property -
SORT_BY_USERS_PENDING_APPROVAL
Deprecated.Sort by the KnowledgeCenter Users Pending Approval property -
SORT_BY_DOCUMENTS_PENDING_APPROVAL
Deprecated.Sort by the KnowledgeCenter Document pending Approval property -
SORT_BY_FOLDERS_PENDING_APPROVAL
Deprecated.Sort by the KnowledgeCenter Folders pending Approval property -
SORT_BY_VERSIONS_PENDING_APPROVAL
Deprecated.Sort by the KnowledgeCenter Versions pending Approval property -
SORT_BY_CREATOR
Deprecated.Sort by the KnowledgeCenter Creator property -
SORT_BY_READERS
Deprecated.Sort by the KnowledgeCenter Readers property -
SORT_BY_WRITERS
Deprecated.Sort by the KnowledgeCenter Writers property -
SORT_BY_ADMINISTRATORS
Deprecated.Sort by the KnowledgeCenter Administrators property -
SORT_BY_READER_GROUPS
Deprecated.Sort by the KnowledgeCenter Reader Groups property -
SORT_BY_WRITER_GROUPS
Deprecated.Sort by the KnowledgeCenter Writer Groups property -
SORT_BY_ADMINISTRATOR_GROUPS
Deprecated.Sort by the KnowledgeCenter Administrator Groups property
-
-
Constructor Details
-
KnowledgeCenter
public KnowledgeCenter()Deprecated.
-
-
Method Details
-
getSortColumn
Deprecated. -
getAdministratorGroups
Deprecated.Gets the groups which have administrative permissions on this knowledge center- Returns:
- a list of unique IDs of groups which have administrative permissions
-
getAdministrators
Deprecated.Gets the users who have administrative permissions on this knowledge center- Returns:
- a list of unique IDs of users who have administrative permissions
-
isChangesRequireApproval
public boolean isChangesRequireApproval()Deprecated.Checks whether changes to this knowledge center requires administrator approval before being committed- Returns:
true
if changes to this knowledge center must be approved;false
otherwise
-
getCommunityName
Deprecated.Gets the name of the community that this knowledge center belongs to- Returns:
- the name of the community
-
getCreator
Deprecated.Gets the user who created this knowledge center- Returns:
- the unique ID of the user
-
getDateCreated
Deprecated.Gets the date and time that this knowledge center was created- Returns:
- the date and time (combined as a
Timestamp
object) that this knowledge center was created
-
getDescription
Deprecated.Gets the description of this knowledge center- Returns:
- the description of this knowledge center
-
getId
Deprecated.Gets the unique ID of this knowledge center -
getName
Deprecated.Gets the name of this knowledge center- Returns:
- the name of this knowledge center
-
getNumberOfDocuments
Deprecated.Retrieves the total number of documents in this knowledge center- Returns:
- the total number of documents in this knowledge center
-
getReaderGroups
Deprecated.Gets the groups which have reader permissions on this knowledge center- Returns:
- a list of unique IDs of groups which have reader permissions
-
getReaders
Deprecated.Gets the users who have read permissions on this knowledge center- Returns:
- a list of unique IDs of users who have read permissions
-
getType
Deprecated.Gets the type of this knowledge center (either TYPE_COMMUNITY or TYPE_PERSONAL)- Returns:
- the type of this knowledge center
-
getWriterGroups
Deprecated.Gets the groups which have write permissions on this knowledge center- Returns:
- a list of unique IDs of groups which have write permissions
-
getWriters
Deprecated.Gets the users who have write permissions on this knowledge center- Returns:
- a list of unique IDs of users who have write permissions
-
setAdministratorGroups
Deprecated.Sets the groups which will have administrative permissions on this knowledge center- Parameters:
grids_
- a list of unique IDs of groups to be given administrative permissions
-
setAdministrators
Deprecated.Sets the users which will have administrative permissions on this knowledge center- Parameters:
uids_
- a list of unique IDs of users to be given administrative permissions
-
setChangesRequireApproval
public void setChangesRequireApproval(boolean b_) Deprecated.Sets whether changes to this folder require administrative approval before committing.- Parameters:
b_
-true
if changes to this folder require approval;false
if otherwise
-
setCommunityName
Deprecated.Sets the name of the community that contains this knowledge center- Parameters:
commname_
- the name of the community
-
setCreator
Deprecated.Sets the user who created thiei knowledge center- Parameters:
uid_
- the unique ID of the user
-
setDateCreated
Deprecated.Sets the date and time that this knowledge center was created- Parameters:
dtcreated_
- the date and time (combined as aTimestamp
object) when this knowledge center was created
-
setDescription
Deprecated.Sets the description of this knowledge center- Parameters:
desc_
- the description of this knowledge center
-
setId
Deprecated.Sets the unique ID of this knowledge center -
setName
Deprecated.Sets the name of the knowledge center- Parameters:
name_
- the name if this knowledge center
-
setNumberOfDocuments
Deprecated.Sets the total number of documents stored in the knowledge center- Parameters:
num_
- the total number of documents stored in the knowledge center
-
setReaderGroups
Deprecated.Sets the groups that have read permissions on this knowledge center- Parameters:
grids_
- the groups that have read permissions
-
setReaders
Deprecated.Sets the users that have read permissions on this knowledge center- Parameters:
uids_
- the users that have read permissions
-
setType
Deprecated.Sets the type of the knowledge center (either TYPE_COMMUNITY or TYPE_PERSONAL)- Parameters:
kctype_
- the type of the knowledge center
-
setWriterGroups
Deprecated.Sets the groups that have write permissions on this knowledge center- Parameters:
grids_
- the groups that have write permissions
-
setWriters
Deprecated.Sets the users that have write permissions on this knowledge center- Parameters:
uids_
- the users that have write permissions
-
isAutoApproveForReadOnlyAccess
public boolean isAutoApproveForReadOnlyAccess()Deprecated.Checks whether approval is automatically given for any request for read-only access to this knowledge center- Returns:
true
if changes to this knowledge center must be approved;false
otherwise
-
getCommunityId
Deprecated.Gets the unique ID of the community that contains this knowledge center- Returns:
- the unique ID of the community
-
getForum
Deprecated.Gets the Discussion Topic which is associated with this knowledge center- Returns:
- the unique ID of the Discussion Topic
-
getDocumentsPendingApproval
Deprecated.Gets all the documents in the knowledge center which are pending administrative approval- Returns:
- a list of unique IDs of the documents
-
getExpirationDays
Deprecated.Gets the number of days after upload to this knowledge center that a document will expire- Returns:
- the number of days after upload that the docoment will expire
-
getFoldersPendingApproval
Deprecated.Gets all the folders in the knowledge center which are pending administrative approval- Returns:
- a list of unique IDs of the folders
-
isIsSearchable
public boolean isIsSearchable()Deprecated.Checks whether the knowledge center is searchable- Returns:
true
if changes to this knowledge center is searchable;false
otherwise
-
getPartition
Deprecated.Retrieves the path where the collaboration application stores the physical knowledge center on the drive- Returns:
- the physical path where the knowledge center is stored
-
getSize
Deprecated.Gets the amount of physical space the documents contained within this knowledge center occupy- Returns:
- the amount of physical space in MBytes
-
getUsersPendingApproval
Deprecated.Gets the users who are awaiting approval for access on this knowledge center- Returns:
- a list of unique IDs of users who are awaiting approval
-
setAutoApproveForReadOnlyAccess
public void setAutoApproveForReadOnlyAccess(boolean autoApproveForReadOnlyAccess_) Deprecated.Sets whether approval is automatically given for any request for read-only access to this knowledge center- Parameters:
autoApproveForReadOnlyAccess_
- whether it will auto-approve for read-only access or not
-
setCommunityId
Deprecated.Sets the community which contains this knowledge center- Parameters:
coid_
- the unique ID of the community
-
setForum
Deprecated.Sets the Discussion Topic which is associated wit this knowledge center- Parameters:
forumId_
- the unique ID of the forum
-
setDocumentsPendingApproval
Deprecated.Sets the documents in this knowledge center which are awaiting administrative approval- Parameters:
doids_
- a list of unique IDs of the documents
-
setExpirationDays
Deprecated.Sets the number of days after upload to this knowledge center that a document will expire- Parameters:
expirationDays_
- the number of days after upload that a document will expire
-
setFoldersPendingApproval
Deprecated.Sets the folders in this knowledge center that are awaiting administrative approval.- Parameters:
foids_
- a list of the unique IDs of the folders
-
setIsSearchable
public void setIsSearchable(boolean isSearchable_) Deprecated.Sets whether this knowledge center is searchable- Parameters:
isSearchable_
-true
if this knowledge center is searchable;false
if otherwise
-
setPartition
Deprecated.Sets the path where the collaboration application stores the physical knowledge on the drive- Parameters:
partition_
- the physical path where the knowledge center is stored
-
setSize
Deprecated.Sets the amount of physical space the documents contained within this knowledge center occupy- Parameters:
size_
- the amount of physical space in MBytes
-
setUsersPendingApproval
Deprecated.Sets the users who are awaiting approval for access to this knowledge center- Parameters:
uids_
- a list of the unique IDs of the users
-
getFolders
Deprecated.Gets the folders contained in this knowledge center- Returns:
- a list of the unique IDs of the folders
-
getVersionsPendingApproval
Deprecated.Gets the documents in this knowledge center which are awaiting administrative approval- Returns:
- a list of the unique IDs of the documents pending approval
-
setFolders
Deprecated.Sets the folders contained in this knowledge center- Parameters:
foids_
- a list of the unique IDs of the folders
-
setVersionsPendingApproval
Deprecated.Registers the documents which are awaiting administrative approval- Parameters:
versionsPendingApproval_
- a list of the unique IDs of the documents pending administrative approval
-
getAccessLevel
public int getAccessLevel()Deprecated.Gets the access level of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())- Returns:
- the access level of the current user for this knowledge center.
-
setAccessLevel
public void setAccessLevel(int access_) Deprecated.Sets the access level of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())- Parameters:
access_
- the access level of the current user for this knowledge center.
-
getUserStatus
Deprecated.Gets the user status of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())- Returns:
- the user status of the current user for this knowledge center.
-
setUserStatus
Deprecated.Sets the user status of the current user for this knowledge center (NOTE: This property is only populated by KnowledgeCenterService.getAccessLevelForKnowledgeCenter and KnowledgeCenterService.getAccessLevelForKnowledgeCenters())- Parameters:
userStatus_
- the user status of the current user for this knowledge center.
-
clone
Deprecated.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
CommunityKnowledgeCenter
instead.