com.jivesoftware.community
Interface DocumentFieldType

All Superinterfaces:

JiveObject

public interface DocumentFieldType
extends JiveObject

Type information that can be associated with a DocumentField. All DocumentFieldTypes should be unique, and should be able to be easily acquired by their name. DocumentFieldTypes specify validation information, formatting information, and the associated XMPP type.

Nested Class Summary

static class

DocumentFieldType.DataType Represents the XMPP data form field type.

Method Summary

DocumentFieldType.DataType	getDataType() Returns the XMPP data form type that this object is.
java.lang.String	getDescription() Returns the description of this document field type
java.lang.String	getDisplayName() Returns a display friendly name that can be shown in the UI.
DocumentFieldFormatter	getFormatter() Returns the formatter for this document field type.
java.lang.String	getName() Returns unique name of this Document Field Type.
DocumentFieldValidator	getValidator() Returns the validator for the document field.
boolean	isModifiable() Whether or not the admin tool should allow this document field to be modified or deleted.
void	setDataType(DocumentFieldType.DataType dataType) Sets the XMPP data form type for this document field type.
void	setDescription(java.lang.String description) Sets the description for this document field type
void	setDisplayName(java.lang.String displayName) Sets the display friend name for this document field type.
void	setFormatter(DocumentFieldFormatter documentFieldFormatter) Sets the formatter for this document field type.
void	setName(java.lang.String name) Sets the unique name of this document field type.
void	setValidator(DocumentFieldValidator validator) Sets the validator for the document field type.

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Method Detail

getName

java.lang.String getName()

Returns unique name of this Document Field Type. The name should be something that is easy to bind to in the code, such as BOOLEAN.

Returns:

unique name of this document field type

setName

void setName(java.lang.String name)
             throws UnauthorizedException

Sets the unique name of this document field type. The name should be something that is easy to bind to in the code, such as BOOLEAN.

Parameters:

name - name to change the document field type too.

Throws:

UnauthorizedException - thrown if the user does not have proper permissions to modify this document field type, or if this document field type is not modifiable.

getDisplayName

java.lang.String getDisplayName()

Returns a display friendly name that can be shown in the UI. This name must also be unique.

Returns:

display friendly name that can be shown in the UI.

getDescription

java.lang.String getDescription()

Returns the description of this document field type

Returns:

the description of this document field type

setDescription

void setDescription(java.lang.String description)
                    throws UnauthorizedException

Sets the description for this document field type

Parameters:

description - the description for this document field type

Throws:

UnauthorizedException - thrown if the user does not have proper permissions to modify this document field type, or if this document field type is not modifiable.

setDisplayName

void setDisplayName(java.lang.String displayName)
                    throws UnauthorizedException

Sets the display friend name for this document field type. This name must be unique.

Parameters:

displayName - display friendly name

Throws:

UnauthorizedException - thrown if the user does not have proper permissions to modify this document field type, or if this document field type is not modifiable.

getValidator

DocumentFieldValidator getValidator()

Returns the validator for the document field.

Returns:

the DocumentFieldValidator for the document field type.

setValidator

void setValidator(DocumentFieldValidator validator)
                  throws UnauthorizedException

Sets the validator for the document field type.

Parameters:

validator - the validator for the document field type.

Throws:

UnauthorizedException - if not an administrator, or if this document field type is not modifiable.

getFormatter

DocumentFieldFormatter getFormatter()

Returns the formatter for this document field type.

Returns:

the DocumentFieldFormmmater for this document field type.

setFormatter

void setFormatter(DocumentFieldFormatter documentFieldFormatter)
                  throws UnauthorizedException

Sets the formatter for this document field type.

Parameters:

documentFieldFormatter - formatter for this document field type

Throws:

UnauthorizedException - if not an administrator, or if this document field type is not modifiable.

getDataType

DocumentFieldType.DataType getDataType()

Returns the XMPP data form type that this object is.

Returns:

the XMPP data form type that this object is.

setDataType

void setDataType(DocumentFieldType.DataType dataType)
                 throws UnauthorizedException

Sets the XMPP data form type for this document field type.

Parameters:

dataType - XMPP data form type

Throws:

UnauthorizedException - thrown if the user does not have proper permissions to modify this document field type, or if this document field type is not modifiable.

isModifiable

boolean isModifiable()

Whether or not the admin tool should allow this document field to be modified or deleted.

Returns:

true if this document field type can be modified or deleted.