Class Community
java.lang.Object
com.appiancorp.suiteapi.collaboration.Community
- All Implemented Interfaces:
LocalId
,Serializable
,Cloneable
Deprecated.
This class represents a community in the collaboration application.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.Access level of administratorstatic final int
Deprecated.Access level of 'no access'static final Integer
Deprecated.Sort by the Administrators property (array of Administrator user names)static final Integer
Deprecated.Sort by the Date Created propertystatic final Integer
Deprecated.Sort by the Description propertystatic final Integer
Deprecated.Sort by the ID propertystatic final Integer
Deprecated.Sort by the Is Active 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 ID propertystatic final Integer
Deprecated.Sort by the Parent Name propertystatic final Integer
Deprecated.Sort by the Portal ID propertystatic final String
Deprecated.Sort communities by descriptionstatic final String
Deprecated.Sort communities by the last date of modification of any of the knowledge centers, folders and documents contained in the communities.static final String
Deprecated.Sort communities by namestatic final String
Deprecated.Sort communities by the number of documents they (and their subcommunities) containstatic final Integer
Deprecated.Sort communities in ascending orderstatic final Integer
Deprecated.Sort communities in descending orderstatic final Long
Deprecated.User status of pending (The user is pending subscription to at least one knowledge center within the community and its subcommunities, and unsubscribed to all other knowledge centers within the community and its subcommunities)static final Long
Deprecated.User status of subscribed (The user is subscribed to at least one knowledge center within the community and its subcommunities)static final Long
Deprecated.User status of unsubscribed (The user is unsubscribed to all child knowledge centers within the community and its subcommunities) -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Deprecated.Long[]
Deprecated.Returns a list of all the administrator groups for this community.String[]
Deprecated.Returns a list of all the administrators for this community.Deprecated.Returns the name of the communityDeprecated.Returns the date and time that this community was created.Deprecated.Provides a short description (if it exists) of this communitygetId()
Deprecated.Returns the unique ID of this communitygetName()
Deprecated.Returns the name of this communityDeprecated.Returns the total number of documents in the sub-communities, knowledge centers, and folders of this communityDeprecated.Retrieves the unique ID of the parent community of this community, if such a parent exists.Deprecated.Returns the name of the parent communityDeprecated.Not currently used.Deprecated.Gets the user status of the current user for this Community.boolean
isActive()
Deprecated.Checks whether or not this community is activevoid
setActive
(boolean b) Deprecated.Sets whether this community is active or notvoid
setAdministratorGroups
(Long[] admins) Deprecated.Overwrites and updates the list of administrator groupss for this community.void
setAdministrators
(String[] admins) Deprecated.Overwrites and updates the list of administrators for this community.void
setCommName
(String commName) Deprecated.Sets the name of the communityvoid
setDateCreated
(Timestamp dtcreated) Deprecated.Sets the date and time that this community was created.void
setDescription
(String desc) Deprecated.Sets the description of this communityvoid
Deprecated.Sets the unique ID of this communityvoid
Deprecated.Sets the name of the communityvoid
setNumberOfDocuments
(Long num) Deprecated.Sets the total number of documents in the sub-communities, knowledge centers, and folders of this communityvoid
setParentId
(Long Long) Deprecated.Sets the unique ID of the parent community of this community, if such a parent exists.void
setParentName
(String parentName) Deprecated.Sets the name of the parent communityvoid
setPortalId
(Long portalId) Deprecated.Not currently used.void
setUserStatus
(Long userStatus_) Deprecated.Sets the user status of the current user for this community (NB This property is currently only set by a call to CommunityService.getRootCommunities() or CommunityService.getChildCommunities())
-
Field Details
-
USER_STATUS_UNSUBSCRIBED
Deprecated.User status of unsubscribed (The user is unsubscribed to all child knowledge centers within the community and its subcommunities) -
USER_STATUS_SUBSCRIBED
Deprecated.User status of subscribed (The user is subscribed to at least one knowledge center within the community and its subcommunities) -
USER_STATUS_PENDING
Deprecated.User status of pending (The user is pending subscription to at least one knowledge center within the community and its subcommunities, and unsubscribed to all other knowledge centers within the community and its subcommunities) -
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:
-
SORT_ORDER_ASCENDING
Deprecated.Sort communities in ascending order -
SORT_ORDER_DESCENDING
Deprecated.Sort communities in descending order -
SORT_COLUMN_NAME
Deprecated.Sort communities by name- See Also:
-
SORT_COLUMN_DESCRIPTION
Deprecated.Sort communities by description- See Also:
-
SORT_COLUMN_LAST_MODIFIED_DATE
Deprecated.Sort communities by the last date of modification of any of the knowledge centers, folders and documents contained in the communities. The last date of modification of aKnowledgeCenter
or 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 communities by the number of documents they (and their subcommunities) contain- See Also:
-
SORT_BY_ID
Deprecated.Sort by the ID property -
SORT_BY_NAME
Deprecated.Sort by the Name property -
SORT_BY_DESCRIPTION
Deprecated.Sort by the Description property -
SORT_BY_ADMINISTRATORS
Deprecated.Sort by the Administrators property (array of Administrator user names) -
SORT_BY_PARENT_ID
Deprecated.Sort by the Parent ID property -
SORT_BY_PORTAL_ID
Deprecated.Sort by the Portal ID property -
SORT_BY_DATE_CREATED
Deprecated.Sort by the Date Created property -
SORT_BY_NUMBER_OF_DOCUMENTS
Deprecated.Sort by the Number of Documents property -
SORT_BY_IS_ACTIVE
Deprecated.Sort by the Is Active property -
SORT_BY_PARENT_NAME
Deprecated.Sort by the Parent Name property
-
-
Constructor Details
-
Community
public Community()Deprecated.
-
-
Method Details
-
getAdministrators
Deprecated.Returns a list of all the administrators for this community.- Returns:
- a list of the unique IDs of the users who are administrators for this community.
-
getAdministratorGroups
Deprecated.Returns a list of all the administrator groups for this community.- Returns:
- a list of the unique IDs of the groups who are administrators for this community.
-
getDateCreated
Deprecated.Returns the date and time that this community was created.- Returns:
- the date and time (combined as a Timestamp) that this community was created.
-
getDescription
Deprecated.Provides a short description (if it exists) of this community- Returns:
- a description of this community
-
getId
Deprecated.Returns the unique ID of this community -
isActive
public boolean isActive()Deprecated.Checks whether or not this community is active- Returns:
true
if the community is active;false
otherwise.
-
getName
Deprecated.Returns the name of this community- Returns:
- the name of this community
-
getNumberOfDocuments
Deprecated.Returns the total number of documents in the sub-communities, knowledge centers, and folders of this community- Returns:
- the total number of documents stored in the community
-
getParentId
Deprecated.Retrieves the unique ID of the parent community of this community, if such a parent exists.- Returns:
- the unique ID of the parent community
-
setAdministrators
Deprecated.Overwrites and updates the list of administrators for this community.- Parameters:
admins
- a list of unique IDs of those users who are administrators for this community
-
setAdministratorGroups
Deprecated.Overwrites and updates the list of administrator groupss for this community.- Parameters:
admins
- a list of unique IDs of those groups who are administrators for this community
-
setDateCreated
Deprecated.Sets the date and time that this community was created.- Parameters:
dtcreated
- the date and time (combined as a Timestamp) that this community was created.
-
setDescription
Deprecated.Sets the description of this community- Parameters:
desc
- the description of this community
-
setId
Deprecated.Sets the unique ID of this community -
setActive
public void setActive(boolean b) Deprecated.Sets whether this community is active or not- Parameters:
b
-true
if the community is active;false
otherwise.
-
setName
Deprecated.Sets the name of the community- Parameters:
name
- the name of the community
-
setNumberOfDocuments
Deprecated.Sets the total number of documents in the sub-communities, knowledge centers, and folders of this community- Parameters:
num
- the total number of documents in the community
-
setParentId
Deprecated.Sets the unique ID of the parent community of this community, if such a parent exists.- Parameters:
Long
- the unique ID of the parent community
-
getCommName
Deprecated.Returns the name of the community- Returns:
- the name of the community
-
getPortalId
Deprecated.Not currently used. -
setCommName
Deprecated.Sets the name of the community- Parameters:
commName
- the name of the community
-
setPortalId
Deprecated.Not currently used. -
getParentName
Deprecated.Returns the name of the parent community- Returns:
- Returns the name of the parent community
-
setParentName
Deprecated.Sets the name of the parent community- Parameters:
parentName
- The parent community name to set.
-
getUserStatus
Deprecated.Gets the user status of the current user for this Community. (NB This property is currently only set by a call to CommunityService.getRootCommunities() or CommunityService.getChildCommunities())- Returns:
- the user status of the current user for this community.
-
setUserStatus
Deprecated.Sets the user status of the current user for this community (NB This property is currently only set by a call to CommunityService.getRootCommunities() or CommunityService.getChildCommunities())- Parameters:
userStatus_
- the user status of the current user for this community
-
clone
Deprecated.- Overrides:
clone
in classObject
- Throws:
CloneNotSupportedException
-
Community
instead.