com.jivesoftware.community
Interface JiveContainer

All Superinterfaces:

JiveObject

All Known Subinterfaces:

Blog, Community, JiveHierarchicalContainer, Project, SocialGroup

public interface JiveContainer
extends JiveObject

A base container object that most jive container objects will implement

Method Summary

Collection<ContainableType>	getAvailableContentTypes() Gets an array of ContainableTypes that are available for use by this container type
Set<CommunityTaggableType>	getCommunityTaggableTypes() Returns the set of all CommunityTaggableTypes that are currently enabled for this container.
Collection<ContainableType>	getContentTypes() Gets an array of ContainableTypes that are enabled for this container.
Date	getCreationDate() Returns the Date that the container was created.
String	getDescription() Returns the description of the container.
String	getDisplayName() Returns the display name of the container.
Set<GenericTaggableType>	getGenericTaggableTypes() Returns the set of all GenericTaggableType that are currently available for this container.
InterceptorManager	getInterceptorManager() Returns an interceptor manager that can be used to manage the interceptors for this container.
Date	getModificationDate() Returns the Date this container was last modified.
String	getName() Returns the name of the container.
Permissions	getPermissions(AuthToken authToken) Deprecated.
PermissionsManager	getPermissionsManager() Deprecated.
Map<String,String>	getProperties() Retrieve a map of all the extended properties for the container.
List<TaggableType>	getTaggableTypes() Gets an array of TaggableTypes that are enabled for this container.
boolean	isAuthorized(long permissionType) Deprecated.
void	setContentTypes(Collection<ContainableType> types) Sets an array of ContainableTypes that are enabled for this container;
void	setCreationDate(Date creationDate) Sets the creation date of the container.
void	setDescription(String description) Sets the description of the container.
void	setDisplayName(String displayName) Sets the display name of the container that is used as the URI.
void	setModificationDate(Date modificationDate) Sets the date the container was last modified.
void	setName(String name) Sets the name of the container.

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Method Detail

getName

String getName()

Returns the name of the container.

Returns:

the name of the container.

setName

void setName(String name)
             throws UnauthorizedException

Sets the name of the container.

Parameters:

name - the name of the container.

Throws:

UnauthorizedException - if not an administrator of this container

getDisplayName

String getDisplayName()

Returns the display name of the container.

Returns:

the display name of the container

setDisplayName

void setDisplayName(String displayName)
                    throws UnauthorizedException,
                           NameAlreadyExistsException

Sets the display name of the container that is used as the URI. The display name will be used as part of the URI.

This method will throw an IllegalArgumentException if

• the new name is already associated with another container
• if the name contains any non-alphanumeric characters

Use the com.jivesoftware.util.StringUtils#containsNonAlphanumeric(String) method to test a string for non alphanumeric characters.

Parameters:

displayName - the display name

Throws:

UnauthorizedException - if not an administrator of this container

NameAlreadyExistsException - if attempting to use an existing display name.

getDescription

String getDescription()

Returns the description of the container.

Returns:

the description of the container.

setDescription

void setDescription(String description)
                    throws UnauthorizedException

Sets the description of the container.

Parameters:

description - the description of the container.

Throws:

UnauthorizedException - if not an administrator of this container

getCreationDate

Date getCreationDate()

Returns the Date that the container was created.

Returns:

the Date the container was created.

setCreationDate

void setCreationDate(Date creationDate)
                     throws UnauthorizedException

Sets the creation date of the container. In most cases, the creation date will default to when the container was entered into the system. However, the creation date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.

Parameters:

creationDate - the date the container was created.

Throws:

UnauthorizedException - if not an administrator of this container

getModificationDate

Date getModificationDate()

Returns the Date this container was last modified. In other words, the date of the most recent update in this container.

Returns:

the Date the container was last modified.

setModificationDate

void setModificationDate(Date modificationDate)
                         throws UnauthorizedException

Sets the date the container was last modified. In most cases, last modified will default to when the container data was last changed. However, the last modified date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.

Parameters:

modificationDate - the date the container was modified.

Throws:

UnauthorizedException - if not an admininstrator of this container

getAvailableContentTypes

Collection<ContainableType> getAvailableContentTypes()

Gets an array of ContainableTypes that are available for use by this container type

Returns:

an array of ContainableTypes that are available for use by this container type

getContentTypes

Collection<ContainableType> getContentTypes()

Gets an array of ContainableTypes that are enabled for this container.

Returns:

an array of ContainableTypes that are enabled for this container.

setContentTypes

void setContentTypes(Collection<ContainableType> types)
                     throws UnauthorizedException

Sets an array of ContainableTypes that are enabled for this container;

Parameters:

types - an array of ContainableTypes that are enabled for this container

Throws:

UnauthorizedException - if not an administrator of this container

getTaggableTypes

List<TaggableType> getTaggableTypes()

Gets an array of TaggableTypes that are enabled for this container.

Returns:

an array of TaggableTypes that are enabled for this container.

getCommunityTaggableTypes

Set<CommunityTaggableType> getCommunityTaggableTypes()

Returns the set of all CommunityTaggableTypes that are currently enabled for this container.

Returns:

the set of all CommunityTaggableTypes that are currently enabled for this container.

Since:

Jive SBS 3.0

getGenericTaggableTypes

Set<GenericTaggableType> getGenericTaggableTypes()

Returns the set of all GenericTaggableType that are currently available for this container.

Returns:

the set of all GenericTaggableType that are currently available for this container.

Since:

Jive SBS 3.0

getInterceptorManager

InterceptorManager getInterceptorManager()
                                         throws UnauthorizedException

Returns an interceptor manager that can be used to manage the interceptors for this container.

Returns:

an InterceptorManager to manage interceptors for this container.

Throws:

UnauthorizedException - if not an administrator of this container

getPermissionsManager

@Deprecated
PermissionsManager getPermissionsManager()
                                         throws UnauthorizedException

Deprecated.

Returns a permissions manager that can be used to set permissions for this container. Only admins can perform this function.

Returns:

a PermissionsManager to manage the permissions for the container.

Throws:

UnauthorizedException - if not an administrator of this container

getPermissions

@Deprecated
Permissions getPermissions(AuthToken authToken)

Deprecated.

Returns the permissions for the container that correspond to the passed-in AuthToken. This method is not generally useful to skin writers. Instead, the isAuthorized(long) method should be used for permission checking.

Parameters:

authToken - the auth token to lookup permissions for.

Returns:

the permissions for the container that correspond to the passed-in AuthToken.

isAuthorized

@Deprecated
boolean isAuthorized(long permissionType)

Deprecated.

Returns true if the handle on the object has the permission specified. For example, if a community administrator has a handle on a community, then calling isAuthorized(Permissions.COMMUNITY_ADMIN) would return true.

A list of possible permissions can be found in the Permissions class. Certain methods of this class are restricted to certain permissions as specified in the method comments.

Parameters:

permissionType - permissionType a permission type.

Returns:

true if the handle on the object has the specified permission.

See Also:

Permissions

getProperties

Map<String,String> getProperties()

Retrieve a map of all the extended properties for the container. Each container can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface. The map is alterable if the user is authorized to modify the community. Null keys and values are not allowed.

If the user is not authorized to modify the container any method which modifies the map will fail with a UnsupportedOperationException;

Returns:

a map of extended properties.