blackboard.cms.metadata
Interface CSFormManager

All Superinterfaces:

blackboard.platform.forms.service.FormManager

public interface CSFormManager
extends blackboard.platform.forms.service.FormManager

FormManager

Since:

Bb 7.2

Version:

Jan 18, 2006 1:49:30 PM

Method Summary

void	associateFormWithEntities(blackboard.persist.Id formId, java.util.List<java.lang.String> entityIds) Creates an association between a Form and OperatingUnits; this Form will only be available to the given OU's.
void	copyHeavyForm(blackboard.platform.forms.Form form, java.lang.String newTitle, java.lang.String newHeader, java.lang.String newIntegrationKey) Copy the form (using FormUtil's copyHeavyForm behind the scenes), but also copy the FormUnitAssociations for this form
void	copyHeavyForm(blackboard.platform.forms.Form form, java.lang.String newTitle, java.lang.String newHeader, java.lang.String newIntegrationKey, java.sql.Connection con) Copy the form (using FormUtil's copyHeavyForm behind the scenes), but also copy the FormUnitAssociations for this form using the connection provided
void	disassociateFormFromEntities(blackboard.persist.Id formId) Removes any associations between this Form and any OperatingUnits.
boolean	hasMetadataEntries(com.xythos.storageServer.api.FileSystemEntry fse) Identifies whether there is any metadata associated with provided entry.
java.util.List<com.xythos.storageServer.api.FileSystemEntry>	loadAssociatedEntities(blackboard.persist.Id formId) Loads associated FileSystemEntry objects attached to the provided form.
java.util.List<blackboard.platform.forms.Form>	loadAvailableFormsByEntityDataType(blackboard.persist.DataType entityDataType) Loads all available Forms for a given EntityType and OperatingUnit, usage is when creating an object from within an OperatingUnit context.
java.util.List<blackboard.platform.forms.Form>	loadAvailableFormsByEntityId(java.lang.String entityId) Loads all available Forms for a given EntityType and OperatingUnit, usage is when creating an object from within an OperatingUnit context.
int	loadFormEditableObjectsCount(blackboard.persist.Id formId) Provides count of associations to the provided form.

Methods inherited from interface blackboard.platform.forms.service.FormManager

copyForm, copyForm, loadAllForms, loadAvailableForms, loadFormById, loadFormByIntegrationKey, persistForm, populateDefaultForm, removeForm

Method Detail

copyHeavyForm

void copyHeavyForm(blackboard.platform.forms.Form form,
                   java.lang.String newTitle,
                   java.lang.String newHeader,
                   java.lang.String newIntegrationKey,
                   java.sql.Connection con)
                   throws java.lang.Exception

Copy the form (using FormUtil's copyHeavyForm behind the scenes), but also copy the FormUnitAssociations for this form using the connection provided

Parameters:

form -

newTitle -

newIntegrationKey -

con -

Throws:

java.lang.Exception

copyHeavyForm

void copyHeavyForm(blackboard.platform.forms.Form form,
                   java.lang.String newTitle,
                   java.lang.String newHeader,
                   java.lang.String newIntegrationKey)
                   throws java.lang.Exception

Copy the form (using FormUtil's copyHeavyForm behind the scenes), but also copy the FormUnitAssociations for this form

Parameters:

form -

newTitle -

newIntegrationKey -

Throws:

java.lang.Exception

loadAvailableFormsByEntityDataType

java.util.List<blackboard.platform.forms.Form> loadAvailableFormsByEntityDataType(blackboard.persist.DataType entityDataType)
                                                                                  throws blackboard.persist.PersistenceException,
                                                                                         blackboard.persist.KeyNotFoundException

Loads all available Forms for a given EntityType and OperatingUnit, usage is when creating an object from within an OperatingUnit context. IMPORTANT: this will check the security entitlements of the user in the context, and only load forms that they are entitled to see.

Parameters:

ouId -

entityKey -

Returns:

Throws:

blackboard.persist.PersistenceException

blackboard.persist.KeyNotFoundException

loadAvailableFormsByEntityId

java.util.List<blackboard.platform.forms.Form> loadAvailableFormsByEntityId(java.lang.String entityId)
                                                                            throws blackboard.persist.PersistenceException,
                                                                                   blackboard.persist.KeyNotFoundException

Loads all available Forms for a given EntityType and OperatingUnit, usage is when creating an object from within an OperatingUnit context. IMPORTANT: this will check the security entitlements of the user in the context, and only load forms that they are entitled to see.

Parameters:

ouId -

entityKey -

Returns:

Throws:

blackboard.persist.PersistenceException

blackboard.persist.KeyNotFoundException

associateFormWithEntities

void associateFormWithEntities(blackboard.persist.Id formId,
                               java.util.List<java.lang.String> entityIds)
                               throws blackboard.persist.PersistenceException,
                                      blackboard.data.ValidationException

Creates an association between a Form and OperatingUnits; this Form will only be available to the given OU's. Usage: used on Set Availability pages.

Parameters:

formId -

unitIds -

Throws:

blackboard.persist.PersistenceException

blackboard.data.ValidationException

loadAssociatedEntities

java.util.List<com.xythos.storageServer.api.FileSystemEntry> loadAssociatedEntities(blackboard.persist.Id formId)
                                                                                    throws blackboard.persist.PersistenceException

Loads associated FileSystemEntry objects attached to the provided form.

Parameters:

formId -

Returns:

Throws:

blackboard.persist.PersistenceException

loadFormEditableObjectsCount

int loadFormEditableObjectsCount(blackboard.persist.Id formId)
                                 throws blackboard.persist.PersistenceException

Provides count of associations to the provided form.

Parameters:

formId -

Returns:

Throws:

blackboard.persist.PersistenceException

hasMetadataEntries

boolean hasMetadataEntries(com.xythos.storageServer.api.FileSystemEntry fse)
                           throws blackboard.persist.KeyNotFoundException,
                                  blackboard.persist.PersistenceException

Identifies whether there is any metadata associated with provided entry.

Parameters:

fse -

Returns:

Throws:

blackboard.persist.KeyNotFoundException

blackboard.persist.PersistenceException

disassociateFormFromEntities

void disassociateFormFromEntities(blackboard.persist.Id formId)
                                  throws blackboard.persist.KeyNotFoundException,
                                         blackboard.persist.PersistenceException

Removes any associations between this Form and any OperatingUnits. Usage: should be called on Set Availability pages immediately before calling associateFormWithUnits. (If the UI is a select box/multiselect picker you must make sure that ONLY the currently selected OU's are associated with the Form.)

Parameters:

formId -

Throws:

blackboard.persist.KeyNotFoundException

blackboard.persist.PersistenceException