OSID Logo
OSID Specifications
provisioning rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.rules.PoolProcessorForm
Implementsosid.OsidProcessorForm
Description

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.

MethodgetAllocatesByLeastUseMetadata
Description

Gets the metadata for the allocates by least use flag.

Returnosid.Metadatametadata for the allocation flag
CompliancemandatoryThis method must be implemented.
MethodsetAllocatesByLeastUse
Description

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

ParametersbooleanallocateByLeastUse true to allocate by least use, false otherwise
ErrorsINVALID_ARGUMENT allocateByLeastUse is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAllocateByLeastUse
Description

Removes the allocate by least use flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAllocatesByMostUseMetadata
Description

Gets the metadata for the allocates by most use flag.

Returnosid.Metadatametadata for the allocation flag
CompliancemandatoryThis method must be implemented.
MethodsetAllocatesByMostUse
Description

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

ParametersbooleanallocateByMostUse true to allocate by most use, false otherwise
ErrorsINVALID_ARGUMENT allocateByMostUse is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAllocateByMostUse
Description

Removes the allocate by most use flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAllocatesByLeastCostMetadata
Description

Gets the metadata for the allocates by least cost flag.

Returnosid.Metadatametadata for the allocation flag
CompliancemandatoryThis method must be implemented.
MethodsetAllocatesByLeastCost
Description

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

ParametersbooleanallocateByLeastCost true to allocate by least cost, false otherwise
ErrorsINVALID_ARGUMENT allocateByLeastCost is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAllocateByLeastCost
Description

Removes the allocate by least cost flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetAllocatesByMostCostMetadata
Description

Gets the metadata for the allocates by most cost flag.

Returnosid.Metadatametadata for the allocation flag
CompliancemandatoryThis method must be implemented.
MethodsetAllocatesByMostCost
Description

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

ParametersbooleanallocateByMostCost true to allocate by most cost, false otherwise
ErrorsINVALID_ARGUMENT allocateByMostCost is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearAllocateByMostCost
Description

Removes the allocate by most cost flag.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetPoolProcessorFormRecord
Description

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

Parametersosid.type.TypepoolProcessorRecordTypea pool processor record type
Returnosid.provisioning.rules.records.PoolProcessorFormRecordthe pool processor form record
ErrorsNULL_ARGUMENT poolProcessorRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(poolProcessorRecordType) is false
CompliancemandatoryThis method must be implemented.