Interface QueueConstrainerForm

All Superinterfaces:

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

public interface QueueConstrainerForm
extends OsidConstrainerForm

This is the form for creating and updating QueueConstrainers. Like all OsidForms, various data elements may be set here for use in the create and update methods in the QueueConstrainerAdminSession. 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
void	clearRequiredProvisionPools()	Clears the required provision pools.
void	clearRequiresProvisions()	Removes the requires provisions flag.
void	clearSizeLimit()	Removes the size limit.
QueueConstrainerFormRecord	getQueueConstrainerFormRecord(Type queueConstrainerRecordType)	Gets the QueueConstrainerFormRecord corresponding to the given queue constrainer record Type.
Metadata	getRequiredProvisionPoolsMetadata()	Gets the metadata for the required pools.
Metadata	getRequiresProvisionsMetadata()	Gets the metadata for the requires provisions flag.
Metadata	getSizeLimitMetadata()	Gets the metadata for the size limit.
void	setRequiredProvisionPools(Id[] poolIds)	Sets the required provision pools.
void	setRequiresProvisions(long requiresProvisions)	Sets the requires provisions flag.
void	setSizeLimit(long limit)	Sets the size limit.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm.

Methods inherited from interface OsidForm

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

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

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

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getSizeLimitMetadata

Metadata getSizeLimitMetadata()

Gets the metadata for the size limit.

Returns:

metadata for the size limit

Compliance:

mandatory - This method must be implemented.

setSizeLimit

void setSizeLimit(long limit)

Sets the size limit.

Parameters:

limit - the new limit

Throws:

InvalidArgumentException - limit is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearSizeLimit

void clearSizeLimit()

Removes the size limit.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRequiresProvisionsMetadata

Metadata getRequiresProvisionsMetadata()

Gets the metadata for the requires provisions flag.

Returns:

metadata for the requires provisions flag

Compliance:

mandatory - This method must be implemented.

setRequiresProvisions

void setRequiresProvisions(long requiresProvisions)

Sets the requires provisions flag.

Parameters:

requiresProvisions - the new requires provisions

Throws:

InvalidArgumentException - requiresProvisions is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearRequiresProvisions

void clearRequiresProvisions()

Removes the requires provisions flag.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getRequiredProvisionPoolsMetadata

Metadata getRequiredProvisionPoolsMetadata()

Gets the metadata for the required pools.

Returns:

metadata for the required pools

Compliance:

mandatory - This method must be implemented.

setRequiredProvisionPools

void setRequiredProvisionPools(Id[] poolIds)

Sets the required provision pools.

Parameters:

poolIds - the new pools

Throws:

InvalidArgumentException - poolIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - poolIds is null

Compliance:

mandatory - This method must be implemented.

clearRequiredProvisionPools

void clearRequiredProvisionPools()

Clears the required provision pools.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerFormRecord

QueueConstrainerFormRecord getQueueConstrainerFormRecord(Type queueConstrainerRecordType)
                                                  throws OperationFailedException

Gets the QueueConstrainerFormRecord corresponding to the given queue constrainer record Type.

Parameters:

queueConstrainerRecordType - a queue constrainer record type

Returns:

the queue constrainer form record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.