OSID - osid.offering.OfferingAdminSession Service Interface Definition

Interface	osid.offering.OfferingAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.offering.batch.OfferingBatchAdminSession`
Used By	`osid.offering.OfferingManager`
Used By	`osid.offering.OfferingProxyManager`
Description	This session creates, updates, and deletes `Offerings`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create an `Offering`, an `OfferingForm` is requested using `getOfferingFormForCreate()` specifying the desired canonical unit, time period, and record `Types` or none if no record `Types` are needed. The returned `OfferingForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `OfferingForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `OfferingForm` corresponds to an attempted transaction. For updates, `OfferingForms` are requested to the `Offering` `Id` that is to be updated using `getOfferingFormForUpdate()`. Similarly, the `OfferingForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `OfferingForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Offerings`. To unmap an `Offering` from the current `Catalogue`, the `OfferingCatalogueAssignmentSession` should be used. These delete operations attempt to remove the `Offering` itself thus removing it from all known `Catalogue` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOfferings
Description	Tests if this user can create offerings. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Offering` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer create operations to unauthorized users.
Return	`boolean`		`false` if `Offering` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateOfferingWithRecordTypes
Description	Tests if this user can create a single `Offering` using the desired record types. While `OfferingManager.getOfferingRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Offering`. Providing an empty array tests if an `Offering` can be created with no records.
Parameters	`osid.type.Type[]`	`offeringRecordTypes`	array of offering record types
Return	`boolean`		`true` if `Offering` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`offeringRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingFormForCreate
Description	Gets the offering form for creating new offerings. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`canonicalUnitId`	the canonical unit `Id`
	`osid.id.Id`	`timePeriodId`	the time period `Id`
	`osid.type.Type[]`	`offeringRecordTypes`	array of offering record types to be included in the create operation or an empty list if none
Return	`osid.offering.OfferingForm`		the offering form
Errors	NOT_FOUND		`canonicalUnitId` or `timePeriodId` is not found
	NULL_ARGUMENT		`canonicalUnitId, timePeriodId`, or `offeringRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		cannot get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createOffering
Description	Creates a new `Offering`.
Parameters	`osid.offering.OfferingForm`	`offeringForm`	the form for this `Offering`
Return	`osid.offering.Offering`		the new `Offering`
Errors	ILLEGAL_STATE		`offeringForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`offeringForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringForm` did not originate from `getOfferingFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateOfferings
Description	Tests if this user can update offerings. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Offering` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer update operations to unauthorized users.
Return	`boolean`		`false` if `Offering` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingFormForUpdate
Description	Gets the offering form for updating an existing offering. A new offering form should be requested for each update transaction.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of the `Offering`
Return	`osid.offering.OfferingForm`		the offering form
Errors	NOT_FOUND		`offeringId` is not found
	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateOffering
Description	Updates an existing offering.
Parameters	`osid.offering.OfferingForm`	`offeringForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`offeringForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`offeringForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`offeringForm` did not originate from `getOfferingFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteOfferings
Description	Tests if this user can delete offerings. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Offering` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may not wish to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Offering` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteOffering
Description	Deletes an `Offering`.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of the `Offering` to remove
Errors	NOT_FOUND		`offeringId` not found
	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageOfferingAliases
Description	Tests if this user can manage `Id` aliases for `Offerings`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Offering` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasOffering
Description	Adds an `Id` to an `Offering` for the purpose of creating compatibility. The primary `Id` of the `Offering` is determined by the provider. The new `Id` is an alias to the primary `Id`. If the alias is a pointer to another offering, it is reassigned to the given offering `Id`.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of an `Offering`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is in use as a primary `Id`
	NOT_FOUND		`offeringId` not found
	NULL_ARGUMENT		`offeringId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.