Interface | osid.offering.rules.OfferingConstrainerForm | ||
---|---|---|---|
Implements | osid.OsidConstrainerForm | ||
Description |
This is the form for creating and updating | ||
Method | getOverrideDescriptionMetadata | ||
Description |
Gets the metadata for the override description flag. | ||
Return | osid.Metadata | metadata for the override description flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideDescription | ||
Description |
Sets the overrride description flag. | ||
Parameters | boolean | overrideDescription | the override description flag |
Errors | INVALID_ARGUMENT | overrideDescription is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearOverrideDescription | ||
Description |
Clears the override description flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOverrideTitleMetadata | ||
Description |
Gets the metadata for the override title flag. | ||
Return | osid.Metadata | metadata for the override title flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideTitle | ||
Description |
Sets the overrride title flag. | ||
Parameters | boolean | overrideTitle | the override title flag |
Errors | INVALID_ARGUMENT | overrideTitlen is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearOverrideTitle | ||
Description |
Clears the override title flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOverrideCodeMetadata | ||
Description |
Gets the metadata for the override code flag. | ||
Return | osid.Metadata | metadata for the override code flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideCode | ||
Description |
Sets the overrride code flag. | ||
Parameters | boolean | overrideCode | the override code flag |
Errors | INVALID_ARGUMENT | overrideCode is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearOverrideCode | ||
Description |
Clears the override time periods flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOverrideTimePeriodsMetadata | ||
Description |
Gets the metadata for the override time periods flag. | ||
Return | osid.Metadata | metadata for the override time periods flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideTimePeriods | ||
Description |
Sets the overrride time periods flag. | ||
Parameters | boolean | overrideTimePeriods | the override time periods flag |
Errors | INVALID_ARGUMENT | overrideTimePeriods is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearOverrideTimePeriods | ||
Description |
Clears the override time periods flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConstrainTimePeriodsMetadata | ||
Description |
Gets the metadata for the constrain time periods flag. | ||
Return | osid.Metadata | metadata for the constrain time periods flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setConstrainTimePeriods | ||
Description |
Sets the constrain time periods flag. | ||
Parameters | boolean | constrainTimePeriods | the constrain time periods flag |
Errors | INVALID_ARGUMENT | constrainTimePeriods is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearConstrainTimePeriods | ||
Description |
Clears the constrain time periods flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOverrideResultOptionsMetadata | ||
Description |
Gets the metadata for the override result options flag. | ||
Return | osid.Metadata | metadata for the override result options flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideResultOptions | ||
Description |
Sets the overrride result options flag. | ||
Parameters | boolean | overrideResultOptions | the override result options flag |
Errors | INVALID_ARGUMENT | overrideResultOptions is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearResultOptions | ||
Description |
Clears the override result options flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConstrainResultOptionsMetadata | ||
Description |
Gets the metadata for the constrain result options flag. | ||
Return | osid.Metadata | metadata for the constrain result options flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setConstrainResultOptions | ||
Description |
Sets the constrain result options flag. | ||
Parameters | boolean | constrainResultOptions | the constrain result options flag |
Errors | INVALID_ARGUMENT | constrainResultOptions is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearConstrainResultOptions | ||
Description |
Clears the constrain result options flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOverrideSponsorsMetadata | ||
Description |
Gets the metadata for the override sponsors flag. | ||
Return | osid.Metadata | metadata for the override sponsors flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setOverrideSponsors | ||
Description |
Sets the overrride sponsors flag. | ||
Parameters | boolean | overrideSponsors | the override sponsors flag |
Errors | INVALID_ARGUMENT | overrideSponsors is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearSponsors | ||
Description |
Clears the override sponsors flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getConstrainSponsorsMetadata | ||
Description |
Gets the metadata for the constrain sponsors flag. | ||
Return | osid.Metadata | metadata for the constrain sponsors flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setConstrainSponsors | ||
Description |
Sets the constrain sponsors flag. | ||
Parameters | boolean | constrainSponsors | the constrain sponsors flag |
Errors | INVALID_ARGUMENT | constrainSponsors is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearConstrainSponsors | ||
Description |
Clears the constrain sponsors flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly()
is true | |
Compliance | mandatory | This method must be implemented. | |
Method | getOfferingConstrainerFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | offeringConstrainerRecordType | an offering constrainer record type |
Return | osid.offering.rules.records.OfferingConstrainerFormRecord | the offering constrainer form record | |
Errors | NULL_ARGUMENT | offeringConstrainerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(offeringConstrainerRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |