com.jivesoftware.community
Interface DocumentTypeSectionElement

All Superinterfaces:

DocumentTypeElement, JiveObject

public interface DocumentTypeSectionElement
extends DocumentTypeElement

Used to specify a Section of Elements in the Document creation process.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jivesoftware.community.DocumentTypeElement

DocumentTypeElement.Type

Method Summary

DocumentTypeElement	addBuiltInElement(DocumentTypeElement.Type type) Used to create and add a new built-in type element to this DocumentTypeSectionElement.
void	addDocumentFieldElement(DocumentField documentField) Adds a DocumentField to this DocumentTypeSectionElement as an element.
DocumentTypeLabelElement	addLabelElement(String value) Used to create and add a new Label Element to this DocumentTypeSectionElement
void	deleteDocumentElement(DocumentTypeElement element) Removes the specified DocumentTypeElement from this DocumentType
List<DocumentTypeElement>	getDocumentElements() Returns a list of all the Document Elements associated with this DocumentSection
void	setDocumentElementIndex(DocumentTypeElement element, int index) Sets the index where the specified DocumentTypeElement should appear

Methods inherited from interface com.jivesoftware.community.DocumentTypeElement

getType

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Method Detail

getDocumentElements

List<DocumentTypeElement> getDocumentElements()

Returns a list of all the Document Elements associated with this DocumentSection

Returns:

list of all the Document Elements associated with this DocumentSection

setDocumentElementIndex

void setDocumentElementIndex(DocumentTypeElement element,
                             int index)
                             throws UnauthorizedException

Sets the index where the specified DocumentTypeElement should appear

Parameters:

element - DocumentTypeElement Element in the DocumentType to move

index - index index to move the element too

Throws:

UnauthorizedException - If the user is not an administrator

IllegalArgumentException - if the element is not part of this DocumentType

deleteDocumentElement

void deleteDocumentElement(DocumentTypeElement element)
                           throws UnauthorizedException

Removes the specified DocumentTypeElement from this DocumentType

Parameters:

element - the DocumentTypeElement to remove

Throws:

UnauthorizedException - if the user is not an Administrator

IllegalArgumentException - if the specified element does not belong to this document type

addLabelElement

DocumentTypeLabelElement addLabelElement(String value)

Used to create and add a new Label Element to this DocumentTypeSectionElement

Parameters:

value - string value for the label element

Returns:

the created label element

addBuiltInElement

DocumentTypeElement addBuiltInElement(DocumentTypeElement.Type type)

Used to create and add a new built-in type element to this DocumentTypeSectionElement.

Parameters:

type - built-in type (type.isBuiltIn() must return true)

Returns:

the created built-in type element

addDocumentFieldElement

void addDocumentFieldElement(DocumentField documentField)

Adds a DocumentField to this DocumentTypeSectionElement as an element.

Parameters:

documentField - the document field to add