OSID - osid.subscription.MySubscriptionAdminSession Service Interface Definition

Interface	osid.subscription.MySubscriptionAdminSession
Implements	`osid.OsidSession`
Used By	`osid.subscription.SubscriptionManager`
Used By	`osid.subscription.SubscriptionProxyManager`
Description	This session creates and removes subscriptions foe the authenticated `Agent` . The data for create and update is provided by the consumer via the form object.
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	canSubscribe
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	canSubscribeWithRecordTypes
Description	Tests if this user can create a single `Subscription` using the desired record types. While `SubscriptionManager.getSubscriptionRecordTypes()` can be used to examine which records 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
Parameters	`osid.type.Type[]`	`subscriptionRecordTypes`	array of subscription record types
Return	`osid.subscription.SubscriptionForm`		the subscription form
Errors	NOT_FOUND		`dispatchId` is not found
	NULL_ARGUMENT		`dispatchId` or `subscriptionRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested recod types
Compliance	`mandatory`		This method must be implemented.
Method	subscribe
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		`subscriptionForm` 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	canUpdateMySubscriptions
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 for this user
	NULL_ARGUMENT		`subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateMySubscription
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	canUnsubscribe
Description	Tests if this user can delete their own 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	unsubscribe
Description	Deletes an `Subscription` .
Parameters	`osid.id.Id`	`subscriptionId`	the `Id` of the `Subscription` to remove
Errors	NOT_FOUND		`subscriber` not subscribed `to subscriptionId`
	NULL_ARGUMENT		`subscriptionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.