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

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

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.