OSID Logo
OSID Specifications
resource package
Version 3.1.0
Interfaceosid.resource.ResourceRelationshipBinAssignmentSession
Implementsosid.OsidSession
Used Byosid.resource.ResourceManager
osid.resource.ResourceProxyManager
Description

This session provides methods to re-assign ResourceRelationships to Bins. A ResourceRelationship may map to multiple Bin objects and removing the last reference to a ResourceRelationship is the equivalent of deleting it. Each Bin may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of a ResourceRelationship to another Bin is not a copy operation (eg: does not change its Id).

MethodcanAssignResourceRelationships
Description

Tests if this user can alter resource relationship/bin mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignResourceRelationshipsToBin
Description

Tests if this user can alter resource relationship/bin mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdbinId the Id of the Bin
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT binId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableBinIds
Description

Gets a list of bins including and under the given bin node in which any resource relationship can be assigned.

Parametersosid.id.IdbinId the Id of the Bin
Returnosid.id.IdList list of assignable bin Ids
ErrorsNULL_ARGUMENT binId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableBinIdsForResourceRelationship
Description

Gets a list of bins including and under the given bin node in which a specific resource relationship can be assigned.

Parametersosid.id.IdbinId the Id of the Bin
osid.id.IdresourceRelationshipId the Id of the ResourceRelationship
Returnosid.id.IdList list of assignable bin Ids
ErrorsNULL_ARGUMENT binId or resourceRelationshipId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignResourceRelationshipToBin
Description

Adds an existing ResourceRelationship to a Bin.

Parametersosid.id.IdresourceRelationshipId the Id of the ResourceRelationship
osid.id.IdbinId the Id of the Bin
ErrorsALREADY_EXISTS resourceRelationshipId is already assigned to binId
NOT_FOUND resourceRelationshipId or binId not found
NULL_ARGUMENT resourceRelationshipId or binId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignResourceRelationshipFromBin
Description

Removes a ResourceRelationship from a Bin.

Parametersosid.id.IdresourceRelationshipId the Id of the ResourceRelationship
osid.id.IdbinId the Id of the Bin
ErrorsNOT_FOUND resourceRelationshipId or binId not found or resourceRelationshipId not assigned to binId
NULL_ARGUMENT resourceRelationshipId or binId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignResourceRelationshipToBin
Description

Moves a ResourceRelationship from one Bin to another. Mappings to other Bins are unaffected.

Parametersosid.id.IdresourceRelationshipId the Id of the ResourceRelationship
osid.id.IdfromBinId the Id of the current Bin
osid.id.IdtoBinId the Id of the destination Bin
ErrorsALREADY_EXISTS resourceRelationshipId already assigned to toBinId
NOT_FOUND resourceRelationshipId, fromBinId, or toBinId not found or resourceRelationshipId not mapped to fromBinId
NULL_ARGUMENT resourceRelationshipId, fromBinId, or toBinId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.