|
Clearspace API (1.7.0) Core Javadocs | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||
| Packages that use DocumentField | |
|---|---|
| com.jivesoftware.community | Core interfaces and classes for Clearspace. |
| Uses of DocumentField in com.jivesoftware.community |
|---|
| Subinterfaces of DocumentField in com.jivesoftware.community | |
|---|---|
interface |
MultiOptionDocumentField
An extension of the document field interface to support multi optioned field types such as radio and selection lists. |
| Methods in com.jivesoftware.community that return DocumentField | |
|---|---|
DocumentField |
DocumentFieldManager.createDocumentField(java.lang.String name,
java.lang.String displayName,
java.lang.String description,
DocumentFieldType documentFieldType)
Creates a new document field. |
DocumentField |
DocumentResultFilter.getDocumentField(int index)
Returns the document field at the specified index in the list of document fields to be filtered on. |
DocumentField |
DocumentFieldManager.getDocumentField(long id)
Returns the document field with the given id. |
DocumentField |
DocumentFieldManager.getDocumentField(java.lang.String name)
Returns the document field with the given name. |
DocumentField |
DocumentResultFilter.getSortDocumentField()
Returns the document field that will be sorted on. |
| Methods in com.jivesoftware.community that return types with arguments of type DocumentField | |
|---|---|
java.util.Collection<DocumentField> |
DocumentFieldManager.getDocumentFields()
Returns an collection of DocumentField objects that list all the current document fields. |
java.util.Map<DocumentField,java.lang.String> |
DocumentTypeValidator.validate(java.util.Map<java.lang.String,?> fieldValueMap,
User user)
Performs cross field validation on user supplied input. |
| Methods in com.jivesoftware.community with parameters of type DocumentField | |
|---|---|
void |
DocumentResultFilter.addDocumentField(DocumentField field,
long optionID)
Adds a document field option to the list of options that will be filtered upon |
void |
DocumentType.addDocumentFieldElement(DocumentField documentField)
Adds a DocumentField to this DocumentTypeSectionElement as an element. |
void |
DocumentTypeSectionElement.addDocumentFieldElement(DocumentField documentField)
Adds a DocumentField to this DocumentTypeSectionElement as an element. |
void |
DocumentFieldManager.deleteDocumentField(DocumentField field)
Deletes a document field. |
DocumentFieldValue |
Document.getDocumentFieldValue(DocumentField field)
Returns the value of the document field as a DocumentFieldValue object. |
DocumentFieldValue |
Document.getUnfilteredDocumentFieldValue(DocumentField field)
Returns the value of the document field bypassing any active filters. |
void |
Document.setDocumentFieldValue(DocumentField field,
DocumentFieldValue value)
Sets the value of the document field. |
void |
DocumentResultFilter.setSortDocumentField(DocumentField field)
Sets the document field to sort on. |
|
Clearspace Project Page | |||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||||