com.jivesoftware.community
Interface DocumentFieldTypeManager

All Superinterfaces:

JiveManager

public interface DocumentFieldTypeManager
extends JiveManager

Manages the creation and deletion of Document Field Types for Clearspace.

See Also:

DocumentFieldType

Method Summary

DocumentFieldType	createDocumentFieldType(java.lang.String name, java.lang.String displayName, java.lang.String description, DocumentFieldType.DataType dataType, DocumentFieldValidator validator, DocumentFieldFormatter formatter) Creates a new DocumentFieldType.
void	deleteDocumentFieldType(DocumentFieldType documentFieldType) Deletes an existing DocumentFieldType.
DocumentFieldType	getDocumentFieldType(long id) Returns the DocumentFieldType with a given id
DocumentFieldType	getDocumentFieldType(java.lang.String name) Returns the DocumentFieldType with a given name
java.util.Collection<DocumentFieldType>	getDocumentFieldTypes() Returns a collection of all the DocumentFieldTypes.

Methods inherited from interface com.jivesoftware.community.JiveManager

destroy, initialize

Method Detail

getDocumentFieldType

DocumentFieldType getDocumentFieldType(long id)
                                       throws DocumentObjectNotFoundException

Returns the DocumentFieldType with a given id

Parameters:

id - id of the DocumentFieldType

Returns:

the DocumentFieldType with the given id

Throws:

DocumentObjectNotFoundException - thrown if there is no DocumentFieldType with the given id.

getDocumentFieldType

DocumentFieldType getDocumentFieldType(java.lang.String name)
                                       throws DocumentObjectNotFoundException

Returns the DocumentFieldType with a given name

Parameters:

name - name of the DocumentField Type

Returns:

the DocumentFieldType with the given name

Throws:

DocumentObjectNotFoundException - thrown if there is no DocumentFieldType with the given name.

getDocumentFieldTypes

java.util.Collection<DocumentFieldType> getDocumentFieldTypes()

Returns a collection of all the DocumentFieldTypes.

Returns:

a collection of DocumentFieldTypes

See Also:

DocumentFieldType

createDocumentFieldType

DocumentFieldType createDocumentFieldType(java.lang.String name,
                                          java.lang.String displayName,
                                          java.lang.String description,
                                          DocumentFieldType.DataType dataType,
                                          DocumentFieldValidator validator,
                                          DocumentFieldFormatter formatter)
                                          throws UnauthorizedException

Creates a new DocumentFieldType.

Parameters:

name - the unique name of the DocumentFieldType. Should be something that is easy to bind to such as "BOOLEAN"

displayName - A friendly name to display in the admin tool.

description - description of the DocumentFieldType to display in the admin tool.

dataType - the xmpp data form type.

validator - the validator for this DocumentFieldType.

formatter - the formatter for this DocumentFieldType.

Returns:

the newly created DocumentFieldType

Throws:

UnauthorizedException - thrown if the user does not have the permissions to create new document field types.

deleteDocumentFieldType

void deleteDocumentFieldType(DocumentFieldType documentFieldType)
                             throws UnauthorizedException

Deletes an existing DocumentFieldType.

Parameters:

documentFieldType - the DocumentFieldType to delete

Throws:

UnauthorizedException - thrown if the user does not have permissions to delete document field types.