org.osid.provisioning.rules

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 OsidForm objects, 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

Methods

Modifier and Type	Method and 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 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

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.