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

This session provides methods to apply DemographicEnablers to Demographics. A Demographic with multiple DemographicEnablers means any positive rule evaluation across the enablers result in an effective Demographic.

MethodgetBinId
Description

Gets the Bin Id associated with this session.

Returnosid.id.Id the Bin Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetBin
Description

Gets the Bin associated with this session.

Returnosid.resource.Bin the bin
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanAssignDemographicEnablers
Description

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

Adds an existing DemographicEnabler to a Demographic.

Parametersosid.id.IddemographicEnablerId the Id of the DemographicEnabler
osid.id.IddemographicId the Id of the Demographic
ErrorsALREADY_EXISTS demographicEnablerId is already assigned to demographicId
NOT_FOUND demographicEnablerId or demographicId not found
NULL_ARGUMENT demographicEnablerId or demographicId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignDemographicEnablerFromDemographic
Description

Removes a DemographicEnabler from a Demographic.

Parametersosid.id.IddemographicEnablerId the Id of the DemographicEnabler
osid.id.IddemographicId the Id of the Demographic
ErrorsNOT_FOUND demographicEnablerId or demographicId not found or not mapped
NULL_ARGUMENT demographicEnablerId or demographicId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.