Interface BrokerProcessorForm

All Superinterfaces:

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

public interface BrokerProcessorForm
extends OsidProcessorForm

This is the form for creating and updating BrokerProcessors. Like all OsidForms, various data elements may be set here for use in the create and update methods in the BrokerProcessorAdminSession. 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	clearAllowsCompoundRequests()	Removes the allows compound requests flag.
void	clearAllowsProvisionExchange()	Removes the allows provision exchange flag.
void	clearFixedLeaseDuration()	Removes the fixed lease duration.
void	clearLeasing()	Removes the fixed lease flag.
void	clearMustReturnProvisions()	Removes the must return provisions flag.
Metadata	getAllowsCompoundRequestsMetadata()	Gets the metadata for the allows provision exchange flag.
Metadata	getAllowsProvisionExchangeMetadata()	Gets the metadata for the allows provision exchange flag.
BrokerProcessorFormRecord	getBrokerProcessorFormRecord(Type brokerProcessorRecordType)	Gets the BrokerProcessorFormRecord corresponding to the given broker processor record Type.
Metadata	getFixedLeaseDurationMetadata()	Gets the metadata for the fixed lease duration.
Metadata	getLeasingMetadata()	Gets the metadata for the leasing flag.
Metadata	getMustReturnProvisionsMetadata()	Gets the metadata for the must return provisions flag.
void	setAllowsCompoundRequests(boolean allowsCompound)	Sets the allows compound requests flag.
void	setAllowsProvisionExchange(boolean allowsExchange)	Sets the allows provision exchange flag.
void	setFixedLeaseDuration(boolean duration)	Sets the fixed lease duration.
void	setLeasing(boolean leasing)	Sets the leasing flag.
void	setMustReturnProvisions(boolean mustReturn)	Sets the must return provisions flag.

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

getLeasingMetadata

Metadata getLeasingMetadata()

Gets the metadata for the leasing flag.

Returns:

metadata for the leasing flag

Compliance:

mandatory - This method must be implemented.

setLeasing

void setLeasing(boolean leasing)

Sets the leasing flag.

Parameters:

leasing - the new leasing flag

Throws:

InvalidArgumentException - leasing is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearLeasing

void clearLeasing()

Removes the fixed lease flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getFixedLeaseDurationMetadata

Metadata getFixedLeaseDurationMetadata()

Gets the metadata for the fixed lease duration.

Returns:

metadata for the fixed lease duration

Compliance:

mandatory - This method must be implemented.

setFixedLeaseDuration

void setFixedLeaseDuration(boolean duration)

Sets the fixed lease duration.

Parameters:

duration - the new fixed lease duration.

Throws:

InvalidArgumentException - duration is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - duration is null

Compliance:

mandatory - This method must be implemented.

clearFixedLeaseDuration

void clearFixedLeaseDuration()

Removes the fixed lease duration.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getMustReturnProvisionsMetadata

Metadata getMustReturnProvisionsMetadata()

Gets the metadata for the must return provisions flag.

Returns:

metadata for the must return flag

Compliance:

mandatory - This method must be implemented.

setMustReturnProvisions

void setMustReturnProvisions(boolean mustReturn)

Sets the must return provisions flag.

Parameters:

mustReturn - the new must return provisions flag

Throws:

InvalidArgumentException - mustReturn is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearMustReturnProvisions

void clearMustReturnProvisions()

Removes the must return provisions flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAllowsProvisionExchangeMetadata

Metadata getAllowsProvisionExchangeMetadata()

Gets the metadata for the allows provision exchange flag.

Returns:

metadata for th eallows provision exchange flag

Compliance:

mandatory - This method must be implemented.

setAllowsProvisionExchange

void setAllowsProvisionExchange(boolean allowsExchange)

Sets the allows provision exchange flag.

Parameters:

allowsExchange - the new allows provision exchange flag

Throws:

InvalidArgumentException - allowsExchange is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllowsProvisionExchange

void clearAllowsProvisionExchange()

Removes the allows provision exchange flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAllowsCompoundRequestsMetadata

Metadata getAllowsCompoundRequestsMetadata()

Gets the metadata for the allows provision exchange flag.

Returns:

metadata for th eallows provision exchange flag

Compliance:

mandatory - This method must be implemented.

setAllowsCompoundRequests

void setAllowsCompoundRequests(boolean allowsCompound)

Sets the allows compound requests flag.

Parameters:

allowsCompound - the new allows compound requests flag

Throws:

InvalidArgumentException - allowsExchange is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllowsCompoundRequests

void clearAllowsCompoundRequests()

Removes the allows compound requests flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getBrokerProcessorFormRecord

BrokerProcessorFormRecord getBrokerProcessorFormRecord(Type brokerProcessorRecordType)
                                                throws OperationFailedException

Gets the BrokerProcessorFormRecord corresponding to the given broker processor record Type.

Parameters:

brokerProcessorRecordType - a broker processor record type

Returns:

the broker processor form record

Throws:

NullArgumentException - brokerProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.