Interface DemographicEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface DemographicEnablerRuleApplicationSession
extends OsidSession

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 .

Method Summary

Modifier and Type	Method	Description
void	assignDemographicEnablerToDemographic(Id demographicEnablerId, Id demographicId)	Adds an existing DemographicEnabler to a Demographic .
boolean	canAssignDemographicEnablers()	Tests if this user can alter demographic enabler/demographic mappings.
Bin	getBin()	Gets the Bin associated with this session.
Id	getBinId()	Gets the Bin Id associated with this session.
void	unassignDemographicEnablerFromDemographic(Id demographicEnablerId, Id demographicId)	Removes a DemographicEnabler from a Demographic .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getBinId

Id getBinId()

Gets the Bin Id associated with this session.

Returns:

the Bin Id associated with this session

Compliance:

mandatory - This method must be implemented.

getBin

Bin getBin()
    throws OperationFailedException,
PermissionDeniedException

Gets the Bin associated with this session.

Returns:

the bin

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignDemographicEnablers

boolean canAssignDemographicEnablers()

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.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

assignDemographicEnablerToDemographic

void assignDemographicEnablerToDemographic(Id demographicEnablerId,
 Id demographicId)
                                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing DemographicEnabler to a Demographic .

Parameters:

demographicEnablerId - the Id of the DemographicEnabler

demographicId - the Id of the Demographic

Throws:

AlreadyExistsException - demographicEnablerId is already assigned to demographicId

NotFoundException - demographicEnablerId or demographicId not found

NullArgumentException - demographicEnablerId or demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignDemographicEnablerFromDemographic

void unassignDemographicEnablerFromDemographic(Id demographicEnablerId,
 Id demographicId)
                                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a DemographicEnabler from a Demographic .

Parameters:

demographicEnablerId - the Id of the DemographicEnabler

demographicId - the Id of the Demographic

Throws:

NotFoundException - demographicEnablerId or demographicId not found or not mapped

NullArgumentException - demographicEnablerId or demographicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.