org.osid.resourcing.rules

Interface JobConstrainerForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidConstrainerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface JobConstrainerForm
extends OsidConstrainerForm

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

Method Summary

Methods

Modifier and Type	Method and Description
JobConstrainerFormRecord	getJobConstrainerFormRecord(Type jobConstrainerRecordType) Gets the JobConstrainerFormRecord corresponding to the given job constrainer record Type.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Method Detail

getJobConstrainerFormRecord

JobConstrainerFormRecord getJobConstrainerFormRecord(Type jobConstrainerRecordType)
                                                     throws OperationFailedException

Gets the JobConstrainerFormRecord corresponding to the given job constrainer record Type.

Parameters:

jobConstrainerRecordType - a job constrainer record type

Returns:

the job constrainer form record

Throws:

NullArgumentException - jobConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.