OSID Logo
OSID Specifications
resource demographic package
Version 3.1.0
Interfaceosid.resource.demographic.DemographicEnablerBinAssignmentSession
Implementsosid.OsidSession
Used Byosid.resource.demographic.ResourceDemographicManager
osid.resource.demographic.ResourceDemographicProxyManager
Description

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

Adding a reference of a DemographicEnabler to another Bin is not a copy operation (eg: does not change its Id).

MethodcanAssignDemographicEnablers
Description

Tests if this user can alter demographic enabler/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.
MethodcanAssignDemographicEnablersToBin
Description

Tests if this user can alter demographic enabler/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 demographic enabler 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.
MethodgetAssignableBinIdsForDemographicEnabler
Description

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

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

Adds an existing DemographicEnabler to an Bin.

Parametersosid.id.IddemographicEnablerId the Id of the DemographicEnabler
osid.id.IdbinId the Id of the Bin
ErrorsNOT_FOUND demographicEnablerId or binId not found
NULL_ARGUMENT demographicEnablerId or binId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDemographicEnablerFromBin
Description

Removes a DemographicEnabler from an Bin.

Parametersosid.id.IddemographicEnablerId the Id of the DemographicEnabler
osid.id.IdbinId the Id of the Bin
ErrorsNOT_FOUND demographicEnablerId or binId not found
NULL_ARGUMENT demographicEnablerId or binId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignDemographicEnablerToBin
Description

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

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