Interface RelevancyEnablerForm

All Superinterfaces:

OsidRecord

public interface RelevancyEnablerForm
extends OsidRecord

This is the form for creating and updating RelevancyEnablers. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the RelevancyEnablerAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
RelevancyEnablerFormRecord	getRelevancyEnablerFormRecord(Type relevancyEnablerRecordType)	Gets the RelevancyEnablerFormRecord corresponding to the given relevancy enabler record Type.

Methods inherited from interface OsidRecord

implementsRecordType

Modifier and Type	Method	Description
boolean	implementsRecordType(Type recordType)	Tests if the given type is implemented by this record.

Method Details

getRelevancyEnablerFormRecord

RelevancyEnablerFormRecord getRelevancyEnablerFormRecord(Type relevancyEnablerRecordType)
                                                  throws OperationFailedException

Gets the RelevancyEnablerFormRecord corresponding to the given relevancy enabler record Type.

Parameters:

relevancyEnablerRecordType - a relevancy enabler record type

Returns:

the relevancy enabler form record

Throws:

NullArgumentException - relevancyEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(relevancyEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.