OSID Logo
OSID Specifications
subscription package
Version 3.0.0
Release Candidate Preview
Interfaceosid.subscription.PublisherAdminSession
Implementsosid.OsidSession
Description

This session creates and removes publishers. The data for create and update is provided by the consumer via the form object.

MethodcanCreatePublishers
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.

Returnboolean false if Publisher creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreatePublisherWithRecordTypes
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.

Parametersosid.type.Type[]publisherRecordTypesarray of publisher record types
Returnboolean true if Publisher creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT publisherRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetPublisherFormForCreate
Description

Gets the publisher form for creating new publishers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]publisherRecordTypesarray of publisher record types
Returnosid.subscription.PublisherFormthe publisher form
ErrorsNULL_ARGUMENT publisherRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get foem for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreatePublisher
Description

Creates a new Publisher.

Parametersosid.subscription.PublisherFormpublisherFormthe form for this Publisher
Returnosid.subscription.Publisherthe new Publisher
ErrorsILLEGAL_STATE publisherForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT publisherForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED publisherForm did not originate from getPublisherFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdatePublishers
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.

Returnboolean false if Publisher modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetPublisherFormForUpdate
Description

Gets the publisher form for updating an existing publisher. A new publisher form should be requested for each update transaction.

Parametersosid.id.IdpublisherIdthe Id of the Publisher
Returnosid.subscription.PublisherFormthe publisher form
ErrorsNOT_FOUND publisherId is not found
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdatePublisher
Description

Updates an existing publisher.

Parametersosid.subscription.PublisherFormpublisherFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE publisherForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT publisherForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED publisherForm did not originate from getPublisherFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeletePublishers
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.

Returnboolean false if Publisher deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeletePublisher
Description

Deletes a Publisher.

Parametersosid.id.IdpublisherIdthe Id of the Publisher to remove
ErrorsNOT_FOUND publisherId not found
NULL_ARGUMENT publisherId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManagePublisherAliases
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.

Returnboolean false if Publisher aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasPublisher
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.

Parametersosid.id.IdpublisherIdthe Id of a Publisher
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND publisherId not found
NULL_ARGUMENT publisherId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.