OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Bins. 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 Bin, a BinForm is requested using getBinFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned BinForm 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 BinForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each BinForm corresponds to an attempted transaction.

For updates, BinForms are requested to the Bin Id that is to be updated using getBinFormForUpdate(). Similarly, the BinForm has metadata about the data that can be updated and it can perform validation before submitting the update. The BinForm can only be used once for a successful update and cannot be reused.

The delete operations delete Bins.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodcanCreateBins
Description

Tests if this user can create Bins. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Bin 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 Bin creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateBinWithRecordTypes
Description

Tests if this user can create a single Bin using the desired record types. While ResourceManager.getBinRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Bin. Providing an empty array tests if a Bin can be created with no records.

Parametersosid.type.Type[]binRecordTypesarray of bin record types
Returnboolean true if Bin creation using the specified Types is supported, false otherwise
ErrorsNULL_ARGUMENT binRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetBinFormForCreate
Description

Gets the bin form for creating new bins.

Parametersosid.type.Type[]binRecordTypesarray of bin record types
Returnosid.resource.BinFormthe bin form
ErrorsNULL_ARGUMENT binRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form with requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateBin
Description

Creates a new Bin.

Parametersosid.resource.BinFormbinFormthe form for this Bin
Returnosid.resource.Binthe new Bin
ErrorsILLEGAL_STATE binForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT binForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED binForm did not originate from getBinFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateBins
Description

Tests if this user can update Bins. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Bin 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 Bin modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetBinFormForUpdate
Description

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

Parametersosid.id.IdbinIdthe Id of the Bin
Returnosid.resource.BinFormthe bin form
ErrorsNOT_FOUND binId is not found
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBin
Description

Updates an existing bin.

Parametersosid.resource.BinFormbinFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE binForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT binId or binForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED binForm did not originate from getBinFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteBins
Description

Tests if this user can delete Bins. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Bin 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 Bin deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteBin
Description

Deletes a Bin.

Parametersosid.id.IdbinIdthe Id of the Bin to remove
ErrorsNOT_FOUND binId not found
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageBinAliases
Description

Tests if this user can manage Id aliases for Bins. 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 Bin aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasBin
Description

Adds an Id to a Bin for the purpose of creating compatibility. The primary Id of the Bin is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another bin, it is reassigned to the given bin Id.

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