Package com.appiancorp.suiteapi.collaboration

Class Community

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

This class represents a community in the collaboration application.

See Also:

  • Field Details

    • USER_STATUS_UNSUBSCRIBED

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

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

      public static final Long 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_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:

    • SORT_ORDER_ASCENDING

      public static final Integer SORT_ORDER_ASCENDING
      Deprecated.
      Sort communities in ascending order

    • SORT_ORDER_DESCENDING

      public static final Integer SORT_ORDER_DESCENDING
      Deprecated.
      Sort communities in descending order

    • SORT_COLUMN_NAME

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

    • SORT_COLUMN_DESCRIPTION

      public static final String SORT_COLUMN_DESCRIPTION
      Deprecated.
      Sort communities by description
      See Also:

    • SORT_COLUMN_LAST_MODIFIED_DATE

      public static final String 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 a KnowledgeCenter or 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 communities by the number of documents they (and their subcommunities) contain
      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_DESCRIPTION

      public static final Integer SORT_BY_DESCRIPTION
      Deprecated.
      Sort by the Description property

    • SORT_BY_ADMINISTRATORS

      public static final Integer SORT_BY_ADMINISTRATORS
      Deprecated.
      Sort by the Administrators property (array of Administrator user names)

    • SORT_BY_PARENT_ID

      public static final Integer SORT_BY_PARENT_ID
      Deprecated.
      Sort by the Parent ID property

    • SORT_BY_PORTAL_ID

      public static final Integer SORT_BY_PORTAL_ID
      Deprecated.
      Sort by the Portal ID property

    • SORT_BY_DATE_CREATED

      public static final Integer SORT_BY_DATE_CREATED
      Deprecated.
      Sort by the Date Created 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_IS_ACTIVE

      public static final Integer SORT_BY_IS_ACTIVE
      Deprecated.
      Sort by the Is Active property

    • SORT_BY_PARENT_NAME

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

  • Constructor Details

    • Community

      public Community()
      Deprecated.

  • Method Details

    • getAdministrators

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

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

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

      public String getDescription()
      Deprecated.
      Provides a short description (if it exists) of this community
      Returns:
      a description of this community

    • getId

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

    • isActive

      public boolean isActive()
      Deprecated.
      Checks whether or not this community is active
      Returns:
      true if the community is active; false otherwise.

    • getName

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

    • getNumberOfDocuments

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

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

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

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

      public void setDateCreated(Timestamp dtcreated)
      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

      public void setDescription(String desc)
      Deprecated.
      Sets the description of this community
      Parameters:
      desc - the description of this community

    • setId

      public void setId(Long coid)
      Deprecated.
      Sets the unique ID of this community
      Specified by:
      setId in interface LocalId
      Parameters:
      coid - the unique ID of this community
      See Also:

    • 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

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

    • setNumberOfDocuments

      public void setNumberOfDocuments(Long num)
      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

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

      public String getCommName()
      Deprecated.
      Returns the name of the community
      Returns:
      the name of the community

    • getPortalId

      public Long getPortalId()
      Deprecated.
      Not currently used.

    • setCommName

      public void setCommName(String commName)
      Deprecated.
      Sets the name of the community
      Parameters:
      commName - the name of the community

    • setPortalId

      public void setPortalId(Long portalId)
      Deprecated.
      Not currently used.

    • getParentName

      public String getParentName()
      Deprecated.
      Returns the name of the parent community
      Returns:
      Returns the name of the parent community

    • setParentName

      public void setParentName(String parentName)
      Deprecated.
      Sets the name of the parent community
      Parameters:
      parentName - The parent community name to set.

    • getUserStatus

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

      public 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())
      Parameters:
      userStatus_ - the user status of the current user for this community

    • clone

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