org.osid.provisioning.rules

Interface PoolProcessorForm

All Superinterfaces:

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

public interface PoolProcessorForm
extends OsidProcessorForm

This is the form for creating and updating PoolProcessors. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the PoolProcessorAdminSession. 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	clearAllocateByLeastCost() Removes the allocate by least cost flag.
void	clearAllocateByLeastUse() Removes the allocate by least use flag.
void	clearAllocateByMostCost() Removes the allocate by most cost flag.
void	clearAllocateByMostUse() Removes the allocate by most use flag.
Metadata	getAllocatesByLeastCostMetadata() Gets the metadata for the allocates by least cost flag.
Metadata	getAllocatesByLeastUseMetadata() Gets the metadata for the allocates by least use flag.
Metadata	getAllocatesByMostCostMetadata() Gets the metadata for the allocates by most cost flag.
Metadata	getAllocatesByMostUseMetadata() Gets the metadata for the allocates by most use flag.
PoolProcessorFormRecord	getPoolProcessorFormRecord(Type poolProcessorRecordType) Gets the PoolProcessorFormRecord corresponding to the given pool processor record Type.
void	setAllocatesByLeastCost(boolean allocateByLeastCost) Sets allocates by least cost flag.
void	setAllocatesByLeastUse(boolean allocateByLeastUse) Sets allocates by least use flag.
void	setAllocatesByMostCost(boolean allocateByMostCost) Sets allocates by most cost flag.
void	setAllocatesByMostUse(boolean allocateByMostUse) Sets allocates by most use 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

getAllocatesByLeastUseMetadata

Metadata getAllocatesByLeastUseMetadata()

Gets the metadata for the allocates by least use flag.

Returns:

metadata for the allocation flag

Compliance:

mandatory - This method must be implemented.

setAllocatesByLeastUse

void setAllocatesByLeastUse(boolean allocateByLeastUse)

Sets allocates by least use flag. Seeting this allocation rule may disable the other allocation rules.

Parameters:

allocateByLeastUse - true to allocate by least use, false otherwise

Throws:

InvalidArgumentException - allocateByLeastUse is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllocateByLeastUse

void clearAllocateByLeastUse()

Removes the allocate by least use flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAllocatesByMostUseMetadata

Metadata getAllocatesByMostUseMetadata()

Gets the metadata for the allocates by most use flag.

Returns:

metadata for the allocation flag

Compliance:

mandatory - This method must be implemented.

setAllocatesByMostUse

void setAllocatesByMostUse(boolean allocateByMostUse)

Sets allocates by most use flag. Seeting this allocation rule may disable the other allocation rules.

Parameters:

allocateByMostUse - true to allocate by most use, false otherwise

Throws:

InvalidArgumentException - allocateByMostUse is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllocateByMostUse

void clearAllocateByMostUse()

Removes the allocate by most use flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAllocatesByLeastCostMetadata

Metadata getAllocatesByLeastCostMetadata()

Gets the metadata for the allocates by least cost flag.

Returns:

metadata for the allocation flag

Compliance:

mandatory - This method must be implemented.

setAllocatesByLeastCost

void setAllocatesByLeastCost(boolean allocateByLeastCost)

Sets allocates by least cost flag. Seeting this allocation rule may disable the other allocation rules.

Parameters:

allocateByLeastCost - true to allocate by least cost, false otherwise

Throws:

InvalidArgumentException - allocateByLeastCost is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllocateByLeastCost

void clearAllocateByLeastCost()

Removes the allocate by least cost flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getAllocatesByMostCostMetadata

Metadata getAllocatesByMostCostMetadata()

Gets the metadata for the allocates by most cost flag.

Returns:

metadata for the allocation flag

Compliance:

mandatory - This method must be implemented.

setAllocatesByMostCost

void setAllocatesByMostCost(boolean allocateByMostCost)

Sets allocates by most cost flag. Seeting this allocation rule may disable the other allocation rules.

Parameters:

allocateByMostCost - true to allocate by most cost, false otherwise

Throws:

InvalidArgumentException - allocateByMostCost is invalid

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearAllocateByMostCost

void clearAllocateByMostCost()

Removes the allocate by most cost flag.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getPoolProcessorFormRecord

PoolProcessorFormRecord getPoolProcessorFormRecord(Type poolProcessorRecordType)
                                                   throws OperationFailedException

Gets the PoolProcessorFormRecord corresponding to the given pool processor record Type.

Parameters:

poolProcessorRecordType - a pool processor record type

Returns:

the pool processor form record

Throws:

NullArgumentException - poolProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.