Interface CatalogEnablerRuleApplicationSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface CatalogEnablerRuleApplicationSession
extends OsidSession

This session provides methods to apply CatalogEnablers to Catalogs . A Catalog with multiple CatalogEnablers means any positive rule evaluation across the enablers result in an enabled Catalog .

Method Summary

Modifier and Type	Method	Description
void	assignCatalogEnablerToCatalog(Id catalogEnablerId, Id catalogId)	Adds an existing CatalogEnabler to a Catalog .
boolean	canAssignCatalogEnablers()	Tests if this user can alter catalog enabler/catalog mappings.
boolean	canSequenceCatalogEnablers()	Tests if this user can order CatalogEnablers .
Catalog	getCatalog()	Gets the Catalog associated with this session.
Id	getCatalogId()	Gets the Catalog Id associated with this session.
void	moveCatalogEnablerAhead(Id catalogEnablerId, Id catalogId, Id referenceId)	Reorders catalog enablers for a catalog by moving the specified catalog enabler in front of a reference catalog enabler.
void	moveCatalogEnablerBehind(Id catalogEnablerId, Id catalogId, Id referenceId)	Reorders catalog enablers for a catalog by moving the specified catalog enabler behind a reference catalog enabler.
void	orderCatalogEnablers(Id[] catalogEnablerId, Id catalogId)	Reorders a set of catalog enablers for a catalog.
void	unassignCatalogEnablerFromCatalog(Id catalogEnablerId, Id catalogId)	Removes a CatalogEnabler from a Catalog .

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

getCatalogId

Id getCatalogId()

Gets the Catalog Id associated with this session.

Returns:

the Catalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCatalog

Catalog getCatalog()
            throws OperationFailedException,
PermissionDeniedException

Gets the Catalog associated with this session.

Returns:

the catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canAssignCatalogEnablers

boolean canAssignCatalogEnablers()

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

assignCatalogEnablerToCatalog

void assignCatalogEnablerToCatalog(Id catalogEnablerId,
 Id catalogId)
                            throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Adds an existing CatalogEnabler to a Catalog .

Parameters:

catalogEnablerId - the Id of the CatalogEnabler

catalogId - the Id of the Catalog

Throws:

AlreadyExistsException - catalogEnablerId is already applied to catalogId

NotFoundException - catalogEnablerId or catalogId not found

NullArgumentException - catalogEnablerId or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCatalogEnablerFromCatalog

void unassignCatalogEnablerFromCatalog(Id catalogEnablerId,
 Id catalogId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Removes a CatalogEnabler from a Catalog .

Parameters:

catalogEnablerId - the Id of the CatalogEnabler

catalogId - the Id of the Catalog

Throws:

NotFoundException - catalogEnablerId or catalogId not found or catalogEnablerId is not applied to catalogId

NullArgumentException - catalogEnablerId or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSequenceCatalogEnablers

boolean canSequenceCatalogEnablers()

Tests if this user can order CatalogEnablers . A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returns:

false if CatalogEnabler ordering is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

moveCatalogEnablerAhead

void moveCatalogEnablerAhead(Id catalogEnablerId,
 Id catalogId,
 Id referenceId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders catalog enablers for a catalog by moving the specified catalog enabler in front of a reference catalog enabler.

Parameters:

catalogEnablerId - the Id of a CatalogEnabler

catalogId - the Id of a Catalog

referenceId - the reference catalog enabler Id

Throws:

NotFoundException - catalogEnablerId, catalogId , or referenceId not found or, catalogEnablerId or referenceId not related to catalogId

NullArgumentException - catalogEnablerId, catalogId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

moveCatalogEnablerBehind

void moveCatalogEnablerBehind(Id catalogEnablerId,
 Id catalogId,
 Id referenceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders catalog enablers for a catalog by moving the specified catalog enabler behind a reference catalog enabler.

Parameters:

catalogEnablerId - the Id of a CatalogEnabler

catalogId - the Id of a Catalog

referenceId - the reference catalog enabler Id

Throws:

NotFoundException - catalogEnablerId, catalogId , or referenceId not found or, catalogEnablerId or referenceId not related to catalogId

NullArgumentException - catalogEnablerId, catalogId or referenceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

orderCatalogEnablers

void orderCatalogEnablers(Id[] catalogEnablerId,
 Id catalogId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Reorders a set of catalog enablers for a catalog.

Parameters:

catalogEnablerId - the Ids for a set of CatalogEnablers

catalogId - the Id of a Catalog

Throws:

NotFoundException - catalogId not found or, a catalogEnablerId not related to catalogId

NullArgumentException - catalogEnablerIds or catalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.