OSID - osid.subscription.SubscriptionAdminSession Service Interface Definition

Interface	osid.subscription.SubscriptionAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Subscriptions.` The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Subscription,` a `SubscriptionForm` is requested using `getSubscriptionFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `SubscriptionForm` 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 `SubscriptionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SubscriptionForm` corresponds to an attempted transaction. For updates, `SubscriptionForms` are requested to the `Subscription` `Id` that is to be updated using `getSubscriptionFormForUpdate().` Similarly, the `SubscriptionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SubscriptionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Subscriptions.` To unmap a `Subscription` from the current `Publisher,` the `SubscriptionPublisherAssignmentSession` should be used. These delete operations attempt to remove the `Subscription` itself thus removing it from all known `Publisher` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getPublisherId
Description	Gets the `Publisher` `Id` associated with this session.
Return	`osid.id.Id`		the `Publisher Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getPublisher
Description	Gets the `Publisher` associated with this session.
Return	`osid.subscription.Publisher`		the publisher
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSubscriptions
Description	Tests if this user can create hournal entries. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Subscription` 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 `Subscription` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSubscriptionWithRecordTypes
Description	Tests if this user can create a single `Subscription` using the desired record interface types. While `SubscriptionManager.getSubscriptionRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Subscription.` Providing an empty array tests if a `Subscription` can be created with no records.
Parameters	`osid.type.Type[]`	`subscriptionRecordTypes`	array of subscription record types
Return	`boolean`		`true` if `Subscription` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`subscriptionRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionFormForCreate
Description	Gets the subscription form for creating new entries. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`dispatchId`	the `Id` for the dispatch
	`osid.id.Id`	`resourceId`	the `Id` for the resource
	`osid.type.Type[]`	`subscriptionRecordTypes`	array of subscription record types
Return	`osid.subscription.SubscriptionForm`		the subscription form
Errors	NOT_FOUND		`dispatchId` or `resourceId` is not found
	NULL_ARGUMENT		`dispatchId, resourceId,` or `subscriptionRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get from for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createSubscription
Description	Creates a new `Subscription.`
Parameters	`osid.subscription.SubscriptionForm`	`subscriptionForm`	the form for this `Subscription`
Return	`osid.subscription.Subscription`		the new `Subscription`
Errors	ILLEGAL_STATE		`subscriptionForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subscriptionForm` did not originate from `getSubscriptionFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSubscriptions
Description	Tests if this user can update subscriptions. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Subscription` 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 `Subscription` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSubscriptionFormForUpdate
Description	Gets the subscription form for updating an existing subscription. A new subscription form should be requested for each update transaction.
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription`
Return	`osid.subscription.SubscriptionForm`		the subscription form
Errors	NOT_FOUND		`subscriptionId` is not found
	NULL_ARGUMENT		`subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSubscription
Description	Updates an existing subscription.
Parameters	`osid.subscription.SubscriptionForm`	`subscriptionForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`subscriptionForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`subscriptionId` or `subscriptionForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`subscriptionForm` did not originate from `getSubscriptionFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSubscriptions
Description	Tests if this user can delete subscriptions. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Subscription` 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 `Subscription` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSubscription
Description	Deletes an `Subscription.`
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription` to remove
Errors	NOT_FOUND		`subscriptionId` not found
	NULL_ARGUMENT		`subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSubscriptionAliases
Description	Tests if this user can manage `Id` aliases for `Comnents.` 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 `Subscription` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSubscription
Description	Adds an `Id` to a `Subscription` for the purpose of creating compatibility. The primary `Id` of the `Subscription` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another subscription, it is reassigned to the given subscription `Id.`
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of a `Subscription`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`subscriptionId` not found
	NULL_ARGUMENT		`subscriptionId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.