com.appiancorp.suiteapi.collaboration

Class Community

java.lang.Object

com.appiancorp.suiteapi.collaboration.Community

All Implemented Interfaces:

LocalId, java.io.Serializable, java.lang.Cloneable

Deprecated.

Use the class Community instead.

@Deprecated
public class Community
extends java.lang.Object
implements LocalId, java.lang.Cloneable, java.io.Serializable

This class represents a community in the collaboration application.

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

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 java.lang.Integer	SORT_BY_ADMINISTRATORS Deprecated. Sort by the Administrators property (array of Administrator user names)
static java.lang.Integer	SORT_BY_DATE_CREATED Deprecated. Sort by the Date Created property
static java.lang.Integer	SORT_BY_DESCRIPTION Deprecated. Sort by the Description property
static java.lang.Integer	SORT_BY_ID Deprecated. Sort by the ID property
static java.lang.Integer	SORT_BY_IS_ACTIVE Deprecated. Sort by the Is Active 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_ID Deprecated. Sort by the Parent ID property
static java.lang.Integer	SORT_BY_PARENT_NAME Deprecated. Sort by the Parent Name property
static java.lang.Integer	SORT_BY_PORTAL_ID Deprecated. Sort by the Portal ID property
static java.lang.String	SORT_COLUMN_DESCRIPTION Deprecated. Sort communities by description
static java.lang.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.
static java.lang.String	SORT_COLUMN_NAME Deprecated. Sort communities by name
static java.lang.String	SORT_COLUMN_NUMBER_OF_DOCUMENTS Deprecated. Sort communities by the number of documents they (and their subcommunities) contain
static java.lang.Integer	SORT_ORDER_ASCENDING Deprecated. Sort communities in ascending order
static java.lang.Integer	SORT_ORDER_DESCENDING Deprecated. Sort communities in descending order
static java.lang.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)
static java.lang.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)
static java.lang.Long	USER_STATUS_UNSUBSCRIBED Deprecated. User status of unsubscribed (The user is unsubscribed to all child knowledge centers within the community and its subcommunities)

Constructor Summary

Constructors

Constructor and Description
Community() Deprecated.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Deprecated.
java.lang.Long[]	getAdministratorGroups() Deprecated. Returns a list of all the administrator groups for this community.
java.lang.String[]	getAdministrators() Deprecated. Returns a list of all the administrators for this community.
java.lang.String	getCommName() Deprecated. Returns the name of the community
java.sql.Timestamp	getDateCreated() Deprecated. Returns the date and time that this community was created.
java.lang.String	getDescription() Deprecated. Provides a short description (if it exists) of this community
java.lang.Long	getId() Deprecated. Returns the unique ID of this community
java.lang.String	getName() Deprecated. Returns the name of this community
java.lang.Long	getNumberOfDocuments() Deprecated. Returns the total number of documents in the sub-communities, knowledge centers, and folders of this community
java.lang.Long	getParentId() Deprecated. Retrieves the unique ID of the parent community of this community, if such a parent exists.
java.lang.String	getParentName() Deprecated. Returns the name of the parent community
java.lang.Long	getPortalId() Deprecated. Not currently used.
java.lang.Long	getUserStatus() Deprecated. Gets the user status of the current user for this Community.
boolean	isActive() Deprecated. Checks whether or not this community is active
void	setActive(boolean b) Deprecated. Sets whether this community is active or not
void	setAdministratorGroups(java.lang.Long[] admins) Deprecated. Overwrites and updates the list of administrator groupss for this community.
void	setAdministrators(java.lang.String[] admins) Deprecated. Overwrites and updates the list of administrators for this community.
void	setCommName(java.lang.String commName) Deprecated. Sets the name of the community
void	setDateCreated(java.sql.Timestamp dtcreated) Deprecated. Sets the date and time that this community was created.
void	setDescription(java.lang.String desc) Deprecated. Sets the description of this community
void	setId(java.lang.Long coid) Deprecated. Sets the unique ID of this community
void	setName(java.lang.String name) Deprecated. Sets the name of the community
void	setNumberOfDocuments(java.lang.Long num) Deprecated. Sets the total number of documents in the sub-communities, knowledge centers, and folders of this community
void	setParentId(java.lang.Long Long) Deprecated. Sets the unique ID of the parent community of this community, if such a parent exists.
void	setParentName(java.lang.String parentName) Deprecated. Sets the name of the parent community
void	setPortalId(java.lang.Long portalId) Deprecated. Not currently used.
void	setUserStatus(java.lang.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())

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

USER_STATUS_UNSUBSCRIBED

public static final java.lang.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 java.lang.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 java.lang.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:

Constant Field Values

ACCESS_LEVEL_NO_ACCESS

public static final int ACCESS_LEVEL_NO_ACCESS

Deprecated.

Access level of 'no access'

See Also:

Constant Field Values

SORT_ORDER_ASCENDING

public static final java.lang.Integer SORT_ORDER_ASCENDING

Deprecated.

Sort communities in ascending order

SORT_ORDER_DESCENDING

public static final java.lang.Integer SORT_ORDER_DESCENDING

Deprecated.

Sort communities in descending order

SORT_COLUMN_NAME

public static final java.lang.String SORT_COLUMN_NAME

Deprecated.

Sort communities by name

See Also:

Constant Field Values

SORT_COLUMN_DESCRIPTION

public static final java.lang.String SORT_COLUMN_DESCRIPTION

Deprecated.

Sort communities by description

See Also:

Constant Field Values

SORT_COLUMN_LAST_MODIFIED_DATE

public static final java.lang.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:

Constant Field Values

SORT_COLUMN_NUMBER_OF_DOCUMENTS

public static final java.lang.String SORT_COLUMN_NUMBER_OF_DOCUMENTS

Deprecated.

Sort communities by the number of documents they (and their subcommunities) contain

See Also:

Constant Field Values

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Deprecated.

Sort by the ID property

SORT_BY_NAME

public static final java.lang.Integer SORT_BY_NAME

Deprecated.

Sort by the Name property

SORT_BY_DESCRIPTION

public static final java.lang.Integer SORT_BY_DESCRIPTION

Deprecated.

Sort by the Description property

SORT_BY_ADMINISTRATORS

public static final java.lang.Integer SORT_BY_ADMINISTRATORS

Deprecated.

Sort by the Administrators property (array of Administrator user names)

SORT_BY_PARENT_ID

public static final java.lang.Integer SORT_BY_PARENT_ID

Deprecated.

Sort by the Parent ID property

SORT_BY_PORTAL_ID

public static final java.lang.Integer SORT_BY_PORTAL_ID

Deprecated.

Sort by the Portal ID property

SORT_BY_DATE_CREATED

public static final java.lang.Integer SORT_BY_DATE_CREATED

Deprecated.

Sort by the Date Created property

SORT_BY_NUMBER_OF_DOCUMENTS

public static final java.lang.Integer SORT_BY_NUMBER_OF_DOCUMENTS

Deprecated.

Sort by the Number of Documents property

SORT_BY_IS_ACTIVE

public static final java.lang.Integer SORT_BY_IS_ACTIVE

Deprecated.

Sort by the Is Active property

SORT_BY_PARENT_NAME

public static final java.lang.Integer SORT_BY_PARENT_NAME

Deprecated.

Sort by the Parent Name property

Constructor Detail

Community

public Community()

Deprecated.

Method Detail

getAdministrators

public java.lang.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 java.lang.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 java.sql.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 java.lang.String getDescription()

Deprecated.

Provides a short description (if it exists) of this community

Returns:

a description of this community

getId

public java.lang.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:

LocalId.setId(Long)

isActive

public boolean isActive()

Deprecated.

Checks whether or not this community is active

Returns:

true if the community is active; false otherwise.

getName

public java.lang.String getName()

Deprecated.

Returns the name of this community

Returns:

the name of this community

getNumberOfDocuments

public java.lang.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 java.lang.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(java.lang.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(java.lang.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(java.sql.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(java.lang.String desc)

Deprecated.

Sets the description of this community

Parameters:

desc - the description of this community

setId

public void setId(java.lang.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:

LocalId.getId()

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(java.lang.String name)

Deprecated.

Sets the name of the community

Parameters:

name - the name of the community

setNumberOfDocuments

public void setNumberOfDocuments(java.lang.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(java.lang.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 java.lang.String getCommName()

Deprecated.

Returns the name of the community

Returns:

the name of the community

getPortalId

public java.lang.Long getPortalId()

Deprecated.

Not currently used.

setCommName

public void setCommName(java.lang.String commName)

Deprecated.

Sets the name of the community

Parameters:

commName - the name of the community

setPortalId

public void setPortalId(java.lang.Long portalId)

Deprecated.

Not currently used.

getParentName

public java.lang.String getParentName()

Deprecated.

Returns the name of the parent community

Returns:

Returns the name of the parent community

setParentName

public void setParentName(java.lang.String parentName)

Deprecated.

Sets the name of the parent community

Parameters:

parentName - The parent community name to set.

getUserStatus

public java.lang.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(java.lang.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 java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Deprecated.

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException