OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.SubscriptionForm
Implementsosid.OsidRelationshipForm
Description

This is the form for creating and updating Subscription objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the SubscriptionAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetAddressMetadata
Description

Gets the metadata for an address.

Returnosid.Metadatametadata for the address
CompliancemandatoryThis method must be implemented.
MethodsetAddress
Description

Sets the address.

Parametersosid.id.IdaddressIdthe new address
ErrorsINVALID_ARGUMENT addressId is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT addressId is null
CompliancemandatoryThis method must be implemented.
MethodclearAddress
Description

Clears the address.

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

Gets the SubscriptionFormRecord corresponding to the given subscription record Type.

Parametersosid.type.TypesubscriptionRecordTypethe subscription record type
Returnosid.subscription.records.SubscriptionFormRecordthe subscription form record
ErrorsNULL_ARGUMENT subscriptionRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(subscriptionRecordType) is false
CompliancemandatoryThis method must be implemented.