OSID - osid.subscription.PublisherAdminSession Service Interface Definition

Interface	osid.subscription.PublisherAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes publishers. The data for create and update is provided by the consumer via the form object.
Method	canCreatePublishers
Description	Tests if this user can create `Publishers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Publisher` 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 `Publisher` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreatePublisherWithRecordTypes
Description	Tests if this user can create a single `Publisher` using the desired record interface types. While `SubscriptionManager.getPublisherRecordTypes()` can be used to examine which record interfaces are supported, this method tests which record(s) are required for creating a specific `Publisher.` Providing an empty array tests if a `Publisher` can be created with no records.
Parameters	`osid.type.Type[]`	`publisherRecordTypes`	array of publisher record types
Return	`boolean`		`true` if `Publisher` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`publisherRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherFormForCreate
Description	Gets the publisher form for creating new publishers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`publisherRecordTypes`	array of publisher record types
Return	`osid.subscription.PublisherForm`		the publisher form
Errors	NULL_ARGUMENT		`publisherRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get foem for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createPublisher
Description	Creates a new `Publisher.`
Parameters	`osid.subscription.PublisherForm`	`publisherForm`	the form for this `Publisher`
Return	`osid.subscription.Publisher`		the new `Publisher`
Errors	ILLEGAL_STATE		`publisherForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`publisherForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`publisherForm` did not originate from `getPublisherFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdatePublishers
Description	Tests if this user can update `Publishers.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Publisher` 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 `Publisher` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPublisherFormForUpdate
Description	Gets the publisher form for updating an existing publisher. A new publisher form should be requested for each update transaction.
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher`
Return	`osid.subscription.PublisherForm`		the publisher form
Errors	NOT_FOUND		`publisherId` is not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updatePublisher
Description	Updates an existing publisher.
Parameters	`osid.subscription.PublisherForm`	`publisherForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`publisherForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`publisherForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`publisherForm` did not originate from `getPublisherFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeletePublishers
Description	Tests if this user can delete `Publishers` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Publisher` 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 `Publisher` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deletePublisher
Description	Deletes a `Publisher.`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of the `Publisher` to remove
Errors	NOT_FOUND		`publisherId` not found
	NULL_ARGUMENT		`publisherId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManagePublisherAliases
Description	Tests if this user can manage `Id` aliases for `Publishers.` 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 `Publisher` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasPublisher
Description	Adds an `Id` to a `Publisher` for the purpose of creating compatibility. The primary `Id` of the `Publisher` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another publisher, it is reassigned to the given publisher `Id.`
Parameters	`osid.id.Id`	`publisherId`	the `Id` of a `Publisher`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`publisherId` not found
	NULL_ARGUMENT		`publisherId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.